# create-gatsby

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

Latest version **3.16.0** (published 2026-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-gatsby
pnpm add create-gatsby
yarn add create-gatsby
bun add create-gatsby
```

Provides the command `create-gatsby`.

## Health

**Score 60/100 (C)** — status: stable.

Positive: no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 3.16.0 |
| Published | 2026-01-26 |
| First published | 2020-10-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 229.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 55939 |
| Author | Matt Kane |
| Maintainers | pieh, kathmbeck, serhalp-netlify, mlgualtieri-gatsby, wardpeet |

## Links

- npm: https://www.npmjs.com/package/create-gatsby
- Repository: https://github.com/gatsbyjs/gatsby
- Homepage: https://github.com/gatsbyjs/gatsby/tree/master/packages/create-gatsby#readme
- Issues: https://github.com/gatsbyjs/gatsby/issues
- npm.io page: https://npm.io/package/create-gatsby

## Dependencies (1)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.20.13

## Recent versions

- 3.16.0 (latest) — 2026-01-26
- 3.17.0-next.0 (next) — 2025-11-27
- 3.17.0-react19.1 (react19) — 2025-11-26
- 3.13.0-alpha-alt-image-cdn.44 (alt-image-cdn) — 2023-11-03
- 3.9.0-alpha-cg-tailwind.23 (alpha-cg-tailwind) — 2023-05-09
- 3.9.0-image-cdn-configurable.4 (image-cdn-configurable) — 2023-04-11
- 1.15.0 (latest-v3) — 2022-12-07
- 2.25.0 (latest-v4) — 2022-12-07
- 3.0.0-alpha-drupal-proxyurl.14 (drupal-proxyurl) — 2022-11-22
- 2.24.1-alpha-wordpress-image-err.27 (wordpress-image-err) — 2022-11-09
- 2.14.0-alpha-transformer-json.26 (alpha-transformer-json) — 2022-10-12
- 3.0.0-alpha-v5.d20221012t101120.57 (alpha-v5) — 2022-10-12
- 2.25.0-alpha-image-cdn-pathprefix.48 (image-cdn-pathprefix) — 2022-10-07
- 2.23.0-alpha-image-cdn-enc.40 (image-cdn-enc) — 2022-09-16
- 2.23.0-alpha-a5-peer.70 (alpha-a5-peer) — 2022-09-14
- … 343 more at https://npm.io/package/create-gatsby/versions

## README

# 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:

```shell
npm init gatsby
```

or

```shell
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:

```sh
# 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:

```sh
# 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
```

---
_Source: https://npm.io/package/create-gatsby · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._