zsh-nvm/README.md

137 lines
3.9 KiB
Markdown
Raw Normal View History

2016-07-09 04:21:04 +08:00
# zsh-nvm
> Zsh plugin for installing, updating and loading `nvm`
[`nvm`](https://github.com/creationix/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`.
2016-07-09 04:21:04 +08:00
2016-07-13 20:33:30 +08:00
Although this is written as a zsh plugin, it also works with bash if you follow the [manual installation instructions](#manually).
2016-07-09 04:21:04 +08:00
## Usage
2016-07-25 03:35:52 +08:00
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.
2016-07-09 04:21:04 +08:00
`zsh-nvm` also wraps `nvm` in some additional functionality.
### Upgrade
If you want to upgrade to the latest release of `nvm`:
2016-07-09 04:21:04 +08:00
```shell
% nvm upgrade
Installed version is v0.31.0
2016-07-09 04:21:04 +08:00
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:
```shell
% 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
2016-07-09 04:21:04 +08:00
```
2016-08-19 00:49:50 +08:00
## Options
### Custom Directory
2016-08-27 17:36:40 +08:00
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`:
2016-08-19 00:49:50 +08:00
```shell
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.
### Lazy Loading
2016-08-27 17:37:25 +08:00
If you find `nvm` adds too much lag to your shell startup you can enable lazy loading by exporting the `NVM_LAZY_LOAD` environment variable and setting it to `true`. Lazy loading is around 70 times faster to load, however the first time you run `nvm`, `npm`, `node` or a global module you'll get a slight delay while `nvm` loads first. You'll only get this delay once per session.
For example, if you are using antigen, you would put the following in your `.zshrc`:
```shell
export NVM_LAZY_LOAD=true
antigen bundle lukechilds/zsh-nvm
```
Performance comparison:
```shell
% time (_zsh_nvm_load)
( _zsh_nvm_load; ) 0.58s user 0.37s system 109% cpu 0.874 total
$ time (_zsh_nvm_lazy_load)
( _zsh_nvm_lazy_load; ) 0.01s user 0.01s system 168% cpu 0.012 total
```
Note: This feature is experimental, use with caution.
2016-07-09 04:21:04 +08:00
## Installation
### Using [Antigen](https://github.com/zsh-users/antigen)
Bundle `zsh-nvm` in your `.zshrc`
```shell
antigen bundle lukechilds/zsh-nvm
```
### Using [zplug](https://github.com/b4b4r07/zplug)
Load `zsh-nvm` as a plugin in your `.zshrc`
```shell
zplug "lukechilds/zsh-nvm"
```
### Using [zgen](https://github.com/tarjoilija/zgen)
Include the load command in your `.zshrc`
```shell
zgen load lukechilds/zsh-nvm
```
### As an [Oh My ZSH!](https://github.com/robbyrussell/oh-my-zsh) custom plugin
Clone `zsh-nvm` into your custom plugins repo
```shell
git clone https://github.com/lukechilds/zsh-nvm ~/.oh-my-zsh/custom/plugins/zsh-nvm
```
Then load as a plugin in your `.zshrc`
```shell
plugins+=(zsh-nvm)
```
### Manually
Clone this repository somewhere (`~/.zsh-nvm` for example)
2016-07-09 04:21:04 +08:00
```shell
git clone https://github.com/lukechilds/zsh-nvm.git ~/.zsh-nvm
2016-07-09 04:21:04 +08:00
```
2016-07-13 20:33:30 +08:00
Then source it in your `.zshrc` (or `.bashrc`)
2016-07-09 04:21:04 +08:00
```shell
source ~/.zsh-nvm/zsh-nvm.plugin.zsh
2016-07-09 04:21:04 +08:00
```
2016-07-09 16:35:59 +08:00
## Related
- [`zsh-better-npm-completion`](https://github.com/lukechilds/zsh-better-npm-completion) - Better completion for `npm`
2016-07-09 04:21:04 +08:00
## License
MIT © Luke Childs