Skip to main content

Commands (Gatsby CLI)

gatsby-cli

Gatsby command line tool. This doc exists in READme form in GitHub here.

Let’s you create new Gatsby sites using Gatsby starters.

It also let’s you run commands on sites. The tool runs code from the gatsby package installed locally.

Install

npm install --global gatsby-cli

How to use

Run gatsby --help for full help.

New

gatsby new gatsby-site

See the Gatsby starters docs for more.

Develop

At the root of a Gatsby site run gatsby develop to start the Gatsby development server.

Options

Option Description
-H, --host Set host. Defaults to localhost
-p, --port Set port. Defaults to 8000
-o, --open Open the site in your (default) browser for you
-S, --https Use HTTPS

Follow the Local HTTPS guide to find out how you can set up an HTTPS development server using Gatsby.

Build

At the root of a Gatsby site run gatsby build to do a production build of a site.

Options

Option Description
--prefix-paths Build site with link paths prefixed (set pathPrefix in your config)
--no-uglify Build site without uglifying JS bundles (for debugging)
--open-tracing-config-file Tracer configuration file (open tracing compatible). See https://www.gatsbyjs.org/docs/performance-tracing/

Serve

At the root of a Gatsby site run gatsby serve to serve the production build of the site for testing.

Options

Option Description
-H, --host Set host. Defaults to localhost
-p, --port Set port. Defaults to 8000
-o, --open Open the site in your (default) browser for you
--prefix-paths Serve site with link paths prefixed (if built with pathPrefix in your gatsby-config.js).

Info

At the root of a Gatsby site run gatsby info to get helpful environment information which will be required when reporting a bug.

Options

Option Description
-C, --clipboard Automagically copy environment information to clipboard

Repl

Get a node repl with context of Gatsby environment


Was this helpful? edit this page on GitHub