|
1 | 1 | netlify-dev-plugin
|
2 | 2 | ==================
|
3 | 3 |
|
4 |
| -Netlify development tools plugin |
5 |
| - |
6 |
| -[](https://oclif.io) |
7 |
| -[](https://npmjs.org/package/netlify-dev-plugin) |
8 |
| -[](https://npmjs.org/package/netlify-dev-plugin) |
9 |
| -[](https://github.com/netlify/netlify-dev-plugin/blob/master/package.json) |
10 |
| - |
11 |
| -<!-- toc --> |
12 |
| -* [Usage](#usage) |
13 |
| -* [Commands](#commands) |
14 |
| -<!-- tocstop --> |
15 |
| -# Usage |
16 |
| -<!-- usage --> |
17 |
| -```sh-session |
18 |
| -$ npm install -g netlify-dev-plugin |
19 |
| -$ oclif-example COMMAND |
20 |
| -running command... |
21 |
| -$ oclif-example (-v|--version|version) |
22 |
| -netlify-dev-plugin/0.1.0 linux-x64 node-v10.15.0 |
23 |
| -$ oclif-example --help [COMMAND] |
24 |
| -USAGE |
25 |
| - $ oclif-example COMMAND |
26 |
| -... |
27 |
| -``` |
28 |
| -<!-- usagestop --> |
29 |
| -# Commands |
30 |
| -<!-- commands --> |
31 |
| -* [`oclif-example hello`](#oclif-example-hello) |
| 4 | +Netlify CLI plugin for local dev experience. |
| 5 | + |
| 6 | +## Usage |
| 7 | + |
| 8 | +* `netlify dev` start a local dev server for the build tool you're using |
| 9 | +* `netlify dev:exec <command>` runs a shell command within the netlify dev environment |
32 | 10 |
|
33 |
| -## `oclif-example hello` |
| 11 | +## Using the beta |
34 | 12 |
|
35 |
| -Describe the command here |
| 13 | +Currently the Netlify dev plugin is in private beta. You'll need to follow these steps to enable it: |
36 | 14 |
|
| 15 | +Make sure Netlify CLI is installed and up to date: |
| 16 | + |
| 17 | +``` |
| 18 | +npm install -g netlify-cli |
37 | 19 | ```
|
38 |
| -USAGE |
39 |
| - $ oclif-example hello |
40 | 20 |
|
41 |
| -OPTIONS |
42 |
| - -n, --name=name name to print |
| 21 | +Then clone and activate the plugin: |
43 | 22 |
|
44 |
| -DESCRIPTION |
45 |
| - ... |
46 |
| - Extra documentation goes here |
| 23 | +``` |
| 24 | +git clone [email protected]:netlify/netlify-dev-plugin.git |
| 25 | +cd netlify-dev-plugin |
| 26 | +netlify plugins:link . |
47 | 27 | ```
|
48 | 28 |
|
49 |
| -_See code: [src/commands/hello.js](https://github.com/netlify/netlify-dev-plugin/blob/v0.1.0/src/commands/hello.js)_ |
50 |
| -<!-- commandsstop --> |
| 29 | +Now you're both ready to start testing netlify dev and to contribute to the project. |
0 commit comments