0
0
mirror of https://github.com/tj/n.git synced 2024-11-29 05:42:48 +01:00
n/Readme.md
2013-01-19 13:25:19 -08:00

144 lines
3.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# n
Simple flavour of node binary management, no subshells, no profile setup, no convoluted api, just _simple_.
## Installation
$ npm install -g n
or
$ make install
### Installing Binaries
Install a few nodes:
$ n 0.8.14
$ n 0.8.17
$ n 0.9.6
Type `n` to prompt selection of an installed node. Use the up /
down arrow to navigate, and press enter or the right arrow to
select, or ^C to cancel:
$ n
0.8.14
ο 0.8.17
0.9.6
Pass some config flags to _./configure_:
$ n 0.2.6 --debug
List installed binaries, config flags are shown:
0.2.3
ο 0.2.6 --debug
0.3.4
0.3.5
Use or install the latest official release:
$ n latest
Use or install the stable official release:
$ n stable
Switch to the previous version you were using:
$ n prev
### Removing Binaries
Remove some versions:
$ n rm 0.2.4 v0.3.0
Instead of using `rm` we can simply use `-`:
$ n - 0.2.4
### Binary Usage
When running multiple versions of node, we can target
them directly by asking `n` for the binary path:
$ n bin 0.3.3
/usr/local/n/versions/0.3.3/bin/node
Or by using a specific version through `n`'s `use` sub-command:
$ n use 0.3.3 some.js
with flags:
$ n as 0.3.3 --debug some.js
## Usage
Output from `n --help`:
Usage: n [options] [COMMAND] [config]
Commands:
n Output versions installed
n latest [config ...] Install or activate the latest node release
n stable [config ...] Install or activate the latest stable node release
n <version> [config ...] Install and/or use node <version>
n use <version> [args ...] Execute node <version> with [args ...]
n bin <version> Output bin path for <version>
n rm <version ...> Remove the given version(s)
n --latest Output the latest node version available
n --stable Output the latest stable node version available
n ls Output the versions of node available
Options:
-V, --version Output current version of n
-h, --help Display help information
Aliases:
which bin
use as
list ls
- rm
## Details
`n` by default installs node to _/usr/local/n/versions_, from
which it can see what you have currently installed, and activate previously installed versions of node when `n <version>` is invoked again.
Activated nodes are then installed to the prefix _/usr/local_, which of course may be altered via the __N_PREFIX__ environment variable.
To alter where `n` operates simply export __N_PREFIX__ to whatever you prefer.
## License
(The MIT License)
Copyright (c) 2010 TJ Holowaychuk &lt;tj@vision-media.ca&gt;
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.