0
0
mirror of https://github.com/tj/n.git synced 2024-12-01 13:41:07 +00:00
n/Readme.md

158 lines
4.7 KiB
Markdown
Raw Normal View History

2011-01-05 15:01:29 +00:00
# n
Simple flavour of node/iojs binary management, no subshells, no profile setup, no convoluted api, just _simple_.
2011-01-05 15:01:29 +00:00
2013-10-12 15:01:09 +00:00
![](https://i.cloudup.com/59cA8VEDae.gif)
2013-08-28 03:08:43 +00:00
2011-01-05 15:01:29 +00:00
## Installation
2011-07-07 22:27:38 +00:00
$ npm install -g n
2011-01-05 15:01:29 +00:00
or
$ make install
to `$HOME`. Prefix later calls to `n` with `N_PREFIX=$HOME`
$ PREFIX=$HOME make install
2011-01-05 15:01:29 +00:00
2011-01-21 03:35:00 +00:00
### Installing Binaries
2011-01-05 15:48:51 +00:00
2013-01-18 15:44:01 +00:00
Install a few nodes:
2011-01-05 15:48:51 +00:00
2013-01-18 15:44:01 +00:00
$ n 0.8.14
$ n 0.8.17
$ n 0.9.6
2011-01-05 15:48:51 +00:00
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:
2011-01-05 15:48:51 +00:00
$ n
2011-10-26 20:59:40 +00:00
2013-01-18 15:44:01 +00:00
0.8.14
ο 0.8.17
0.9.6
2011-01-05 15:48:51 +00:00
2011-01-21 23:25:07 +00:00
Use or install the latest official release:
$ n latest
Use or install the stable official release:
$ n stable
2013-01-18 18:43:44 +00:00
Switch to the previous version you were using:
$ n prev
2011-01-21 03:35:00 +00:00
### Removing Binaries
2011-01-05 15:55:56 +00:00
2011-01-05 16:17:16 +00:00
Remove some versions:
2013-07-12 10:25:31 +00:00
$ n rm 0.9.4 v0.10.0
2011-01-05 16:17:16 +00:00
2011-01-05 16:23:02 +00:00
Instead of using `rm` we can simply use `-`:
2013-07-12 10:25:31 +00:00
$ n - 0.9.4
2011-01-05 16:23:02 +00:00
2011-01-21 03:35:00 +00:00
### Binary Usage
2011-01-05 16:43:16 +00:00
When running multiple versions of node, we can target
them directly by asking `n` for the binary path:
2013-07-12 10:25:31 +00:00
$ n bin 0.9.4
/usr/local/n/versions/0.9.4/bin/node
2011-01-05 16:43:16 +00:00
2013-01-18 19:19:01 +00:00
Or by using a specific version through `n`'s `use` sub-command:
2011-01-05 15:01:29 +00:00
2013-07-12 10:25:31 +00:00
$ n use 0.9.4 some.js
2011-01-05 15:01:29 +00:00
2011-01-05 21:33:28 +00:00
with flags:
2011-01-05 16:17:16 +00:00
2013-07-12 10:25:31 +00:00
$ n as 0.9.4 --debug some.js
2011-01-05 15:01:29 +00:00
2011-01-05 21:33:28 +00:00
## Usage
2011-01-05 15:01:29 +00:00
2011-01-05 21:33:28 +00:00
Output from `n --help`:
Usage: n [options/env] [COMMAND] [args]
2011-01-05 15:01:29 +00:00
Environments:
n [COMMAND] [args] Uses default env (node)
n node [COMMAND] [args] Sets env as node
n io [COMMAND] Sets env as io
2013-01-18 15:41:51 +00:00
Commands:
n Output versions installed
2013-07-12 10:25:31 +00:00
n latest Install or activate the latest node release
n stable Install or activate the latest stable node release
n <version> Install node <version>
2013-01-18 15:41:51 +00:00
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 prev Revert to the previously activated version
2013-01-18 15:41:51 +00:00
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
(iojs):
n io latest Install or activate the latest iojs release
n io stable Install or activate the latest stable iojs release
n io <version> Install iojs <version>
n io use <version> [args ...] Execute iojs <version> with [args ...]
n io bin <version> Output bin path for <version>
n io rm <version ...> Remove the given version(s)
n io --latest Output the latest iojs version available
n io --stable Output the latest stable iojs version available
n io ls Output the versions of iojs available
2013-01-18 15:41:51 +00:00
Options:
-V, --version Output current version of n
-h, --help Display help information
Aliases:
iojs io
2013-01-18 15:41:51 +00:00
which bin
use as
list ls
- rm
2011-01-21 23:25:07 +00:00
2011-01-05 15:08:46 +00:00
## 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.
2011-10-26 20:59:40 +00:00
Activated nodes are then installed to the prefix _/usr/local_, which of course may be altered via the __N_PREFIX__ environment variable.
2011-01-05 15:40:17 +00:00
2011-01-05 15:08:46 +00:00
To alter where `n` operates simply export __N_PREFIX__ to whatever you prefer.
2011-10-26 20:59:40 +00:00
## License
2011-01-05 13:50:12 +00:00
(The MIT License)
2014-02-04 07:08:47 +00:00
Copyright (c) 2014 TJ Holowaychuk &lt;tj@vision-media.ca&gt;
2011-01-05 13:50:12 +00:00
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
2011-10-26 20:59:40 +00:00
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.