public/zsh-nvm
1
0
Fork 0
mirror of https://github.com/lukechilds/zsh-nvm.git synced 2025-10-30 14:46:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
Zsh plugin for installing, updating and loading nvm
37 Commits 11 Branches 0 Tags 216 KiB
Shell 100%
cade63ed94
Go to file
Luke Childs cade63ed94 Add NVM_LAZY_LOAD option
2016-08-27 10:18:45 +01:00
.gitignore Store previous nvm version when upgrading 2016-07-25 19:03:00 +01:00
README.md Document NVM_DIR option 2016-08-18 17:49:50 +01:00
zsh-nvm.plugin.zsh Add NVM_LAZY_LOAD option 2016-08-27 10:18:45 +01:00

README.md

zsh-nvm

Zsh plugin for installing, updating and loading nvm

nvm is an awesome tool but it can be kind of a pain to install and keep up to date. This zsh plugin allows you to quickly setup nvm once, save it in your dotfiles, then never worry about it again.

The plugin will install the latest stable release of nvm if you don't already have it, and then automatically source it for you. You can upgrade nvm to the latest version whenever you want without losing your installed node versions by running nvm upgrade.

Although this is written as a zsh plugin, it also works with bash if you follow the manual installation instructions.

Usage

Once the plugin's installed nvm will be available. You'll probably want to load this as one of your first plugins so node/npm is available for any other plugins that may require them.

zsh-nvm also wraps nvm in some additional functionality.

Upgrade

If you want to upgrade to the latest release of nvm:

% nvm upgrade
Installed version is v0.31.0
Checking latest version of nvm...
Updating to v0.31.3...
Previous HEAD position was 2176894... v0.31.0
HEAD is now at 56417f8... v0.31.3

Revert

If an upgrade breaks something don't worry, reverting back to the previously installed version is simple:

% nvm revert
Installed version is v0.31.3
Reverting to v0.31.0...
Previous HEAD position was 56417f8... v0.31.3
HEAD is now at 2176894... v0.31.0

Options

Custom Directory

You can specify a custom directory to use with nvm by exporting the NVM_DIR environment variable. It must be set before zsh-nvm is loaded. For example, if you are using antigen, you would put the following in your .zshrc:

export NVM_DIR="$HOME/.custom-nvm-dir"
antigen bundle lukechilds/zsh-nvm

Note: If nvm doesn't exist in this directory it'll be automatically installed when you start a session.

Installation

Using Antigen

Bundle zsh-nvm in your .zshrc

antigen bundle lukechilds/zsh-nvm

Using zplug

Load zsh-nvm as a plugin in your .zshrc

zplug "lukechilds/zsh-nvm"

Using zgen

Include the load command in your .zshrc

zgen load lukechilds/zsh-nvm

As an Oh My ZSH! custom plugin

Clone zsh-nvm into your custom plugins repo

git clone https://github.com/lukechilds/zsh-nvm ~/.oh-my-zsh/custom/plugins/zsh-nvm

Then load as a plugin in your .zshrc

plugins+=(zsh-nvm)

Manually

Clone this repository somewhere (~/.zsh-nvm for example)

git clone https://github.com/lukechilds/zsh-nvm.git ~/.zsh-nvm

Then source it in your .zshrc (or .bashrc)

source ~/.zsh-nvm/zsh-nvm.plugin.zsh

Related

License

MIT © Luke Childs