1
0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-23 07:14:34 +08:00
ohmyzsh/plugins/nvm
Paul Robert Lloyd 4298e89b4b
docs(nvm): clarify how to enable settings (#9542)
It wasn’t clear where I should set the `NVM_AUTOLOAD` variable. The clue was to be found in [the docs for another plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/fzf). It seems setting values need to come before Oh My Zsh is sourced.

Updated read me to reflect this, and the fact that one of the settings mentioned is specific to nvm, not this plugin.
2021-01-02 14:04:34 +01:00
..
_nvm nvm: add install-latest-npm to completion (#8709) 2020-03-09 15:32:39 +01:00
nvm.plugin.zsh nvm: add autoloading of nvm version in .nvmrc 2020-10-09 17:21:03 +02:00
README.md docs(nvm): clarify how to enable settings (#9542) 2021-01-02 14:04:34 +01:00

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 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 and yarn, so when you call either of these three, nvm will load with nvm use default.

  • NVM_AUTOLOAD: if NVM_AUTOLOAD is set to 1, 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.