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

Document NVM_LAZY_LOAD option

Browse Source
This commit is contained in:
Luke Childs 2016-08-27 10:37:25 +01:00
parent dbd3183930
commit ffdfe46e33
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -54,6 +54,29 @@ 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 (experimental)
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.
## Installation
### Using [Antigen](https://github.com/zsh-users/antigen)