Skip to content

Commit 9081f6c

Browse files
committed
doc: add command options to README.md
Documents options accepted by node-gyp. Continuation of #880.
1 parent 3f39c1f commit 9081f6c

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ Commands
144144

145145
| **Command** | **Description**
146146
|:--------------|:---------------------------------------------------------------
147+
| `help` | Shows the help dialog
147148
| `build` | Invokes `make`/`msbuild.exe` and builds the native addon
148149
| `clean` | Removes the `build` directory if it exists
149150
| `configure` | Generates project build files for the current platform
@@ -153,6 +154,34 @@ Commands
153154
| `remove` | Removes the node development header files for the given version
154155

155156

157+
Command Options
158+
--------
159+
160+
`node-gyp` accepts the following command options:
161+
162+
| **Command** | **Description**
163+
|:----------------------------------|:------------------------------------------
164+
| `-j n`, `--jobs n` | For `build`: run parallel builds
165+
| `--silly`, `--loglevel=silly` | Log all progress to console
166+
| `--verbose`, `--loglevel=verbose` | Log most progress to console
167+
| `--silent`, `--loglevel=silent` | Don't log anything
168+
| `--debug` | Make Debug build (default=Release)
169+
| `--release`, `--no-debug` | Make Release build
170+
| `--make=$make` |
171+
| `--thin=$thin` |
172+
| `--ensure` |
173+
| `--solution=$solution` | (windows only)
174+
| `--proxy=$proxy` |
175+
| `--nodedir=$path` | Set the path to the node binary
176+
| `--msys_version=$version` |
177+
| `--dist-url=$url` |
178+
| `--tarball=$tarball` |
179+
| `--python=$path` | Set the path to the python binary
180+
| `--arch=$arch` | Build for a different architecture # Can't get this to work
181+
| `--cafile=$cafile` | Override default CA chain (to download tarball)
182+
| `--directory=$dir` |
183+
184+
156185
License
157186
-------
158187

0 commit comments

Comments
 (0)