public/zsh-nvm
1
0
Fork 0
mirror of https://github.com/lukechilds/zsh-nvm.git synced 2025-01-30 09:47:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document NVM_AUTO_USE option

Browse Source
This commit is contained in:
Luke Childs 2017-01-05 17:56:32 +07:00
parent 37781594ea
commit 4ba1a04f09
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -92,6 +92,19 @@ export NVM_NO_USE=true
antigen bundle lukechilds/zsh-nvm
```
### Auto use
If you have lots of projects with an `.nvmrc` file you may find the auto use option helpful. If it's enabled, when you `cd` into a directory with an `.nvmrc` file, `zsh-nvm` will automatically load or install the required node version in `.nvmrc`. You can enable it by exporting the `NVM_AUTO_USE` environment variable and setting it to `true`. It must be set before `zsh-nvm` is loaded.
If you enable this option and don't have `nvm` loaded in the current session (`NVM_LAZY_LOAD` or `NVM_NO_USE`) it won't work until you've loaded `nvm`.
For example, if you are using antigen, you would put the following in your `.zshrc`:
```shell
export NVM_AUTO_USE=true
antigen bundle lukechilds/zsh-nvm
```
## Installation
### Using [Antigen](https://github.com/zsh-users/antigen)