mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-12-29 07:41:58 +00:00
70a0577712
* Add customizable list of command that triggers lazy loading * Add $NVM_LAZY_CMD * Add instruction to `NVM_LAZY_CMD` in README.md
32 lines
1.4 KiB
Markdown
32 lines
1.4 KiB
Markdown
# nvm plugin
|
|
|
|
This plugin adds autocompletions for [nvm](https://github.com/nvm-sh/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:
|
|
|
|
```zsh
|
|
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 set `NVM_HOMEBREW` to be the directory where you installed it.
|
|
|
|
- **`NVM_LAZY`**: if you want the plugin to defer the load of nvm to speed-up the start of your zsh session,
|
|
set `NVM_LAZY` to `1`. This will use the `--no-use` parameter when loading nvm, and will create a function
|
|
for `node`, `npm`, `yarn`, and the command(s) specified by `NVM_LAZY_CMD`, so when you call either of them,
|
|
nvm will load with `nvm use default`.
|
|
|
|
- **`NVM_LAZY_CMD`**: if you want additional command(s) to trigger lazy loading of nvm, set `NVM_LAZY_CMD` to
|
|
the command or an array of the commands.
|
|
|
|
- **`NVM_AUTOLOAD`**: if `NVM_AUTOLOAD` is set to `1`, the plugin will automatically load a node version when
|
|
if finds a [`.nvmrc` file](https://github.com/nvm-sh/nvm#nvmrc) in the current working directory indicating
|
|
which node version to load.
|