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

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

Current Tags

2.23.0-alpha-9689ff.25 ... alpha-9689ff (2 years ago)
2.23.0-alpha-a5-peer.70 ... alpha-a5-peer (2 years ago)
3.9.0-alpha-cg-tailwind.23 ... alpha-cg-tailwind (2 years ago)
2.18.0-alpha-mdx-v2.68 ... alpha-mdx-v2 (2 years ago)
1.14.0-alpha-qe-sm.46 ... alpha-qe-sm (3 years ago)
2.5.0-alpha-trailing-slash.71 ... alpha-trailing-slash (3 years ago)
2.14.0-alpha-transformer-json.26 ... alpha-transformer-json (2 years ago)
2.6.0-alpha-ts-jit.26 ... alpha-ts-jit (3 years ago)
3.0.0-alpha-v5.d20221012t101120.57 ... alpha-v5 (2 years ago)
3.13.0-alpha-alt-image-cdn.44 ... alt-image-cdn (a year ago)
0.2.0-create-gatsby.2 ... create-gatsby (4 years ago)
2.17.0-alpha-drupal-image-404.12 ... drupal-image-404 (2 years ago)
3.0.0-alpha-drupal-proxyurl.14 ... drupal-proxyurl (2 years ago)
2.18.0-alpha-drupal-self-reference.18 ... drupal-self-reference (2 years ago)
2.9.0-alpha-image-cdn.39 ... image-cdn (3 years ago)
2.16.0-alpha-image-cdn-caching.9 ... image-cdn-caching (2 years ago)
3.9.0-image-cdn-configurable.4 ... image-cdn-configurable (2 years ago)
2.23.0-alpha-image-cdn-enc.40 ... image-cdn-enc (2 years ago)
2.18.0-alpha-image-cdn-jobs-resolve.32 ... image-cdn-jobs-resolve (2 years ago)
2.25.0-alpha-image-cdn-pathprefix.48 ... image-cdn-pathprefix (2 years ago)
2.13.0-alpha-image-cdn-telemetry.29 ... image-cdn-telemetry (3 years ago)
0.0.0-image-helpers.13 ... image-helpers (4 years ago)
2.8.0-alpha-image-service.26 ... image-service (3 years ago)
3.13.1 ... latest (10 months ago)
1.15.0 ... latest-v3 (2 years ago)
2.25.0 ... latest-v4 (2 years ago)
2.11.0-alpha-luda.30 ... luda (3 years ago)
2.20.0-mdxv4-rc.65 ... mdxv4-rc (2 years ago)
3.14.0-next.2 ... next (10 months ago)
2.23.0-alpha-preview-gh-api.26 ... preview-gh-api (2 years ago)
1.0.0-reach-router.13 ... reach-router (4 years ago)
1.0.0-v3rc.2 ... v3rc (4 years ago)
2.24.1-alpha-wordpress-image-err.27 ... wordpress-image-err (2 years ago)
2.15.0-alpha-wp-image-cdn-auth.46 ... wp-image-cdn-auth (2 years ago)

350 Versions

