-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Node Version Manager - POSIX-compliant bash script to manage multiple active node.js versions
License
nvm-sh/nvm
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Example: $ nvm use 16
Now using node v16.9.1 (npm v7.21.1)
$ node -v
v16.9.1
$ nvm use 14
Now using node v14.18.0 (npm v6.14.15)
$ node -v
v14.18.0
$ nvm install 12
Now using node v12.22.6 (npm v6.14.5)
$ node -v
v12.22.6 Simple as that! nvm is a version manager for windows WSL. To install or update nvm, you should run the install script. To do that, you may either download and run the script manually, or use the following cURL or Wget command: | bash
| bash
Running either of the above commands downloads a script and runs it. The script clones the nvm repository to export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" --no-use # This loads nvm, without auto-using the default version
When invoking bash as a non-interactive shell, like in a Docker container, none of the regular profile files are sourced. In order to use # Use bash for the shell
SHELL ["/bin/bash", "-o", "pipefail", "-c"]
# Create a script file sourced by both interactive and non-interactive bash shells
ENV BASH_ENV /home/user/.bash_env
RUN touch "${BASH_ENV}"
RUN echo '. "${BASH_ENV}"' >> ~/.bashrc
# Download and install nvm
RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | PROFILE="${BASH_ENV}" bash
RUN echo node > .nvmrc
RUN nvm install On Linux, after running the install script, if you get bash: zsh: ksh: These should pick up the Since OS X 10.9, If you get
If the above doesn't fix the problem, you may try the following:
Note For Macs with the Apple Silicon chip, node started offering arm64 arch Darwin packages since v16.0.0 and experimental arm64 support when compiling from source since v14.17.0. If you are facing issues installing node using You can use a task: - name: Install nvm
ansible.builtin.shell: >
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
args:
creates: "{{ ansible_env.HOME }}/.nvm/nvm.sh" To verify that nvm has been installed, do: command -v nvm which should output Note: On Linux, after running the install script, if you get If you're running a system without prepackaged binary available, which means you're going to install node or io.js from its source code, you need to make sure your system has a C++ compiler. For OS X, Xcode will work, for Debian/Ubuntu based GNU/Linux, the Note: Note:
Note: We still have some problems with FreeBSD, because there is no official pre-built binary for FreeBSD, and building from source may need patches; see the issue ticket: Note: On OS X, if you do not have Xcode installed and you do not wish to download the ~4.3GB file, you can install the Note: On OS X, if you have/had a "system" node installed and want to install modules globally, keep in mind that:
Homebrew installation is not supported. If you have issues with homebrew-installed Note: If you're using Note: Git versions before v1.7 may face a problem of cloning If you have
Now add these lines to your export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion For a fully manual install, execute the following lines to first clone the export NVM_DIR="$HOME/.nvm" && (
git clone https://github.com/nvm-sh/nvm.git "$NVM_DIR"
cd "$NVM_DIR"
git checkout `git describe --abbrev=0 --tags --match "v[0-9]*" $(git rev-list --tags --max-count=1)`
) && \. "$NVM_DIR/nvm.sh" Now add these lines to your export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion For manual upgrade with
(
cd "$NVM_DIR"
git fetch --tags origin
git checkout `git describe --abbrev=0 --tags --match "v[0-9]*" $(git rev-list --tags --max-count=1)`
) && \. "$NVM_DIR/nvm.sh" To download, compile, and install the latest release of node, do this: nvm install node # "node" is an alias for the latest version To install a specific version of node: nvm install 14.7.0 # or 16.3.0, 12.22.1, etc To set an alias: nvm alias my_alias v14.4.0 Make sure that your alias does not contain any spaces or slashes. The first version installed becomes the default. New shells will start with the default version of node (e.g., You can list available versions using nvm ls-remote And then in any new shell just use the installed version: nvm use node Or you can just run it: nvm run node --version Or, you can run any arbitrary command in a subshell with the desired version of node: nvm exec 4.2 node --version You can also get the path to the executable to where it was installed: nvm which 12.22 In place of a version pointer like "14.7" or "16.3" or "12.22.1", you can use the following special default aliases with
Node has a schedule for long-term support (LTS) You can reference LTS versions in aliases and
Any time your local copy of To get the latest LTS version of node and migrate your existing installed packages, use nvm install --reinstall-packages-from=current 'lts/*' If you want to install a new version of Node.js and migrate npm packages from a previous version: nvm install --reinstall-packages-from=node node This will first use "nvm version node" to identify the current version you're migrating packages from. Then it resolves the new version to install from the remote server and installs it. Lastly, it runs "nvm reinstall-packages" to reinstall the npm packages from your prior version of Node to the new one. You can also install and migrate npm packages from specific versions of Node like this: nvm install --reinstall-packages-from=5 6
nvm install --reinstall-packages-from=iojs v4.2 Note that reinstalling packages explicitly does not update the npm version — this is to ensure that npm isn't accidentally upgraded to a broken version for the new node version. To update npm at the same time add the nvm install --reinstall-packages-from=default --latest-npm 'lts/*' or, you can at any time run the following command to get the latest supported npm version on the current node version: nvm install-latest-npm If you've already gotten an error to the effect of "npm does not support Node.js", you'll need to (1) revert to a previous node version ( If you have a list of default packages you want installed every time you install a new version, we support that too -- just add the package names, one per line, to the file # $NVM_DIR/default-packages
rimraf
[email protected]
stevemao/left-pad If you want to install io.js: nvm install iojs If you want to install a new version of io.js and migrate npm packages from a previous version: nvm install --reinstall-packages-from=iojs iojs The same guidelines mentioned for migrating npm packages in node are applicable to io.js. If you want to use the system-installed version of node, you can use the special default alias "system": nvm use system
nvm run system --version If you want to see what versions are installed: nvm ls If you want to see what versions are available to install: nvm ls-remote You can set five colors that will be used to display version and alias information. These colors replace the default colors. Initial colors are: g b y r e Color codes:
nvm set-colors rgBcm If you want the custom colors to persist after terminating the shell, export the export NVM_COLORS='cmgRY'
nvm ls --no-colors
nvm help --no-colors
TERM=dumb nvm ls To restore your PATH, you can deactivate it: nvm deactivate To set a default Node version to be used in any new shell, use the alias 'default': nvm alias default node # this refers to the latest installed version of node
nvm alias default 18 # this refers to the latest installed v18.x version of node
nvm alias default 18.12 # this refers to the latest installed v18.12.x version of node To use a mirror of the node binaries, set export NVM_NODEJS_ORG_MIRROR=https://nodejs.org/dist
nvm install node
NVM_NODEJS_ORG_MIRROR=https://nodejs.org/dist nvm install 4.2 To use a mirror of the io.js binaries, set export NVM_IOJS_ORG_MIRROR=https://iojs.org/dist
nvm install iojs-v1.0.3
NVM_IOJS_ORG_MIRROR=https://iojs.org/dist nvm install iojs-v1.0.3
To pass an Authorization header through to the mirror url, set NVM_AUTH_HEADER="Bearer secret-token" nvm install node You can create a For example, to make nvm default to the latest 5.9 release, the latest LTS version, or the latest node version for the current directory: $ echo "5.9" > .nvmrc
$ echo "lts/*" > .nvmrc # to default to the latest LTS version
$ echo "node" > .nvmrc # to default to the latest version [NB these examples assume a POSIX-compliant shell version of Then when you run nvm use: $ nvm use
Found '/path/to/project/.nvmrc' with version <5.9>
Now using node v5.9.1 (npm v3.7.3) Running nvm install will also switch over to the correct version, but if the correct node version isn't already installed, it will install it for you. $ nvm install
Found '/path/to/project/.nvmrc' with version <5.9>
Downloading and installing node v5.9.1...
Downloading https://nodejs.org/dist/v5.9.1/node-v5.9.1-linux-x64.tar.xz...
#################################################################################### 100.0%
Computing checksum with sha256sum
Checksums matched!
Now using node v5.9.1 (npm v3.7.3)
The contents of a Key/value pairs using Run You can use report issues to the If you prefer a lighter-weight solution, the recipes below have been contributed by In your profile ( Put the following at the end of your cdnvm() {
command cd "$@" || return $?
nvm_path="$(nvm_find_up .nvmrc | command tr -d '\n')"
# If there are no .nvmrc file, use the default nvm version
if [[ ! $nvm_path = *[^[:space:]]* ]]; then
declare default_version
default_version="$(nvm version default)"
# If there is no default version, set it to `node`
# This will use the latest version on your machine
if [ $default_version = 'N/A' ]; then
nvm alias default node
default_version=$(nvm version default)
fi
# If the current version is not the default version, set it to use the default version
if [ "$(nvm current)" != "${default_version}" ]; then
nvm use default
fi
elif [[ -s "${nvm_path}/.nvmrc" && -r "${nvm_path}/.nvmrc" ]]; then
declare nvm_version
nvm_version=$(<"${nvm_path}"/.nvmrc)
declare locally_resolved_nvm_version
# `nvm ls` will check all locally-available versions
# If there are multiple matching versions, take the latest one
# Remove the `->` and `*` characters and spaces
# `locally_resolved_nvm_version` will be `N/A` if no local versions are found
locally_resolved_nvm_version=$(nvm ls --no-colors "${nvm_version}" | command tail -1 | command tr -d '\->*' | command tr -d '[:space:]')
# If it is not already installed, install it
# `nvm install` will implicitly use the newly-installed version
if [ "${locally_resolved_nvm_version}" = 'N/A' ]; then
nvm install "${nvm_version}";
elif [ "$(nvm current)" != "${locally_resolved_nvm_version}" ]; then
nvm use "${nvm_version}";
fi
fi
}
alias cd='cdnvm'
cdnvm "$PWD" || exit This alias would search 'up' from your current directory in order to detect a This shell function will install (if needed) and Put this into your # place this after nvm initialization!
autoload -U add-zsh-hook
load-nvmrc() {
local nvmrc_path
nvmrc_path="$(nvm_find_nvmrc)"
if [ -n "$nvmrc_path" ]; then
local nvmrc_node_version
nvmrc_node_version=$(nvm version "$(cat "${nvmrc_path}")")
if [ "$nvmrc_node_version" = "N/A" ]; then
nvm install
elif [ "$nvmrc_node_version" != "$(nvm version)" ]; then
nvm use
fi
elif [ -n "$(PWD=$OLDPWD nvm_find_nvmrc)" ] && [ "$(nvm version)" != "$(nvm version default)" ]; then
echo "Reverting to nvm default version"
nvm use default
fi
}
add-zsh-hook chpwd load-nvmrc
load-nvmrc After saving the file, run This requires that you have bass installed. # ~/.config/fish/functions/nvm.fish
function nvm
bass source ~/.nvm/nvm.sh --no-use ';' nvm $argv
end
# ~/.config/fish/functions/nvm_find_nvmrc.fish
function nvm_find_nvmrc
bass source ~/.nvm/nvm.sh --no-use ';' nvm_find_nvmrc
end
# ~/.config/fish/functions/load_nvm.fish
function load_nvm --on-variable="PWD"
set -l default_node_version (nvm version default)
set -l node_version (nvm version)
set -l nvmrc_path (nvm_find_nvmrc)
if test -n "$nvmrc_path"
set -l nvmrc_node_version (nvm version (cat $nvmrc_path))
if test "$nvmrc_node_version" = "N/A"
nvm install (cat $nvmrc_path)
else if test "$nvmrc_node_version" != "$node_version"
nvm use $nvmrc_node_version
end
else if test "$node_version" != "$default_node_version"
echo "Reverting to default Node version"
nvm use default
end
end
# ~/.config/fish/config.fish
# You must call it on initialization or listening to directory switching won't work
load_nvm > /dev/stderr Tests are written in Urchin. Install Urchin (and other dependencies) like so:
There are slow tests and fast tests. The slow tests do things like install node and check that the right versions are used. The fast tests fake this to test things like aliases and uninstalling. From the root of the nvm git repository, run the fast tests like this:
Run the slow tests like this:
Run all of the tests like this:
Nota bene: Avoid running nvm while the tests are running. nvm exposes the following environment variables:
Additionally, nvm modifies To activate, you need to source [[ -r $NVM_DIR/bash_completion ]] && \. $NVM_DIR/bash_completion Put the above sourcing line just below the sourcing line for nvm in your profile ( nvm:
alias deactivate install list-remote reinstall-packages uninstall version
cache exec install-latest-npm ls run unload version-remote
current help list ls-remote unalias use which nvm alias:
default iojs lts/* lts/argon lts/boron lts/carbon lts/dubnium lts/erbium node stable unstable
v10.22.0 v12.18.3 v14.8.0 nvm use:
nvm uninstall:
Inside prefix='some/path' Environment Variables: $NPM_CONFIG_PREFIX
$PREFIX Shell settings: set -e In order to provide the best performance (and other optimizations), nvm will download and install pre-compiled binaries for Node (and npm) when you run Alpine Linux, unlike mainstream/traditional Linux distributions, is based on BusyBox, a very compact (~5MB) Linux distribution. BusyBox (and thus Alpine Linux) uses a different C/C++ stack to most mainstream/traditional Linux distributions - musl. This makes binary programs built for such mainstream/traditional incompatible with Alpine Linux, thus we cannot simply There is a If installing nvm on Alpine Linux is still what you want or need to do, you should be able to achieve this by running the following from you Alpine Linux shell, depending on which version you are using: apk add -U curl bash ca-certificates openssl ncurses coreutils python3 make gcc g++ libgcc linux-headers grep util-linux binutils findutils
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash apk add -U curl bash ca-certificates openssl ncurses coreutils python2 make gcc g++ libgcc linux-headers grep util-linux binutils findutils
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash Note: Alpine 3.5 can only install NodeJS versions up to v6.9.5, Alpine 3.6 can only install versions up to v6.10.3, Alpine 3.7 installs versions up to v8.9.3, Alpine 3.8 installs versions up to v8.14.0, Alpine 3.9 installs versions up to v10.19.0, Alpine 3.10 installs versions up to v10.24.1, Alpine 3.11 installs versions up to v12.22.6, Alpine 3.12 installs versions up to v12.22.12, Alpine 3.13 & 3.14 install versions up to v14.20.0, Alpine 3.15 & 3.16 install versions up to v16.16.0 (These are all versions on the main branch). Alpine 3.5 - 3.12 required the package The Node project has some desire but no concrete plans (due to the overheads of building, testing and support) to offer Alpine-compatible binaries. As a potential alternative, @mhart (a Node contributor) has some Docker images for Alpine Linux with Node and optionally, npm, pre-installed. To remove First, use $ nvm_dir="${NVM_DIR:-~/.nvm}"
$ nvm unload
$ rm -rf "$nvm_dir" Edit export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
[[ -r $NVM_DIR/bash_completion ]] && \. $NVM_DIR/bash_completion To make the development and testing work easier, we have a Dockerfile for development usage, which is based on Ubuntu 18.04 base image, prepared with essential and useful tools for $ docker build -t nvm-dev . This will package your current nvm repository with our pre-defined development environment into a docker image named $ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
nvm-dev latest 9ca4c57a97d8 7 days ago 650 MB If you got no error message, now you can easily involve in: $ docker run -h nvm-dev -it nvm-dev
nvm@nvm-dev:~/.nvm$ Please note that it'll take about 8 minutes to build the image and the image size would be about 650MB, so it's not suitable for production usage. For more information and documentation about docker, please refer to its official website:
nvm install -s 0.8.6
nvm node version not found in vim shell If you set node version to a version other than your system node version sudo chmod ugo-x /usr/libexec/path_helper More on this issue in dotphiles/dotzsh. nvm is not compatible with the npm config "prefix" option Some solutions for this issue can be found here There is one more edge case causing this issue, and that's a mismatch between the You have to make sure that the user directory name in To change the user directory and/or account name follow the instructions here Homebrew makes zsh directories unsecure zsh compinit: insecure directories, run compaudit for list.
Ignore insecure directories and continue [y] or abort compinit [n]? y Homebrew causes insecure directories like Macs with Apple Silicon chips Experimental support for the Apple Silicon chip architecture was added in node.js v15.3 and full support was added in v16.0. Because of this, if you try to install older versions of node as usual, you will probably experience either compilation errors when installing node or out-of-memory errors while running your code. So, if you want to run a version prior to v16.0 on an Apple Silicon Mac, it may be best to compile node targeting the
Now you should be able to use node as usual. If you've encountered this error on WSL-2: curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
0 0 0 0 0 0 0 0 --:--:-- 0:00:09 --:--:-- 0curl: (6) Could not resolve host: raw.githubusercontent.com It may be due to your antivirus, VPN, or other reasons. Where you can This could simply be solved by running this in your root directory: sudo rm /etc/resolv.conf
sudo bash -c 'echo "nameserver 8.8.8.8" > /etc/resolv.conf'
sudo bash -c 'echo "[network]" > /etc/wsl.conf'
sudo bash -c 'echo "generateResolvConf = false" >> /etc/wsl.conf'
sudo chattr +i /etc/resolv.conf This deletes your You can check the contents of the file by running: cat /etc/resolv.conf Currently, the sole maintainer is @ljharb - more maintainers are quite welcome, and we hope to add folks to the team over time. Governance will be re-evaluated as the project evolves. Only the latest version (v0.40.1 at this time) is supported. If you are unable to update to the latest version of See LICENSE.md. Copyright list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them. The OpenJS Foundation | Terms of Use | Privacy Policy | Bylaws | Cookie Policy AboutNode Version Manager - POSIX-compliant bash script to manage multiple active node.js versions TopicsResourcesLicenseCode of conductSecurity policyStarsWatchersForks |