Skip to content

Commit

Permalink
Add README for gatsby-cli
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleAMathews committed Aug 2, 2017
1 parent d442861 commit a832f5c
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion packages/gatsby-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# gatsby-cli

Stub README
Gatsby command line tool.

Let's you create new Gatsby sites using [Gatsby starters](https://www.gatsbyjs.org/docs/gatsby-starters/)

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](https://www.gatsbyjs.org/docs/gatsby-starters/) for more

### Develop

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

### Build

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

### Serve

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

0 comments on commit a832f5c

Please sign in to comment.