.. | ||
_nvm | ||
nvm.plugin.zsh | ||
README.md |
nvm plugin
This plugin adds autocompletions for nvm — a Node.js version manager.
It also automatically sources nvm, so you don't need to do it manually in your .zshrc
.
To use it, add nvm
to the plugins array of your zshrc file:
plugins=(... nvm)
Settings
If you installed nvm in a directory other than $HOME/.nvm
, set and export NVM_DIR
to be the directory
where you installed nvm.
These settings should go in your zshrc file, before Oh My Zsh is sourced:
-
NVM_HOMEBREW
: if you installed nvm via Homebrew, in a directory other than/usr/local/opt/nvm
, you
can setNVM_HOMEBREW
to be the directory where you installed it. For example, on Apple Silicon-based Macs,
Homebrew is installed in/opt/homebrew
. To get the directory where
nvm has been installed, regardless of chip architecture, useNVM_HOMEBREW=$(brew --prefix nvm)
. -
NVM_LAZY
: if you want the plugin to defer the load of nvm to speed-up the start of your zsh session,
setNVM_LAZY
to1
. This will use the--no-use
parameter when loading nvm, and will create a function
fornode
,npm
,yarn
, and the command(s) specified byNVM_LAZY_CMD
, so when you call either of them,
nvm will load withnvm use default
. -
NVM_LAZY_CMD
: if you want additional command(s) to trigger lazy loading of nvm, setNVM_LAZY_CMD
to
the command or an array of the commands. -
NVM_AUTOLOAD
: ifNVM_AUTOLOAD
is set to1
, the plugin will automatically load a node version when
if finds a.nvmrc
file in the current working directory indicating
which node version to load.