nvm - ノードバージョンマネージャー - 複数のアクティブノード.jsバージョンを管理するためのPOSIX準拠のbashスクリプト

(Node Version Manager - POSIX-compliant bash script to manage multiple active node.js versions)

Created at: 2010-04-16 01:47:47
Language: Shell
License: MIT

NVMプロジェクトのロゴ

ノードバージョンマネージャビルドステータス NVM バージョン CIIのベストプラクティス

目次

イントロ

nvm
コマンドラインから異なるバージョンのNodeをすばやくインストールして使用できます。

例:

$ 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

そのような単純な!

に関しては

nvm はnode.js 用のバージョンマネージャで、ユーザごとにインストールするように設計されており、POSIX 準拠のシェル (sh、dash、ksh、zsh、bash)、特に unix、macOS、および Windows WSL のプラットフォームでシェルごとに呼び出されます。

nvm

インストールと更新

インストール&アップデートスクリプト

nvmをインストールまたは更新するには、インストールスクリプトを実行する必要があります。これを行うには、スクリプトを手動でダウンロードして実行するか、次のcURLまたはWgetコマンドを使用します。

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash

上記のコマンドのいずれかを実行すると、スクリプトがダウンロードされて実行されます。このスクリプトは、nvmリポジトリをクローンし、以下のスニペットのソース行を正しいプロファイルファイル(,,,または)に追加しようとします。

~/.nvm
~/.bash_profile
~/.zshrc
~/.profile
~/.bashrc

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

追記

  • 環境変数が存在する場合は、そこにファイルが配置されます。

    $XDG_CONFIG_HOME
    nvm

  • 上記のスクリプトの最後に追加できます(...)手動で使用するまで、使用を延期します。

    --no-use
    nvm.sh --no-use
    nvm

  • インストールソース、ディレクトリ、プロファイル、およびバージョンは、,,,および変数を使用してカスタマイズできます。 例えば:。末尾にスラッシュが含まれていないことを確認します。

    NVM_SOURCE
    NVM_DIR
    PROFILE
    NODE_VERSION
    curl ... | NVM_DIR="path/to/nvm"
    NVM_DIR

  • インストーラーは、またはダウンロードのいずれか利用可能な方を使用できます。

    git
    curl
    wget
    nvm

Linux でのトラブルシューティング

Linuxでは、インストールスクリプトを実行した後、入力後にターミナルからのフィードバックが表示されない場合は、現在のターミナルを閉じて新しいターミナルを開き、もう一度確認してみてください。 または、コマンドラインでさまざまなシェルに対して次のコマンドを実行することもできます。

nvm: command not found
command -v nvm

バッシュ:

source ~/.bashrc

zsh:

source ~/.zshrc

ksh:

. ~/.profile

これらはコマンドを拾うはずです。

nvm

macOS でのトラブルシューティング

OS X 10.9以降、Xcodeコマンドラインツールによってプリセットされているため、Gitがインストールされているかどうかを正しく検出できません。インストールスクリプトを実行する前に、Xcodeコマンドラインツールを手動でインストールする必要があります。(#1782 を参照)

/usr/bin/git
)

インストールスクリプトを実行した後、次のいずれかが原因である可能性があります。

nvm: command not found

  • macOS 10.15以降、デフォルトのシェルはnvmが探します更新するには、デフォルトでは何もインストールされていません。で作成し、インストールスクリプトを再度実行します。

    zsh
    .zshrc
    touch ~/.zshrc

  • 以前のデフォルトシェルであるbashを使用する場合、システムにコマンドが設定されているファイル。それらの1つを作成するか、インストールスクリプトを再度実行します。次に、ランまたは拾うコマンド。

    .bash_profile
    .bashrc
    touch ~/.bash_profile
    touch ~/.bashrc
    . ~/.bash_profile
    . ~/.bashrc
    nvm

  • 以前に使用したことがありますが、インストールしました。これらの行を手動で追加して実行する必要があります。

    bash
    zsh
    ~/.zshrc
    . ~/.zshrc

  • ターミナルインスタンスを再起動するか、実行する必要がある場合があります。ターミナルを再起動する/新しいタブ/ウィンドウを開くか、sourceコマンドを実行すると、コマンドと新しい構成がロードされます。

    . ~/.nvm/nvm.sh

  • 上記で問題が解決しない場合は、ターミナルインスタンスを再起動する必要があります。ターミナルで新しいタブ/ウィンドウを開いて再試行してみてください。

