Run npx create-stackbit-app
in your terminal to create a new Stackbit application or add Stackbit into an existing site.
Usage
To create a new Stackbit project from a starter, run the following command:
npx create-stackbit-app [dir]
To see a full list of options use the --help
flag:
> npx create-stackbit-app --help
Options:
--version Show version number [boolean]
-s, --starter Choose a starter [choices: "nextjs", "ts-nextjs", "contentful"]
-e, --example Start from an example
[choices: "algolia-search", "dynamic-app", "sb-countdown", "sb-typist", "tutor
ial-contentful"]
--help Show help [boolean]
Setting Project Directory
Pass a directory name as the only argument when running the command. For example, if you wanted your directory to be name my-site
, the command would look something like this:
npx create-stackbit-app my-site
If no name is provided, the directory will be my-stackbit-site
for starters or will match the name of the example if starting from an example. If the directory already exists, a timestamp value will be appended to the directory name to ensure uniqueness.
Options
starter
Use the --starter
option for specifying a starter. Run the command with the --help
flag to see a full list of available starters.
npx create-stackbit-app --starter ts-nextjs
If no starter option is provided, the default starter is used.
example
[experimental]
Use the --example
option to start a project from an example. Run the command with the --help
flag to see a full list of available starters.
npx create-stackbit-app --example algolia-search
This will create a new project matching the name of the example, unless overridden (see below). See here for a full list of starters.
Note: This is an experimental feature. Please report issues.
Adding Stackbit to Existing Projects
The script detects when you may be working with an existing project (it looks for a package.json
file in the working directory).
If in an existing project, the script asks if you'd like to add Stackbit to the project. Today, this only prints a resource URL. If you choose no, the command exits.