Skip to content

Commit ea4b215

Browse files
committed
docs: expand README with detailed command line options and installation instructions
1 parent 995aa1a commit ea4b215

File tree

1 file changed

+98
-0
lines changed

1 file changed

+98
-0
lines changed

README.rst

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,104 @@ use `shim` script::
235235
$ ./env-4.3/bin/shim --version
236236
v0.4.3
237237

238+
Command Line Options
239+
--------------------
240+
241+
Basic options
242+
^^^^^^^^^^^^^
243+
244+
``-n NODE_VER, --node=NODE_VER``
245+
The node.js version to use, e.g., ``--node=22.11.0``. The default is the
246+
last stable version (``latest``). Use ``lts`` for the latest LTS release.
247+
Use ``system`` to use system-wide node.
248+
249+
``-l, --list``
250+
Lists available node.js versions.
251+
252+
``-p, --python-virtualenv``
253+
Use current python virtualenv.
254+
255+
``-r FILENAME, --requirements=FILENAME``
256+
Install all the packages listed in the given requirements file.
257+
258+
``--prompt=PROMPT``
259+
Provides an alternative prompt prefix for this environment.
260+
261+
``--force``
262+
Force installation in a pre-existing directory.
263+
264+
``--update``
265+
Install npm packages from file without reinstalling node.
266+
267+
Installation options
268+
^^^^^^^^^^^^^^^^^^^^
269+
270+
``--prebuilt``
271+
Install node.js from prebuilt package (default).
272+
273+
``--source``
274+
Install node.js from the source (Unix only).
275+
276+
``--mirror=URL``
277+
Set mirror server of nodejs.org to download from.
278+
279+
``-c, --clean-src``
280+
Remove "src" directory after installation.
281+
282+
NPM options
283+
^^^^^^^^^^^
284+
285+
``--npm=NPM_VER``
286+
The npm version to use, e.g., ``--npm=10.0.0``.
287+
The default is the last available version (``latest``).
288+
289+
``--with-npm``
290+
Install npm into the new virtual environment. Required for node.js < 0.6.3.
291+
By default, the npm included with node.js is used.
292+
293+
``--no-npm-clean``
294+
Skip the npm 0.x cleanup. Cleanup is enabled by default.
295+
296+
Compilation options (Unix only)
297+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
298+
299+
``-j JOBS, --jobs=JOBS``
300+
Sets number of parallel commands at node.js compilation. The default is 2 jobs.
301+
302+
``--load-average=LOAD``
303+
Sets maximum load average for executing parallel commands at node.js compilation.
304+
305+
``-m MAKE_PATH, --make=MAKE_PATH``
306+
Path to make command.
307+
308+
``--without-ssl``
309+
Build node.js without SSL support.
310+
311+
``--debug``
312+
Build debug variant of the node.js.
313+
314+
``--profile``
315+
Enable profiling for node.js.
316+
317+
Other options
318+
^^^^^^^^^^^^^
319+
320+
``-v, --verbose``
321+
Verbose mode.
322+
323+
``-q, --quiet``
324+
Quiet mode.
325+
326+
``-C CONFIG_FILE, --config-file=CONFIG_FILE``
327+
Load a different config file than ``~/.nodeenvrc``.
328+
Pass an empty string for no config (use built-in defaults).
329+
330+
``--ignore_ssl_certs``
331+
Ignore SSL certificates for package downloads. **UNSAFE - use at your own risk**.
332+
333+
``--version``
334+
Show program version and exit.
335+
238336
Configuration
239337
-------------
240338
You can use the INI-style file ``~/.nodeenvrc`` to set default values for many options,

0 commit comments

Comments
 (0)