README.md 8.3 KB
Newer Older
C
Corey Butler 已提交
1 2 3 4
[![Tweet This!][1.1] Tweet This!][1]
[1.1]: http://i.imgur.com/wWzX9uB.png (Tweet about NVM for Windows)
[1]: https://twitter.com/intent/tweet?hashtags=nodejs&original_referer=http%3A%2F%2F127.0.0.1%3A91%2F&text=Check%20out%20NVM%20for%20Windows!&tw_p=tweetbutton&url=http%3A%2F%2Fgithub.com%2Fcoreybutler%2Fnvm-windows&via=goldglovecb

C
Corey Butler 已提交
5
# Node Version Manager (nvm) for Windows
C
Corey Butler 已提交
6

C
Corey Butler 已提交
7
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/coreybutler/nvm-windows?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) (I post development updates here)
T
The Gitter Badger 已提交
8

C
Corey Butler 已提交
9
Manage multiple installations of node.js on a Windows computer.
C
Corey Butler 已提交
10
**tl;dr** [nvm](https://github.com/creationix/nvm), but for Windows, with an installer. [Download Now](https://github.com/coreybutler/nvm/releases)! No io.js support, since [iojs is merging back with node](http://blog.nodejs.org/2015/05/15/node-leaders-are-building-an-open-foundation/), there is no longer a need to add special support for it.
C
Corey Butler 已提交
11

C
Corey Butler 已提交
12

C
Corey Butler 已提交
13
![NVM for Windows](http://coreybutler.github.io/nvm-windows/images/installlatest.jpg)
C
Corey Butler 已提交
14 15

There are situations where the ability to switch between different versions of Node.js can be very
C
Corey Butler 已提交
16
useful. For example, if you want to test a module you're developing with the latest
C
Corey Butler 已提交
17 18
bleeding edge version without uninstalling the stable version of node, this utility can help.

C
Corey Butler 已提交
19
![Switch between stable and unstable versions.](http://coreybutler.github.io/nvm-windows/images/use.jpg)
C
Corey Butler 已提交
20

C
Corey Butler 已提交
21
### Installation & Upgrades
C
Corey Butler 已提交
22

C
Corey Butler 已提交
23
It comes with an installer (and uninstaller), because getting it should be easy. Please note, you need to uninstall any existing versions of node.js before installing NVM for Windows.
C
Corey Butler 已提交
24

C
Corey Butler 已提交
25 26
[Download the latest installer from the releases](https://github.com/coreybutler/nvm/releases).

C
Corey Butler 已提交
27
![NVM for Windows Installer](http://coreybutler.github.io/nvm-windows/images/installer.jpg)
C
Corey Butler 已提交
28

C
Corey Butler 已提交
29
**To upgrade**, run the new installer. It will safely overwrite the files it needs to update without touching your node.js installations.
C
Corey Butler 已提交
30 31
Make sure you use the same installation and symlink folder. If you originally installed to the default locations, you just need to click
"next" on each window until it finishes.
C
Corey Butler 已提交
32 33 34

### Usage

C
Corey Butler 已提交
35
NVM for Windows is a command line tool. Simply type `nvm` in the console for help. The basic commands are:
C
Corey Butler 已提交
36

C
Corey Butler 已提交
37
- `nvm arch [32|64]`: Show if node is running in 32 or 64 bit mode. Specify 32 or 64 to override the default architecture.
C
Corey Butler 已提交
38
- `nvm install <version> [arch]`: The version can be a node.js version or "latest" for the latest stable version. Optionally specify whether to install the 32 or 64 bit version (defaults to system arch). Set `[arch]` to "all" to install 32 AND 64 bit versions.
C
Corey Butler 已提交
39
- `nvm list [available]`: List the node.js installations. Type `available` at the end to show a list of versions available for download.
C
Corey Butler 已提交
40 41 42
- `nvm on`: Enable node.js version management.
- `nvm off`: Disable node.js version management (does not uninstall anything).
- `nvm proxy [url]`: Set a proxy to use for downloads. Leave `[url]` blank to see the current proxy. Set `[url]` to "none" to remove the proxy.
C
Corey Butler 已提交
43
- `nvm uninstall <version>`: Uninstall a specific version.
C
Corey Butler 已提交
44 45 46
- `nvm use <version> [arch]`: Switch to use the specified version. Optionally specify 32/64bit architecture. `nvm use <arch>` will continue using the selected version, but switch to 32/64 bit mode based on the value supplied to `<arch>`.
- `nvm root <path>`: Set the directory where nvm should store different versions of node.js. If `<path>` is not set, the current root will be displayed.
- `nvm version`: Displays the current running version of NVM for Windows.
C
Corey Butler 已提交
47 48 49

### Gotcha!

C
Updated  
Corey Butler 已提交
50
Please note that any global npm modules you may have installed are **not** shared between the various versions of node.js you have installed.
C
Corey Butler 已提交
51
Additionally, some npm modules may not be supported in the version of node you're using, so be aware of your environment as you work.
C
Corey Butler 已提交
52 53 54 55 56 57

---

## Why another version manager?

There are several version managers for node.js. Tools like [nvm](https://github.com/creationix/nvm) and [n](https://github.com/visionmedia/n)
C
Corey Butler 已提交
58
only run on Mac OSX and Linux. Windows users are left in the cold? No. [nvmw](https://github.com/hakobera/nvmw) and [nodist](https://github.com/marcelklehr/nodist)
C
Corey Butler 已提交
59 60
are both designed for Windows. So, why another version manager for Windows?

C
Corey Butler 已提交
61 62 63
The architecture of most node version managers for Windows rely on `.bat` files, which do some clever tricks to set or mimic environment variables.
Some of them use node itself (once it's downloaded), which is admirable, but prone to problems. Right around node 0.10.30, the installation
structure changed a little, causing some of these to just stop working with anything new.
C
Corey Butler 已提交
64

C
Corey Butler 已提交
65 66 67 68 69
Additionally, some users struggle to install these modules since it requires a little more knowledge of node's installation structure. I believe if it
were easier for people to switch between versions, people might take the time to test their code on back and future versions... which is
just good practice.

## What's the big difference?
C
Corey Butler 已提交
70 71

First and foremost, this version of nvm has no dependency on node. It's written in [Go](http://golang.org/), which is a much more structured
C
Corey Butler 已提交
72 73 74 75 76 77 78 79 80 81 82
approach than hacking around a limited `.bat` file. It does not rely on having an existing node installation. Plus, should the need arise, Go
offers potential for creating a Mac/Linux version on the same code base with a substanially easier migration path than converting a bunch of
batch to shell logic. `bat > sh, it crazy, right?`

The control mechanism is also quite different. There are two general ways to support multiple node installations with hot switching capabilities.
The first is to modify the system `PATH` any time you switch versions, or bypass it by using a `.bat` file to mimic the node executable and redirect
accordingly. This always seemed a little hackish to me, and there are some quirks as a result of this implementation.

The second option is to use a symlink. This concept requires putting the symlink in the system `PATH`, then updating its target to
the node installation directory you want to use. This is a straightforward approach, and seems to be what people recommend.... until they
realize just how much of a pain symlinks are on Windows. This is why it hasn't happened before.
C
Corey Butler 已提交
83

C
Corey Butler 已提交
84 85 86 87 88 89
In order to create/modify a symlink, you must be running as an admin, and you must get around Windows UAC (that annoying prompt). Luckily, this is
a challenge I already solved with some helper scripts in [node-windows](http://github.com/coreybutler/node-windows). As a result, NVM for Windows
maintains a single symlink that is put in the system `PATH` during installation only. Switching to different versions of node is a matter of
switching the symlink target. As a result, this utility does **not** require you to run `nvm use x.x.x` every time you open a console window.
When you _do_ run `nvm use x.x.x`, the active version of node is automatically updated across all open console windows. It also persists
between system reboots, so you only need to use nvm when you want to make a change.
C
Corey Butler 已提交
90

C
Corey Butler 已提交
91
NVM for Windows comes with an installer, courtesy of a byproduct of my work on [Fenix Web Server](http://fenixwebserver.com).
C
Corey Butler 已提交
92

C
Updated  
Corey Butler 已提交
93
Overall, this project brings together some ideas, a few battle-hardened pieces of other modules, and support for newer versions of node.
C
Corey Butler 已提交
94

C
Corey Butler 已提交
95 96 97
I also wrote a simple [data feed](http://github.com/coreybutler/nodedistro) containing a list of node.js versions and their associated npm version.
This is how NVM for Windows recognizes the "latest" stable version. It's free for anyone to use.

C
Updated  
Corey Butler 已提交
98
## Motivation
C
Corey Butler 已提交
99 100

I needed it, plain and simple. Additionally, it's apparent that [support for multiple versions](https://github.com/joyent/node/issues/8075) is not
C
Updated  
Corey Butler 已提交
101
coming to node core, or even something they care about. It was also an excuse to play with Go.
C
Corey Butler 已提交
102 103 104

## License

C
Corey Butler 已提交
105
MIT.
C
Corey Butler 已提交
106 107 108

## Thanks

C
Corey Butler 已提交
109
Thanks to everyone who has submitted issues on and off Github, made suggestions, and generally helped make this a better project. Special thanks to [@vkbansal](https://github.com/vkbansal), who has actively provided feedback throughout the releases. Thanks also go to @rainabba and @sullivanpt for getting Node v4 support integrated.
C
Corey Butler 已提交
110 111 112 113 114 115 116

## Alternatives

- [nvmw](https://github.com/hakobera/nvmw) - Windows Only
- [nodist](https://github.com/marcelklehr/nodist) - Windows Only
- [nvm](https://github.com/creationix/nvm) - Mac/Linux Only
- [n](https://github.com/visionmedia/n) - Mac/Linux Only