上記で問題が解決しない場合は、次のことを試してください。

  • あなたがbashを使うならば、それはあなたの(または)あなたの(または)あなたのソースがあなたの適切にないかもしれません。これに追加するか、以下の次の手順に従って修正できます。

    .bash_profile
    ~/.profile
    ~/.bashrc
    source ~/<your_profile_file>

  • 正しいnvmディレクトリを見つけてnvmをロードするインストールセクションのスニペットを通常のプロファイル(,,,または)に追加してみてください。

    ~/.bash_profile
    ~/.zshrc
    ~/.profile
    ~/.bashrc

  • この問題の詳細と可能な回避策については、こちらを参照してください

手記M1チップを搭載したMacの場合、ノードはv16.0.0以降からarm64アーチダーウィンパッケージの提供を開始し、v14.17.0以降ソースからコンパイルする場合の実験的なarm64サポートを開始しました。ノードのインストールで問題が発生した場合は、それらのバージョン以降のいずれかに更新することをお勧めします。

nvm

アンシブル

次のタスクを使用できます。

- name: Install nvm
  ansible.builtin.shell: >
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
  args:
    creates: "{{ ansible_env.HOME }}/.nvm/nvm.sh"

インストールの確認

nvmがインストールされていることを確認するには、次のようにします。

command -v nvm

インストールが成功した場合に出力する必要があります。注意してください 以来、動作しません はソースシェル関数であり、実行可能なバイナリではありません。

nvm
which nvm
nvm

手記:Linuxでは、インストールスクリプトを実行した後、入力後にターミナルからのフィードバックが表示されない場合は、現在のターミナルを閉じて新しいターミナルを開き、もう一度確認してみてください。

nvm: command not found
command -v nvm

特記事項

パッケージ化されたバイナリが利用できないシステムを実行している場合、つまりソースコードからnodejsまたはio.jsをインストールする場合は、システムにC ++コンパイラがあることを確認する必要があります。OS Xの場合、Xcodeは機能し、Debian/UbuntuベースのGNU / Linuxの場合、パッケージは機能します。

build-essential
libssl-dev

注:場合によってはウィンドウズもサポートします。WSL のバージョンに応じて、WSL (Windows Subsystem for Linux) を介して動作するはずです。また、GitBash(MSYS)またはCygwinでも動作するはずです。それ以外の場合、Windowsの場合、いくつかの代替手段が存在しますが、これらはサポートも開発もされていません。

nvm

