The Gatsby CLI tool lets you install starters, which are boilerplate Gatsby sites maintained by the community and intended for jump-starting development quickly.
gatsby new command to clone a boilerplate starter, install its dependencies, and clear Git history.
When creating a new Gatsby site, you can optionally specify a starter to base your new site on; they can come from any publicly available Git repo, such as GitHub, GitLab, or Bitbucket. You can supply the
gatsby new [SITE_DIRECTORY] [URL_OF_STARTER_GIT_REPO]
For example, to create a site in a
blog directory with Gatsby Starter Blog from its GitHub URL:
gatsby new blog https://github.com/gatsbyjs/gatsby-starter-blog
This downloads the files and initializes the site by running
Alternatively, you can also supply a GitHub user name and repository:
gatsby new [SITE_DIRECTORY] [GITHUB_USER_NAME/REPO]
Here is an example with the
gatsby new blog gatsbyjs/gatsby-starter-blog
This also downloads the files and initializes the site by running
If you don’t specify a custom starter, your site will be created from the default starter.
Note: If you work for an Enterprise-level company where you are unable to pull from public GitHub repositories, you can still set up Gatsby. Check out the docs to learn more.
Another option is to supply a path (relative or absolute) to a local folder containing a starter:
gatsby new [SITE_DIRECTORY] [LOCAL_PATH_TO_STARTER]
Here is an example assuming a starter exists on the path
gatsby new blog Code/my-local-starter
Official starters are maintained by Gatsby.
|gatsby-starter-default||Demo||Appropriate for most use cases||General Gatsby site|
|gatsby-starter-blog||Demo||Create a basic blog||Blog post pages and listings|
|gatsby-starter-hello-world||Demo||Learn Gatsby||Gatsby bare essentials|
Learn how to make a starter in the Gatsby docs. Starters can be created for your team(s) only or distributed to the broader community. It’s up to you!
Community starters are created and maintained by Gatsby community members.
- Looking for a starter for a particular use case? Browse starters that have been submitted to the Starter Library.
- Created a starter you’d like to share? Follow these steps to submit your starter to the Starter Library.
Edit this page on GitHub