Skip to content

Commit 26c3e88

Browse files
committed
doc: add command options to README.md
Documents options accepted by node-gyp. Continuation of nodejs#880.
1 parent 918ac6d commit 26c3e88

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

+32-3
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ You will also need to install:
4444
* On Windows:
4545
* Visual C++ Build Environment:
4646
* Option 1: Install [Visual C++ Build Tools](http://go.microsoft.com/fwlink/?LinkId=691126) using the **Default Install** option.
47-
47+
4848
* Option 2: Install [Visual Studio 2015](https://www.visualstudio.com/products/visual-studio-community-vs) (or modify an existing installation) and select *Common Tools for Visual C++* during setup. This also works with the free Community and Express for Desktop editions.
49-
49+
5050
> :bulb: [Windows Vista / 7 only] requires [.NET Framework 4.5.1](http://www.microsoft.com/en-us/download/details.aspx?id=40773)
51-
51+
5252
* Install [Python 2.7](https://www.python.org/downloads/) (`v3.x.x` is not supported), and run `npm config set python python2.7` (or see below for further instructions on specifying the proper Python version and path.)
5353
* Launch cmd, `npm config set msvs_version 2015`
5454

@@ -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 n 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+
| `--directory=$dir` | Run command in different directory
171+
| `--make=$make` | Override make command, e.g. with gmake
172+
| `--thin=$thin` | Enable thin static libraries
173+
| `--arch=$arch` | Set target architecture (e.g. ia32)
174+
| `--tarball=$path` | Get headers from a local tarball
175+
| `--ensure` | Don't reinstall headers if already present
176+
| `--dist-url=$url` | Download header tarball from custom URL
177+
| `--proxy=$url` | Set HTTP proxy for downloading header tarball
178+
| `--cafile=$cafile` | Override default CA chain (to download tarball)
179+
| `--nodedir=$path` | Set the path to the node binary
180+
| `--python=$path` | Set path to the python (2) binary
181+
| `--msys_version=$version` | Set Visual Studio version (win)
182+
| `--solution=$solution` | Set Visual Studio Solution version (win)
183+
184+
156185
License
157186
-------
158187

0 commit comments

Comments
 (0)