3.13.1 ... 10 months ago
3.14.0-next.2 ... 10 months ago
3.14.0-next.1 ... 10 months ago
3.13.0 ... a year ago
3.14.0-next.0 ... a year ago
3.13.0-next.1 ... a year ago
3.13.0-alpha-alt-image-cdn.44 ... a year ago
3.12.3 ... a year ago
3.12.2 ... a year ago
3.12.1 ... a year ago
3.12.0 ... a year ago
3.13.0-next.0 ... a year ago
3.12.0-next.1 ... a year ago
3.11.0 ... a year ago
3.12.0-next.0 ... a year ago
3.11.0-next.1 ... a year ago
3.10.0 ... a year ago
3.11.0-next.0 ... a year ago
3.9.0-alpha-cg-tailwind.23 ... 2 years ago
3.10.0-next.2 ... 2 years ago
3.10.0-next.1 ... 2 years ago
3.9.0 ... 2 years ago
3.10.0-next.0 ... 2 years ago
3.9.0-image-cdn-configurable.4 ... 2 years ago
3.9.0-next.2 ... 2 years ago
3.9.0-next.1 ... 2 years ago
3.8.0 ... 2 years ago
3.9.0-next.0 ... 2 years ago
3.7.0 ... 2 years ago
3.8.0-next.0 ... 2 years ago
3.6.0 ... 2 years ago
3.7.0-next.0 ... 2 years ago
3.6.0-next.1 ... 2 years ago
3.5.0 ... 2 years ago
3.6.0-next.0 ... 2 years ago
3.5.0-next.1 ... 2 years ago
3.4.0 ... 2 years ago
3.5.0-next.0 ... 2 years ago
3.4.0-next.2 ... 2 years ago
3.3.1 ... 2 years ago
3.4.0-next.1 ... 2 years ago
3.3.0 ... 2 years ago
3.4.0-next.0 ... 2 years ago
1.15.0 ... 2 years ago
2.25.0 ... 2 years ago
3.3.0-next.3 ... 2 years ago
3.3.0-next.2 ... 2 years ago
3.3.0-next.1 ... 2 years ago
3.2.0 ... 2 years ago
3.3.0-next.0 ... 2 years ago
3.0.0-alpha-drupal-proxyurl.14 ... 2 years ago
3.1.0 ... 2 years ago
3.2.0-next.0 ... 2 years ago
2.24.1-alpha-wordpress-image-err.27 ... 2 years ago
2.24.1-alpha-wordpress-image-err.26 ... 2 years ago
2.24.1-alpha-wordpress-image-err.25 ... 2 years ago
3.0.0 ... 2 years ago
3.1.0-next.0 ... 2 years ago
3.0.0-next.4 ... 2 years ago
3.0.0-next.3 ... 2 years ago
3.0.0-next.2 ... 2 years ago
3.0.0-next.1 ... 2 years ago
2.14.0-alpha-transformer-json.26 ... 2 years ago
3.0.0-next.0 ... 2 years ago
3.0.0-alpha-v5.d20221012t101120.57 ... 2 years ago
3.0.0-alpha-v5.d20221010t183635.51 ... 2 years ago
2.25.0-alpha-image-cdn-pathprefix.48 ... 2 years ago
2.25.0-alpha-image-cdn-pathprefix.47 ... 2 years ago
3.0.0-alpha-v5.d20221007t081809.41 ... 2 years ago
3.0.0-alpha-v5.d20221005t111511.35 ... 2 years ago
3.0.0-alpha-v5.16 ... 2 years ago
2.24.0 ... 2 years ago
2.25.0-next.0 ... 2 years ago
2.23.1 ... 2 years ago
2.24.0-next.2 ... 2 years ago
2.24.0-next.1 ... 2 years ago
2.23.0-alpha-image-cdn-enc.40 ... 2 years ago
2.23.0-alpha-a5-peer.70 ... 2 years ago
3.0.0-alpha-v5.26 ... 2 years ago
2.23.0-alpha-image-cdn-enc.23 ... 2 years ago
2.23.0 ... 2 years ago
2.23.0-alpha-preview-gh-api.26 ... 2 years ago
2.22.1 ... 2 years ago
2.24.0-next.0 ... 2 years ago
2.23.0-alpha-v5.26 ... 2 years ago
2.23.0-alpha-9689ff.25 ... 2 years ago
3.0.0-alpha-v5.25 ... 2 years ago
3.0.0-alpha-v5.24 ... 2 years ago
2.22.0 ... 2 years ago
2.23.0-next.0 ... 2 years ago
2.21.0 ... 2 years ago
2.22.0-next.2 ... 2 years ago
2.22.0-next.1 ... 2 years ago
2.22.0-next.0 ... 2 years ago
2.21.0-next.2 ... 2 years ago
2.21.0-next.1 ... 2 years ago
2.20.0 ... 2 years ago
2.21.0-next.0 ... 2 years ago
2.20.0-mdxv4-rc.65 ... 2 years ago
2.20.0-next.2 ... 2 years ago
2.20.0-mdxv4-rc.60 ... 2 years ago
2.18.0-mdxv4-rc.76 ... 2 years ago
2.20.0-next.1 ... 2 years ago
2.18.0-alpha-drupal-self-reference.18 ... 2 years ago
2.19.0 ... 2 years ago
2.20.0-next.0 ... 2 years ago
2.18.1 ... 2 years ago
2.18.0-mdxv4-rc.68 ... 2 years ago
2.18.0-alpha-image-cdn-jobs-resolve.32 ... 2 years ago
2.18.0 ... 2 years ago
2.19.0-next.2 ... 2 years ago
2.19.0-next.1 ... 2 years ago
2.19.0-next.0 ... 2 years ago
2.18.0-alpha-mdx-v2.68 ... 2 years ago
2.18.0-alpha-mdx-v2.66 ... 2 years ago
2.18.0-alpha-mdx-v2.64 ... 2 years ago
2.18.0-alpha-mdx-v2.63 ... 2 years ago
2.18.0-next.1 ... 2 years ago
2.17.0 ... 2 years ago
2.18.0-next.0 ... 2 years ago
2.17.0-next.1 ... 2 years ago
2.17.0-alpha-drupal-image-404.12 ... 2 years ago
2.16.0 ... 2 years ago
2.17.0-next.0 ... 2 years ago
2.16.0-alpha-image-cdn-caching.9 ... 2 years ago
2.15.1 ... 2 years ago
2.16.0-next.1 ... 2 years ago
2.15.0 ... 2 years ago
2.15.0-alpha-wp-image-cdn-auth.46 ... 2 years ago
2.15.0-alpha-wp-image-cdn-auth.45 ... 2 years ago
2.15.0-alpha-wp-image-cdn-auth.42 ... 2 years ago
2.16.0-next.0 ... 2 years ago
2.11.0-alpha-luda.30 ... 3 years ago
2.15.0-next.2 ... 3 years ago
2.14.0 ... 3 years ago
2.15.0-next.1 ... 3 years ago
2.15.0-next.0 ... 3 years ago
2.14.0-next.3 ... 3 years ago
2.14.0-next.2 ... 3 years ago
2.13.0 ... 3 years ago
2.14.0-next.1 ... 3 years ago
2.14.0-next.0 ... 3 years ago
2.13.0-alpha-image-cdn-telemetry.29 ... 3 years ago
2.12.1 ... 3 years ago
2.12.0 ... 3 years ago
2.13.0-next.0 ... 3 years ago
2.12.0-next.4 ... 3 years ago
2.11.2 ... 3 years ago
2.12.0-next.3 ... 3 years ago
2.12.0-next.2 ... 3 years ago
2.11.1 ... 3 years ago
2.12.0-next.1 ... 3 years ago
2.11.0 ... 3 years ago
2.12.0-next.0 ... 3 years ago
2.11.0-next.3 ... 3 years ago
2.10.2 ... 3 years ago
2.11.0-next.2 ... 3 years ago
2.10.1 ... 3 years ago
2.11.0-next.1 ... 3 years ago
2.10.0 ... 3 years ago
2.11.0-next.0 ... 3 years ago
2.10.0-next.3 ... 3 years ago
2.10.0-next.2 ... 3 years ago
2.10.0-next.1 ... 3 years ago
2.9.0 ... 3 years ago
2.10.0-next.0 ... 3 years ago
2.9.0-alpha-image-cdn.39 ... 3 years ago
2.9.0-alpha-image-cdn.54 ... 3 years ago
2.9.0-next.1 ... 3 years ago
2.9.0-alpha-image-cdn.49 ... 3 years ago
2.9.0-alpha-image-cdn.37 ... 3 years ago
2.9.0-alpha-image-cdn.32 ... 3 years ago
2.9.0-alpha-image-cdn.36 ... 3 years ago
2.8.0 ... 3 years ago
2.9.0-alpha-image-service2.14 ... 3 years ago
2.9.0-next.0 ... 3 years ago
2.8.0-next.2 ... 3 years ago
2.8.0-alpha-image-service.45 ... 3 years ago
2.8.0-alpha-image-service.26 ... 3 years ago
2.8.0-alpha-image-service.25 ... 3 years ago
2.8.0-alpha-image-service.24 ... 3 years ago
2.8.0-alpha-image-service.23 ... 3 years ago
2.8.0-alpha-image-service.20 ... 3 years ago
2.8.0-alpha-image-service.17 ... 3 years ago
2.8.0-alpha-image-service.15 ... 3 years ago
2.8.0-alpha-image-service.19 ... 3 years ago
2.8.0-alpha-image-service.18 ... 3 years ago
2.8.0-alpha-image-service.16 ... 3 years ago
2.7.0 ... 3 years ago
2.8.0-next.1 ... 3 years ago
2.7.0-alpha-image-service.16 ... 3 years ago
2.7.0-alpha-image-service.15 ... 3 years ago
2.7.0-alpha-image-service.13 ... 3 years ago
2.8.0-next.0 ... 3 years ago
2.6.1 ... 3 years ago
2.7.0-next.4 ... 3 years ago
2.7.0-alpha-image-service.14 ... 3 years ago
2.7.0-next.3 ... 3 years ago
2.7.0-next.2 ... 3 years ago
2.7.0-next.1 ... 3 years ago
2.6.0 ... 3 years ago
2.6.0-alpha-ts-jit.26 ... 3 years ago
2.7.0-next.0 ... 3 years ago
2.5.0-alpha-trailing-slash.71 ... 3 years ago
2.6.0-next.3 ... 3 years ago
2.5.1 ... 3 years ago
2.6.0-next.2 ... 3 years ago
2.6.0-next.1 ... 3 years ago
2.5.0 ... 3 years ago
2.6.0-next.0 ... 3 years ago
2.5.0-next.2 ... 3 years ago
2.5.0-next.1 ... 3 years ago
2.4.0 ... 3 years ago
2.5.0-next.0 ... 3 years ago
2.4.0-next.1 ... 3 years ago
2.3.0 ... 3 years ago
2.4.0-next.0 ... 3 years ago
2.3.0-next.1 ... 3 years ago
2.2.0 ... 3 years ago
2.3.0-next.0 ... 3 years ago
2.2.0-next.2 ... 3 years ago
2.1.1 ... 3 years ago
2.2.0-next.1 ... 3 years ago
2.1.0 ... 3 years ago
2.2.0-next.0 ... 3 years ago
2.1.0-next.1 ... 3 years ago
2.0.0 ... 3 years ago
2.1.0-next.0 ... 3 years ago
2.0.0-zz-next.3 ... 3 years ago
2.0.0-zz-next.2 ... 3 years ago
1.14.0 ... 3 years ago
2.0.0-zz-next.1 ... 3 years ago
2.0.0-zz-next.8 ... 3 years ago
2.0.0-next.1 ... 3 years ago
2.0.0-next.0 ... 3 years ago
2.0.0-alpha-9689ff.13 ... 3 years ago
1.14.0-alpha-qe-sm.46 ... 3 years ago
2.0.0-alpha-9689ff.36 ... 3 years ago
2.0.0-alpha-9689ff.35 ... 3 years ago
2.0.0-alpha-9689ff.34 ... 3 years ago
2.0.0-alpha-9689ff.32 ... 3 years ago
2.0.0-alpha-9689ff.24 ... 3 years ago
2.0.0-alpha-9689ff.22 ... 3 years ago
2.0.0-alpha-9689ff.17 ... 3 years ago
2.0.0-alpha-9689ff.8 ... 3 years ago
1.14.0-next.2 ... 3 years ago
1.14.0-next.1 ... 3 years ago
1.11.0-alpha-qe-sm.108 ... 3 years ago
1.13.0 ... 3 years ago
2.0.0-alpha-9689ff.5 ... 3 years ago
1.14.0-next.0 ... 3 years ago
1.11.0-alpha-qe-sm.86 ... 3 years ago
1.11.0-alpha-qe-sm.85 ... 3 years ago
1.11.0-alpha-qe-sm.83 ... 3 years ago
1.13.0-next.1 ... 3 years ago
2.0.0-alpha-9689ff.27 ... 3 years ago
1.12.0 ... 3 years ago
1.13.0-next.0 ... 3 years ago
1.12.0-next.3 ... 3 years ago
1.12.0-next.2 ... 3 years ago
1.12.0-next.1 ... 3 years ago
1.11.0 ... 3 years ago
1.12.0-next.0 ... 3 years ago
1.10.0 ... 3 years ago
1.11.0-next.0 ... 3 years ago
1.10.0-next.1 ... 3 years ago
1.9.0 ... 3 years ago
1.10.0-next.0 ... 3 years ago
1.9.0-next.1 ... 3 years ago
1.8.0 ... 3 years ago
1.9.0-next.0 ... 3 years ago
1.7.1 ... 3 years ago
1.8.0-next.1 ... 3 years ago
1.7.0 ... 3 years ago
1.8.0-next.0 ... 3 years ago
1.7.0-next.2 ... 3 years ago
1.7.0-next.1 ... 3 years ago
1.6.0 ... 3 years ago
1.7.0-next.0 ... 3 years ago
1.5.0 ... 4 years ago
1.6.0-next.0 ... 4 years ago
1.4.0 ... 4 years ago
1.5.0-next.0 ... 4 years ago
1.3.0 ... 4 years ago
1.4.0-next.0 ... 4 years ago
1.3.0-next.1 ... 4 years ago
1.2.0 ... 4 years ago
1.3.0-next.0 ... 4 years ago
1.2.0-next.1 ... 4 years ago
1.1.0 ... 4 years ago
1.2.0-next.0 ... 4 years ago
1.1.0-next.3 ... 4 years ago
1.0.0 ... 4 years ago
1.0.0-v3rc.2 ... 4 years ago
1.1.0-next.2 ... 4 years ago
1.0.0-v3rc.1 ... 4 years ago
1.0.0-v3rc.0 ... 4 years ago
1.1.0-next.1 ... 4 years ago
1.0.0-reach-router.13 [deprecated] ... 4 years ago
1.1.0-next.0 ... 4 years ago
1.0.0-next.2 ... 4 years ago
1.0.0-next.1 ... 4 years ago
1.0.0-next.0 ... 4 years ago
0.5.1 ... 4 years ago
0.6.0-next.1 ... 4 years ago
0.5.0 ... 4 years ago
0.6.0-next.0 ... 4 years ago
0.4.0 ... 4 years ago
0.5.0-next.0 ... 4 years ago
0.4.0-next.1 ... 4 years ago
0.3.0 ... 4 years ago
0.4.0-next.0 ... 4 years ago
0.3.0-next.4 ... 4 years ago
0.3.0-next.3 ... 4 years ago
0.2.1 ... 4 years ago
0.3.0-next.2 ... 4 years ago
0.2.0 ... 4 years ago
0.3.0-next.1 ... 4 years ago
0.3.0-next.0 ... 4 years ago
0.2.0-next.4 ... 4 years ago
0.2.0-next.3 ... 4 years ago
0.2.0-next.2 ... 4 years ago
0.1.0 ... 4 years ago
0.2.0-next.1 ... 4 years ago
0.2.0-create-gatsby.2 ... 4 years ago
0.2.0-next.0 ... 4 years ago
0.0.2 ... 4 years ago
0.1.0-next.2 ... 4 years ago
0.0.0-image-helpers.13 ... 4 years ago
0.1.0-next.1 ... 4 years ago
0.0.1 ... 4 years ago
0.1.0-next.0 ... 4 years ago
0.0.0-next.0 ... 4 years ago
0.0.0-10 ... 4 years ago
0.0.0-9 ... 4 years ago
0.0.0-8 ... 4 years ago
0.0.0-7 ... 4 years ago
0.0.0-create-gatsby.17224 ... 4 years ago
0.0.0-create-gatsby.17223 ... 4 years ago
0.0.0-create-gatsby.17222 ... 4 years ago
0.0.0-create-gatsby.17221 ... 4 years ago
0.0.0-create-gatsby.17220 ... 4 years ago
0.0.0-6 ... 4 years ago
0.0.0-5 ... 4 years ago
0.0.0-4 ... 4 years ago
0.0.0-create-gatsby.17120 ... 4 years ago
0.0.0-create-gatsby.17114 ... 4 years ago
0.0.0-create-gatsby.17113 ... 4 years ago
0.0.0-2 ... 4 years ago
0.0.0-1 ... 4 years ago