create-gatsby

create-gatsby

Create Gatsby apps in an interactive CLI experience that does the plumbing for you.

Quick Overview

Create a new Gatsby app by running the following command:

npm init gatsby

or

yarn create gatsby

It will ask you questions about what you're building, and set up a Gatsby project for you.

Note: This package is different from gatsby-cli, it is intended solely to create new sites.

Options

If you'd like to set up a minimal site without answering any prompts you can run the following command, including your chosen site directory.

npm init gatsby -y <site-directory>

Working on create-gatsby locally?

If you're making changes to the create-gatsby package, you can follow the steps below to test out your changes locally:

# Move into the monorepo
cd <path-to-gatsby-monorepo>

# Install dependencies and build the package
yarn bootstrap

# Run the create-gatsby script
node packages/create-gatsby/cli.js

Note that if you use the bootstrap script, you'll have to rebuild after each change. Alternatively, you can use the watch script to automatically rebuild after local changes:

# Move into the monorepo
cd <path-to-gatsby-monorepo>

# Install dependencies and build the package
yarn bootstrap

# Watch changes
yarn watch --scope=create-gatsby

Open another terminal window and go to a folder where you can easily delete the test projects:

cd <path-to-playground>

# Run the create-gatsby script
node <some-path>/packages/create-gatsby/cli.js