注:Fishもサポートしていません(#303を参照)。代替案が存在しますが、これは私たちがサポートも開発もしていません。

nvm

  • bassを使用すると、魚の殻でBash用に書かれたユーティリティを使用できます
  • fast-nvm-fishはバージョン番号(エイリアスではない)でのみ機能しますが、シェルの起動を大幅に遅くすることはありません
  • Oh My Fish 用の plugin-nvmプラグインで、nvm とその補完を魚の殻で利用できるようにします
  • FNM-フィッシャーマンベースの魚のバージョンマネージャー
  • fish-nvm-魚のnvmのラッパーは、実際に使用されるまでnvmの調達を遅らせます。

手記:FreeBSD には公式のビルド済みバイナリがなく、ソースからのビルドにはパッチが必要な場合があるため、 FreeBSD にはまだいくつかの問題があります。発行チケットを参照してください。

手記:OS Xでは、Xcodeがインストールされておらず、~4.3GBファイルをダウンロードしたくない場合は、をインストールできます。あなたはちょうどその方法についてこのブログ投稿をチェックすることができます:

Command Line Tools

手記:OS Xでは、「システム」ノードがインストールされていて、モジュールをグローバルにインストールしたい場合は、次の点に注意してください。

  • 使用する場合は、モジュールをグローバルにインストールする必要がないため、代わりに
    nvm
    sudo
    npm -g
    sudo npm install -g grunt
    npm install -g grunt
  • ファイルがある場合は、設定が含まれていないことを確認してください(これは互換性がありません
    ~/.npmrc
    prefix
    nvm
    )
  • 以前の「システム」ノードのインストールを維持することはできますが(ただし、そうすべきではありませんか?)、ユーザーアカウント(nvmのインストールに使用されたアカウント)でのみ使用できます。これにより、他のユーザーが使用しているため、バージョンの不一致が発生する可能性がありますVSユーザーアカウント
    nvm
    /usr/local/lib/node_modules/*
    ~/.nvm/versions/node/vX.X.X/lib/node_modules/*

自作のインストールはサポートされていません。自作のインストールに問題がある場合は、問題を報告する前に、以下の手順に従ってインストールしてください。

nvm
brew uninstall

手記:使用している場合簡単にインストールできますzshプラグインとして。zsh-nvmをインストールして実行しますアップグレードします。

zsh
nvm
nvm upgrade

手記:v1.7より前のバージョンのGitは、httpsプロトコルを介してGitHubからソースを複製する問題に直面する可能性があり、v1.6より前のgitの動作も異なり、v1.17.10より前のgitはタグを複製できないため、最低限必要なgitバージョンはv1.7.10です。ここで説明した問題に興味がある場合は、GitHubのHTTPSクローン作成エラーの記事を参照してください。

nvm

Git インストール

インストールしている場合 (git v1.7.10+ が必要):

git

  1. このリポジトリをユーザー プロファイルのルートに複製します
    • cd ~/
      どこからでも
      git clone https://github.com/nvm-sh/nvm.git .nvm
  2. cd ~/.nvm
    で最新バージョンをチェックしてください
    git checkout v0.39.2
  3. アクティベートシェルから調達することで:
    nvm
    . ./nvm.sh

次に、これらの行をyour,, orfileに追加して、ログイン時に自動的にソースを取得します。 (上記のファイルの複数に追加する必要があります)

~/.bashrc
~/.profile
~/.zshrc

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

手動インストール

完全に手動インストールの場合は、次の行を実行して、最初にリポジトリのクローンを作成し、次にロードします。

nvm
$HOME/.nvm
nvm

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"

次に、これらの行をyour,, orfileに追加して、ログイン時に自動的にソースを取得します。 (上記のファイルの複数に追加する必要があります)

~/.bashrc
~/.profile
~/.zshrc

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

手動アップグレード

手動アップグレードの場合(git v1.7.10+が必要):

git

  1. に変更します。
    $NVM_DIR
  2. 最新の変更をプルダウンします
  3. check out the latest version
  4. activate the new version
(
  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"

Usage

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

The first version installed becomes the default. New shells will start with the default version of node (e.g., ).

nvm alias default

You can list available versions using :

ls-remote

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 , , , , , etc:

nvm install
nvm use
nvm run
nvm exec
nvm which

  • node
    : this installs the latest version of
    node
  • iojs
    : this installs the latest version of
    io.js
  • stable
    : this alias is deprecated, and only truly applies to and earlier. Currently, this is an alias for .
    node
    v0.12
    node
  • unstable
    : this alias points to - the last "unstable" node release, since post-1.0, all node versions are stable. (in SemVer, versions communicate breakage, not stability).
    node
    v0.11

Long-term Support

Node has a schedule for long-term support (LTS) You can reference LTS versions in aliases and files with the notation for the latest LTS, and for LTS releases from the "argon" line, for example. In addition, the following commands support LTS arguments:

.nvmrc
lts/*
lts/argon

  • nvm install --lts
    /
    nvm install --lts=argon
    /
    nvm install 'lts/*'
    /
    nvm install lts/argon
  • nvm uninstall --lts
    /
    nvm uninstall --lts=argon
    /
    nvm uninstall 'lts/*'
    /
    nvm uninstall lts/argon
  • nvm use --lts
    /
    nvm use --lts=argon
    /
    nvm use 'lts/*'
    /
    nvm use lts/argon
  • nvm exec --lts
    /
    nvm exec --lts=argon
    /
    nvm exec 'lts/*'
    /
    nvm exec lts/argon
  • nvm run --lts
    /
    nvm run --lts=argon
    /
    nvm run 'lts/*'
    /
    nvm run lts/argon
  • nvm ls-remote --lts
    /
    nvm ls-remote --lts=argon
    nvm ls-remote 'lts/*'
    /
    nvm ls-remote lts/argon
  • nvm version-remote --lts
    /
    nvm version-remote --lts=argon
    /
    nvm version-remote 'lts/*'
    /
    nvm version-remote lts/argon

Any time your local copy of connects to https://nodejs.org, it will re-create the appropriate local aliases for all available LTS lines. These aliases (stored under ), are managed by , and you should not modify, remove, or create these files - expect your changes to be undone, and expect meddling with these files to cause bugs that will likely not be supported.

nvm
$NVM_DIR/alias/lts
nvm

To get the latest LTS version of node and migrate your existing installed packages, use

nvm install 'lts/*' --reinstall-packages-from=current

Migrating Global Packages While Installing

If you want to install a new version of Node.js and migrate npm packages from a previous version:

nvm install node --reinstall-packages-from=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 6 --reinstall-packages-from=5
nvm install v4.2 --reinstall-packages-from=iojs

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 flag, like this:

--latest-npm

nvm install 'lts/*' --reinstall-packages-from=default --latest-npm

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 ( & , (2) delete the newly created node version (), then (3) rerun your with the flag.

nvm ls
nvm use <your latest _working_ version from the ls>
nvm uninstall <your _broken_ version of node from the ls>
nvm install
--latest-npm

Default Global Packages From File While Installing

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 . You can add anything npm would accept as a package argument on the command line.

$NVM_DIR/default-packages

# $NVM_DIR/default-packages

rimraf
object-inspect@1.0.2
stevemao/left-pad

io.js

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 iojs --reinstall-packages-from=iojs

The same guidelines mentioned for migrating npm packages in node are applicable to io.js.

System Version of Node

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

Listing Versions

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

Setting Custom Colors

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:

r/R = red / bold red

g/G = green / bold green

b/B = blue / bold blue

c/C = cyan / bold cyan

m/M = magenta / bold magenta

y/Y = yellow / bold yellow

k/K = black / bold black

e/W = light grey / white
nvm set-colors rgBcm

Persisting custom colors

If you want the custom colors to persist after terminating the shell, export the variable in your shell profile. For example, if you want to use cyan, magenta, green, bold red and bold yellow, add the following line:

NVM_COLORS

export NVM_COLORS='cmgRY'

Suppressing colorized output

nvm help (or -h or --help)
, , and usually produce colorized output. You can disable colors with the option (or by setting the environment variable ):
nvm ls
nvm ls-remote
nvm alias
--no-colors
TERM=dumb

nvm ls --no-colors
nvm help --no-colors
TERM=dumb nvm ls

Restoring PATH

To restore your PATH, you can deactivate it:

nvm deactivate

Set default node version

To set a default Node version to be used in any new shell, use the alias 'default':

nvm alias default node

Use a mirror of node binaries

To use a mirror of the node binaries, set :

$NVM_NODEJS_ORG_MIRROR

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 :

$NVM_IOJS_ORG_MIRROR

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

nvm use
will not, by default, create a "current" symlink. Set to "true" to enable this behavior, which is sometimes useful for IDEs. Note that using in multiple shell tabs with this environment variable enabled can cause race conditions.
$NVM_SYMLINK_CURRENT
nvm

.nvmrc

You can create a file containing a node version number (or any other string that understands; see for details) in the project root directory (or any parent directory). Afterwards, , , , , and will use the version specified in the file if no version is supplied on the command line.

.nvmrc
nvm
nvm --help
nvm use
nvm install
nvm exec
nvm run
nvm which
.nvmrc

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 . If you use a Windows development environment, eg the file is used to configure a remote Linux deployment, then keep in mind the s will be copied leading to an invalid file. Remove them.]

echo
cmd
.nvmrc
"

Then when you run nvm:

$ nvm use
Found '/path/to/project/.nvmrc' with version <5.9>
Now using node v5.9.1 (npm v3.7.3)

nvm use
et. al. will traverse directory structure upwards from the current directory looking for the file. In other words, running et. al. in any subdirectory of a directory with an will result in that being utilized.
.nvmrc
nvm use
.nvmrc
.nvmrc

The contents of a file must be the (as described by ) followed by a newline. No trailing spaces are allowed, and the trailing newline is required.

.nvmrc
<version>
nvm --help

Deeper Shell Integration

You can use

avn
to deeply integrate into your shell and automatically invoke when changing directories. is not supported by the maintainers. Please report issues to the
avn
team
.
nvm
avn
nvm

If you prefer a lighter-weight solution, the recipes below have been contributed by users. They are not supported by the maintainers. We are, however, accepting pull requests for more examples.

nvm
nvm

bash

Automatically call
nvm use

Put the following at the end of your :

$HOME/.bashrc

cdnvm() {
    command cd "$@" || return $?
    nvm_path=$(nvm_find_up .nvmrc | 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" | tail -1 | tr -d '\->*' | 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'
cd "$PWD"

This alias would search 'up' from your current directory in order to detect a file. If it finds it, it will switch to that version; if not, it will use the default version.

.nvmrc

zsh

Calling automatically in a directory with a file
nvm use
.nvmrc

Put this into your to call automatically whenever you enter a directory that contains an file with a string telling nvm which node to :

$HOME/.zshrc
nvm use
.nvmrc
use

# place this after nvm initialization!
autoload -U add-zsh-hook
load-nvmrc() {
  local nvmrc_path="$(nvm_find_nvmrc)"

  if [ -n "$nvmrc_path" ]; then
    local 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

fish

Calling automatically in a directory with a file
nvm use
.nvmrc

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

Running Tests

Tests are written in Urchin. Install Urchin (and other dependencies) like so:

npm install

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:

npm run test/fast

Run the slow tests like this:

npm run test/slow

Run all of the tests like this:

npm test

Nota bene: Avoid running nvm while the tests are running.

Environment variables

nvm exposes the following environment variables:

  • NVM_DIR
    - nvm's installation directory.
  • NVM_BIN
    - where node, npm, and global packages for the active version of node are installed.
  • NVM_INC
    - node's include file directory (useful for building C/C++ addons for node).
  • NVM_CD_FLAGS
    - used to maintain compatibility with zsh.
  • NVM_RC_VERSION
    - version from .nvmrc file if being used.

Additionally, nvm modifies , and, if present, and when changing versions.

PATH
MANPATH
NODE_PATH

Bash Completion

To activate, you need to source :

bash_completion

[[ -r $NVM_DIR/bash_completion ]] && \. $NVM_DIR/bash_completion

Put the above sourcing line just below the sourcing line for nvm in your profile (, ).

.bashrc
.bash_profile

Usage

nvm:

$ nvm
Tab

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:

$ nvm alias
Tab

default      iojs         lts/*        lts/argon    lts/boron    lts/carbon   lts/dubnium  lts/erbium   node         stable       unstable

$ nvm alias my_alias
Tab

v10.22.0       v12.18.3      v14.8.0

nvm use:

$ nvm use
Tab

my_alias        default        v10.22.0       v12.18.3      v14.8.0

nvm uninstall:

$ nvm uninstall
Tab

my_alias        default        v10.22.0       v12.18.3      v14.8.0

Compatibility Issues

nvm
will encounter some issues if you have some non-default settings set. (see #606) The following are known to cause issues:

Inside :

~/.npmrc

prefix='some/path'

Environment Variables:

$NPM_CONFIG_PREFIX
$PREFIX

Shell settings:

set -e

Installing nvm on Alpine Linux

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 . The Node project compiles, tests and hosts/provides these pre-compiled binaries which are built for mainstream/traditional Linux distributions (such as Debian, Ubuntu, CentOS, RedHat et al).

nvm install X

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 on Alpine Linux and expect the downloaded binary to run correctly - you'll likely see "...does not exist" errors if you try that.

nvm install X

There is a flag for which requests nvm download Node source and compile it locally.

-s
nvm install

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:

Alpine Linux 3.13+

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.39.2/install.sh | bash

Alpine Linux 3.5 - 3.12

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.39.2/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

python2
to build NodeJS, as they are older versions to build. Alpine 3.13+ requires
python3
to successfully build newer NodeJS versions, but you can use
python2
with Alpine 3.13+ if you need to build versions of node supported in Alpine 3.5 - 3.15, you just need to specify what version of NodeJS you need to install in the package install script.

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.

Uninstalling / Removal

Manual Uninstall

To remove manually, execute the following:

nvm

$ rm -rf "$NVM_DIR"

Edit (or other shell resource config) and remove the lines below:

~/.bashrc

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

Docker For Development Environment

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 development, to build the docker image of the environment, run the docker command at the root of repository:

nvm
nvm

$ docker build -t nvm-dev .

This will package your current nvm repository with our pre-defined development environment into a docker image named , once it's built with success, validate your image via :

nvm-dev
docker images

$ 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:

Problems

  • If you try to install a node version and the installation fails, be sure to run to delete cached node downloads, or you might get an error like the following:

    nvm cache clear

    curl: (33) HTTP server doesn't seem to support byte ranges. Cannot resume.

  • Where's my ? Check out #43

    sudo node

  • After the v0.8.6 release of node, nvm tries to install from binary packages. But in some systems, the official binary packages don't work due to incompatibility of shared libs. In such cases, use option to force install from source:

    -s

nvm install -s 0.8.6
  • If setting the alias does not establish the node version in new shells (i.e. yields ), ensure that the system's node is set before the source line in your shell profile (see #658
    default
    nvm current
    system
    PATH
    nvm.sh
    )

macOS Troubleshooting

nvm node version not found in vim shell

If you set node version to a version other than your system node version and open vim and run you should see if you see your system version . You need to run:

nvm use 6.2.1
:!node -v
v6.2.1
v0.12.7

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

$HOME
path and the user's home directory's actual name.

You have to make sure that the user directory name in and the user directory name you'd see from running are capitalized the same way (See this issue).

$HOME
ls /Users/

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 and . This is not an problem - it is a homebrew problem. Refer here for some solutions related to the issue.

/usr/local/share/zsh/site-functions
/usr/local/share/zsh
nvm

Macs with M1 chip

Experimental support for the M1 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 M1 Mac, it may be best to compile node targeting the Intel architecture so that Rosetta 2 can translate the processor instructions to ARM-based Apple Silicon instructions. Here's what you will need to do:

x86_64
x86_64

  • Install Rosetta, if you haven't already done so

    $ softwareupdate --install-rosetta

    You might wonder, "how will my M1 Mac know to use Rosetta for a version of node compiled for an Intel chip?". If an executable contains only Intel instructions, macOS will automatically use Rosetta to translate the instructions.

  • Open a shell that's running using Rosetta

    $ arch -x86_64 zsh

    Note: This same thing can also be accomplished by finding the Terminal or iTerm App in Finder, right clicking, selecting "Get Info", and then checking the box labeled "Open using Rosetta".

    Note: This terminal session is now running in . If is not the shell you typically use, may not be 'd automatically like it probably is for your usual shell through your dotfiles. If that's the case, make sure to source .

    zsh
    zsh
    nvm
    source
    nvm

    $ source "${NVM_DIR}/nvm.sh"
  • Install whatever older version of node you are interested in. Let's use 12.22.1 as an example. This will fetch the node source code and compile it, which will take several minutes.

    $ nvm install v12.22.1 --shared-zlib

    Note: You're probably curious why is included. There's a bug in recent versions of Apple's system compiler. If one of these broken versions is installed on your system, the above step will likely still succeed even if you didn't include the flag. However, later, when you attempt to something using your old version of node.js, you will see errors. If you want to avoid the possible hassle of dealing with this, include that flag. For more details, see this issue and this comment

    --shared-zlib
    clang
    --shared-zlib
    npm install
    incorrect data check

  • Exit back to your native shell.

    $ exit
    $ arch
    arm64

    注:2番目のステップでCLIコマンドを実行するのではなく、「Rosettaを使用して開く」というラベルの付いたボックスを選択した場合は、ここが表示されます。 そのボックスを選択する別の理由がない限り、ここで選択を解除できます。

    i386

  • アーキテクチャが省略形 correct.is ことを確認してください。

    x64
    x86_64

    $ node -p process.arch
    x64

これで、通常どおりノードを使用できるようになります。

メンテナ

現在、唯一のメンテナは@ljharb-より多くのメンテナを歓迎しており、時間の経過とともにチームに人々を追加したいと考えています。ガバナンスは、プロジェクトの進展に合わせて再評価されます。

ライセンス

LICENSE.md を参照してください。

著作権表示

著作権OpenJS財団と寄稿者。全著作権所有。OpenJS財団は登録商標を有し、商標を使用しています。OpenJS財団の商標のリストについては、商標ポリシー商標リストをご覧ください。Node.jsはJoyent, Inc.の商標であり、その許可を得て使用しています。OpenJS Foundationの商標リストに記載されていない商標およびロゴは、それぞれの所有者の商標™または登録商標®です。それらの使用は、それらとの提携またはそれらによる承認を意味するものではありません。

nvm

OpenJS財団|利用規約|プライバシーポリシー|OpenJS財団細則|商標ポリシー|商標リスト|クッキーポリシー