Skip to content

Commit 2097bff

Browse files
0x80KyleAMathews
authored andcommitted
Update the readme for gatsby-dev-cli (#820)
1 parent e7ad98d commit 2097bff

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

packages/gatsby-dev-cli/README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,42 @@
11
# gatsby-dev-cli
22

3-
A dev cli tool for Gatsby.
3+
A commandline tool for local Gatsby development. When doing development work on the Gatsby core this tool allows you to easily update any project that has depencies on packages from Gatsby, like a site you are working on.
44

5-
It's a simple cli tool for have easily a functionnal development environment for working on Gatsby.
65

76
## Install
87

9-
Fork gatsby repo and clone it.
10-
118
```bash
129
$ npm install -g gatsby-dev-cli@canary
13-
$ gatsby-dev --set-path-to-repo /path/to/my/cloned/version/gatsby
1410
```
1511

12+
or
1613

17-
## How to use
14+
```bash
15+
$ yarn global add gatsby-dev-cli@canary
16+
```
17+
18+
## Configuration / First time setup
1819

19-
Go to your project and execute corresponding following command to use local version of gatsby.
20+
The gatsby-dev-cli tool needs to know where your cloned Gatsby repository is located. You typically only need to configure this once.
2021

21-
Note: First time can be very long, be patient ;)
22+
```
23+
$ gatsby-dev --set-path-to-repo /path/to/my/cloned/version/gatsby
24+
```
2225

23-
### Repo with gatsby dependencies
26+
## How to use
27+
28+
Navigate to the project you want to link to your forked Gatsby repository and run:
2429

2530
```bash
2631
$ gatsby-dev
2732
```
2833

29-
Tools automaticly find gatsby packages into current `package.json`, copy it from your local fork and watch!
34+
The tool will then scan your project's package.json to find any Gatsby dependencies and copy them into your project's node_modules folder. A watch task is then created to re-copy any modules that might change while you're working on the code, so you can leave this program running.
3035

3136
### Repo without gatby dependencies
3237

38+
You can prevent the automatic depencencies scan and instead specify a list of packages you want to link by using the `--packages` option:
39+
3340
```bash
3441
$ gatsby-dev --packages gatsby gatsby-typegen-remark
3542
```

0 commit comments

Comments
 (0)