linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2026-04-24 04:29:25 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
ohmyzsh/plugins/nvm/README.md
Andrew Janke 7f4707874f nvm: split out $NVM_DIR and $NVM_INSTALL_DIR
2016-08-11 23:30:24 -04:00

2.4 KiB
Raw Blame History

NVM

The nvm plugin locates and loads NVM if it is installed on this system. It also provides completion support, either through its own completion definition, or the bash_completion shipped with NVM itself.

Installation Locations

This plugin looks in a few well-known locations for the NVM installation, in the following order:

  • $NVM_INSTALL_DIR - Forces loading from an arbitrary location that may be different from the $NVM_DIR data directory. If provided, no other locations will be checked.
  • $NVM_DIR - Arbitrary installation location that is also the data directory
  • ~/.nvm - Default installation location for NVM
  • $(brew --prefix nvm) - Mac Homebrew's NVM installation location

After NVM is loaded, $NVM_DIR is set as part of NVM initialization, so you can use it regardless of whether you set it explicitly earlier.

Note that the NVM installer adds the commands to load NVM (by sourceing it from the install location) directly to your ~/.zshrc or other initialization file. This is not required for NVM to be "installed" in the sense that this plugin means. This plugin provides an alternate way of loading NVM, and you shouldn't use both. If you use this plugin, remove any source ~/.nvm/nvm.sh or similar lines from your ~/.zshrc.

Other package managers may install NVM to other locations, and we'll add those in if you let us know about them by opening an issue or PR on GitHub.

Completion Alternatives

This plugin supplies a zsh-native _nvm completion definition, which is loaded by default. This provides descriptions of the options it can complete.

You can also use the portable bash completion definition that is bundled with the NVM installation. This has the advantages:

  • More complete with respect to options (because you're using the exact completion definitions for the version of NVM you're running).
  • Able to complete Node.js versions based on the versions installed in the NVM you have loaded.

To use NVM's bundled bash completions, set ZSH_NVM_BUNDLED_COMPLETION=true in your ~/.zshrc before loading Oh My Zsh.

Environment Variables

  • $ZSH_NVM_BUNDLED_COMPLETION - if true, uses NVM's own completion definition instead of the OMZ nvm plugin's definition
  • $NVM_INSTALL_DIR - overrides installation search path
  • $NVM_DIR - NVM data directory and possible installation location