Document NVM_NO_USE option

This commit is contained in:
Luke Childs 2016-10-04 20:51:08 +01:00
parent e379610cb9
commit 6e2fc22ff3

View File

@ -54,6 +54,19 @@ antigen bundle lukechilds/zsh-nvm
Note: If `nvm` doesn't exist in this directory it'll be automatically installed when you start a session. Note: If `nvm` doesn't exist in this directory it'll be automatically installed when you start a session.
### Manually load node
By default when `nvm` is loaded it'll automatically run `nvm use default` and load your default `node` version along with `npm` and any global modules. You can disable this behaviour by exporting the `NVM_NO_USE` environment variable and setting it to `true`. It must be set before `zsh-nvm` is loaded.
If you enable this option you will then need to manually run `nvm use <version>` before you can use `node`.
For example, if you are using antigen, you would put the following in your `.zshrc`:
```shell
export NVM_NO_USE=true
antigen bundle lukechilds/zsh-nvm
```
### Lazy Loading ### Lazy Loading
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`. It must be set before `zsh-nvm` is loaded. 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`. It must be set before `zsh-nvm` is loaded.