Commit Graph

148 Commits (ea3b65f02e27165e74cfe69ee4b6b1684af2f89c)

Author SHA1 Message Date
Arshath 0fad5ec575
[readme] quote asterisk in shell command on `--latest-npm` example 2021-02-05 19:45:26 +05:30
Matt Calthrop 49e806c77a
[readme] Add macOS troubleshooting instructions for M1 chip 2021-01-21 20:45:12 +00:00
hjoshi123 6982dee071
[Docs]: Updated README.md to include homebrew unsecure dirs warning
Closes #2361.
2020-12-22 17:29:32 +05:30
Shiming 10399ed1bd
[Docs] source `./nvm.sh` instead of `nvm.sh`, for `zsh`
Fixes #2204.
2020-04-27 16:11:09 +08:00
Jordan Harband 4b947ec92d
v0.37.2 2020-11-27 21:34:28 -08:00
Jordan Harband 661a702cdd
v0.37.1 2020-11-24 21:16:43 -08:00
Dena Burd 6848c16d53
[New] Added `set-colors` command. See details below:
This command allows users to replace default colors with their own custom colors.

 - top-level commands modified: alias, ls, ls-remote
 - helper functions added: nvm_echo_with_colors, nvm_err_with_colors,
nvm_set_colors, nvm_get_colors, nvm_print_color_code
 - functions modified: nvm_print_formatted_alias, nvm_print_versions, nvm_print_alias_path (implicitly), nvm_print_default_alias (implicitly), nvm_list_aliases (implicitly)

We added tests and info on using this command to the README!

Co-authored-by: Dena Burd <29719099+gitburd@users.noreply.github.com>
Co-authored-by: Naomi Quinones <52065567+naomiquinones@users.noreply.github.com>
2020-08-17 14:56:13 -07:00
Jordan Harband 4054bd70ce
v0.37.0 2020-11-06 10:11:29 -08:00
Matthieu Bosquet 344cc32ac3
[readme] bash shell integration: Amended example to call cd when booting a terminal (previously only called on cd).
It means that works with for example VS Code's integrated terminal.
2020-10-05 17:30:03 +01:00
Jordan Harband 8debf39f24
v0.36.0 2020-09-23 16:18:37 -07:00
Saikat Das 22e07cc0c1
[readme] fix LTS upgrade command
Edited the LTS upgrade scenario command to fix the issue discussed in #2271
2020-08-27 19:27:29 +05:30
Jordan Harband 035bf9e28e
[readme] update autocompletion output examples 2020-08-23 23:29:48 -07:00
Steve Lee 19c55b9936
[readme] Mention problem with windows cmd echo 2020-08-11 18:39:32 +01:00
Dimitris Karagiannis a01deb11dc
[patch] Update docs and add warning for 'nvm is not compatible with the npm config "prefix" option' edgecase error on Mac OS 2020-08-03 10:04:20 -07:00
Saikat Das 18c6f98acc
[readme] Add documentation for LTS updates which reinstall existing packages
Added an example for LTS updates that also reinstall the existing packages.
This is useful for individuals who run the latest LTS version along with global packages and need to update when the LTS version gets bumped
2020-07-28 19:31:30 +05:30
Bram Wubs f6d11bae41
[readme] Fix fish load_nvm function 2020-07-07 08:29:00 +02:00
Marcus Kazmierczak d2d232ea2b
[readme] Update macOS troubleshooting w/ 10.15 zsh default
The default shell for macOS 10.15 is now zsh, by default a .zshrc file
is not created, so switch instruction for touch ~/.zshrc
2020-06-24 11:02:01 -07:00
Connor Leech 7b3af45cf7
[readme] Update install instructions troubleshooting
This is in response to a popular stack overflow answer that has helped people resolve the "command not found" hiccup: https://stackoverflow.com/a/17707224/2031033

Also mentioned here: https://github.com/nvm-sh/nvm/issues/748
2020-05-25 07:36:40 -07:00
Peter Dave Hello bac5393e12
[Docs] Syntax highlight for Ansible task example in README.md 2020-05-29 21:01:47 +08:00
Szymon Dzialowski 2d4e877b61
[readme] Stop removing spaces from nvm_path
It breaks switching version of node through nvm in directories with space somewhere in it's path.
2020-06-10 18:28:14 +01:00
Bruce A. MacNaughton 33fa27dabe
[Docs] Update README for environment variables 2020-02-07 12:01:57 -08:00
Jared Ramirez dcc8059ef8
[readme] include deeper integration instructions for fish 2020-04-29 15:25:23 -07:00
Jordan Harband 258938ef66
v0.35.3 2020-03-05 23:13:56 -08:00
flip111 8093dbeacd
[readme] add nvm intro
Closes #2149.
2020-01-23 20:32:07 +01:00
Jordan Harband a1ad32e9cb
[readme] restore broken anchor 2020-01-11 18:15:20 -08:00
nebbles d8785da988
[Docs] Improve readme clarity and troubleshooting
Clean up readme structure a bit to help with readability. fix
instructions which could lead to a sourcing loop if misinterpreted.
guidance should direct macos users to simply copy the source snippet
manually into their desired profile file.

Resolve #2123
2019-11-17 14:52:52 +00:00
Lucian Buzzo 4ff9084e99
[Docs] Fix small typo in README 2019-12-05 10:07:38 +00:00
Jordan Harband f355b327d6
v0.35.2 2019-12-17 22:40:20 -08:00
awthwathje 04ad1b528c
[readme] Fix a typo 2019-11-08 10:24:16 +01:00
Jordan Harband 28bc2fd991
v0.35.1 2019-11-03 10:03:31 -08:00
Marit Iren 1eca354233
[Docs] Add description if instructions don't work; make install instructions more readable 2019-10-20 17:08:29 +02:00
Jordan Harband 011810e721
v0.35.0 2019-10-02 00:05:28 -04:00
Darío Hereñú d48abff659
[Docs] clean up formatting in readme 2019-05-03 19:44:21 -03:00
Darío Hereñú 82037b41b1
[Docs] clean up a bit 2017-10-06 01:54:07 -03:00
metasean 970cadf258
[Docs] Add `--latest-npm` info to Migrating global packages section
Adds the following information to the "Migrating global packages while installing" section:
- notification that the npm package is explicitly not updated when using the --reinstall-packages-from flag
- information about the --latest-npm flag
- recovery instructions if a user has already updated node with an incompatible npm version
2018-12-30 18:24:29 -07:00
Will Papper 3cc9525dce
[Docs] [Fix] Set $NVM_DIR to ".nvm" instead of "nvm"
- Operating system and version: Mac OS X Mojave

- What happened? $NVM_DIR was set to nvm

- What did you expect to happen? $NVM_DIR should be set to .nvm
I added the following line from the README to my .zshrc:
```
export NVM_DIR="${XDG_CONFIG_HOME/:-$HOME/.}nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
```

I couldn't figure out why nvm wasn't loading, until I realized that
`echo NVM_DIR="${XDG_CONFIG_HOME/:-$HOME/.}nvm"` outputs `NVM_DIR=nvm`.

Changing the line to `export NVM_DIR="${XDG_CONFIG_HOME/:-$HOME/}.nvm"` fixed the problem. This outputs `NVM_DIR=.nvm` as expected. I tested this and the same behavior holds true in Bash as well.
2019-04-24 00:03:01 -07:00
Greg Smith 6537c91eb5
Fix bash auto-use nvm command
It was trying to read ./.nvmrc if you cd'ed into a subdirectory of the directory that has .nvmrc, which would give print `-bash: ./.nvmrc: No such file or directory` to stderr and potentially not doing the `nvm install`.
2019-08-09 14:38:37 -06:00
Alfred Myers 3664744e3b
Updated note about Windows
There's a lot of old info around the interwebs.
Much stating nvm doesn't work in WSL.
2019-05-02 12:20:17 -03:00
Jordan Harband e7a5b7992b
[meta] update repo links to point to org 2019-04-24 16:08:34 -07:00
Daniel Li ff77ac17af
[Docs] update `bash` `cdnvm` script to properly handle aliases
- Only works for common aliases like `default`, `system`, `node`, `lts/*`, `iojs` etc.
 - Prevent unnecessary running of `nvm use`
2019-03-12 16:43:08 +00:00
Eric Lewis 1ede50cbae
[Docs] Add note about what version of node new shells run with.
Fixes #2000
2019-02-22 10:04:13 -05:00
Christopher Sahnwaldt 930507dbbc
[Docs] README.md: mention --no-colors option 2019-02-23 09:53:56 +01:00
Jarvis Mercer - Amir Mohammad Safari (AMSL) 41eb40821b
[Docs] add “update” terminology to installation section 2019-01-26 01:00:43 +03:30
jjangga0214 890fbb5581
Update README: sync node release schedule url 2019-02-15 11:11:01 +09:00
Waldir Pimenta 13f3cdcdf7
README: clarify how to specify default packages 2019-01-11 10:42:33 +00:00
Jordan Harband 3d9c31d944
v0.34.0 2019-01-07 23:01:16 -08:00
Javier Infante 5e065ec026 [Docs] fixing cdnvm on .bashrc 2018-12-31 08:42:58 +01:00
Jordan Harband deb2a9b821
[Docs] fix eclint 2018-12-19 15:36:24 -08:00
Joel Parker Henderson fb83eeb140
[Docs] Add Ansible task example
Add Ansible task example to show how to install nvm and update it.

Ansible is a systems administration tool.
See https://github.com/ansible/ansible

My personal experience of `nvm` is that installing via Ansible is good, and that a good example can help. This example took me about an hour to learn, so I'm hoping to save other people some time. This example is somewhat different than any others that I found on the web. There may be a better way to write it, and if so, please improve it.
2018-12-19 12:45:59 -08:00
Peter Dave Hello f3fd5eff46
[Docs] Improve md file syntax
- Lists should be surrounded by blank lines
- Use only `1.` for ordered list item prefix
- Starting bulleted lists at the beginning of the line
- Fenced code blocks should be surrounded by blank lines
2018-07-15 02:26:05 +08:00
Kayla Altepeter 423252a99c
[docs] update README to fix docker run command flag order 2018-10-18 22:30:05 -05:00
Ole Johan Andersen 2a294ebd61
[Docs] improve instructions for manual install 2018-10-24 19:49:55 +02:00
Daniel Li e06f735776
Improve Bash alias
This will take into account nested directories inside your main project
directory
2018-07-26 16:13:07 +01:00
Daniel Li 355c4c7915
[Docs] Add section on automatic `nvm use` in Bash 2018-07-15 19:08:15 +01:00
Fábio Antunes 217a5bb0de
[Docs] Added fish nvm 2018-10-21 23:31:20 -07:00
et304383 2d97ce5f7b
[Docs] add instructions for installing a specific version 2018-08-27 11:50:48 -03:00
Erik Lilja 8542df4ac5
[New] add support for `$XDG_CONFIG_HOME` 2018-08-14 21:45:40 +02:00
JBallin 41dc4218b9 [Docs] add --no-use option to installation 2018-06-17 21:31:56 -07:00
SrHuevo d08d8607f5
fix for .nvmrc script 2018-05-30 09:02:29 +02:00
Jay Williams e7b53a01fd
Grammar update 2018-05-26 23:17:08 +01:00
Siddharth Sakhadeo b81c120e0c fix failing if check in autoload script 2018-05-25 15:33:42 -07:00
Josh Sleeper 04c27e23fe
add --tags to git fetch in manual upgrade
facilitates older `git` fetching tags so that it can actually upgrade properly
2018-04-25 14:55:31 -07:00
Jordan Harband 93990ab7da
v0.33.11 2018-04-25 13:25:35 -07:00
Jordan Harband 177a9673a7
v0.33.10 2018-04-24 22:08:51 -07:00
Jordan Harband 1b14e6b4d9
v0.33.9 2018-04-14 22:38:18 -07:00
Peter Dave Hello d9dc8464fd
[Doc] Add macOS install script note about Git
Closes #1782
2018-04-13 01:14:39 +08:00
Peter Dave Hello 8ff437ae51
[Doc] Fix manual install & upgrade guide, fix #1772 2018-04-12 23:58:30 +08:00
Ed Reel 663bddee9b
[docs] Add removal instructions to README.md
Closes #1767.
2018-04-09 10:36:54 -05:00
Guy Lepage bc87d3dd1c
removed global install on README.md. closes #1773 2018-04-04 19:03:03 -04:00
Peter Dave Hello 2850e65b62
[Docs] Fix some typos 2018-03-03 21:18:42 +08:00
Josh Soref 2859a19bbd
[Docs] fix spelling 2018-03-06 04:38:01 +00:00
Peter Dave Hello 750571056c
[Fix] Correct most of the wrong indentation 2018-02-26 02:20:21 +08:00
Peter Dave Hello 9f34b3e95c Remove trailing space 2018-02-26 01:03:01 +08:00
Peter Dave Hello 225e447b54 [Doc] Update Docker image build info in README.md 2018-02-19 00:27:04 +08:00
Christoph Krautz 74f455e610 [Docs] Add reminder that NVM_DIR should not contain trailing slash, fix for #1708 2018-02-09 11:51:46 +01:00
Karthik K f5b5f2d41d
[copyright] year to 2010 obsoleting future updations 2018-01-26 12:20:13 +05:30
Yannick Ihmels 7ca8acc98d
[Docs] [Tests] Add escape sequences; add test for aliased `.` 2018-01-13 21:25:30 +01:00
Jordan Harband 3e81904525
Update minimum git version to v1.17.10
Per https://github.com/creationix/nvm/pull/1704#discussion_r161366186
2018-01-12 23:24:56 -08:00
p-salido 9273f23bc8
[Docs] Explain `.nvmrc` better 2017-11-23 23:09:44 -05:00
Jordan Harband 7ad6d98ced
v0.33.8 2017-12-12 10:43:17 -08:00
Jordan Harband 65f0572bdc
v0.33.7
Fixes
 - fix unassigned variable (#1665, #1664)
 - Fix for $path used by zsh (#1669)
 - `set -u`: ensure `NVM_USE_OUTPUT` is always set (#1671)
 - `install.sh`: Fix a bug that block that installation of node in install.sh (#1676)
 - `nvm install-latest-npm`: fix node 4-4.6

Documentation
 - Make `nvm cache clear` message less ambiguous (#1644)
 - Added missing piece (#1658)
2017-12-08 21:21:42 -08:00
David Gatti a7b7eec0c5
[Docs] Added missing piece
This sentence broke my brain when I read it the first time :) I hope this helps.
2017-11-08 01:02:15 +01:00
Jordan Harband b546436113
v0.33.6 2017-10-23 23:53:26 -07:00
Darío Hereñú 016bc134d5 Typo 2017-10-23 02:23:04 -03:00
Christopher Beland a954458829
[Docs] Improve git installation instructions 2017-10-18 10:39:11 -04:00
Jordan Harband 6597e11971
v0.33.5 2017-09-29 12:50:27 -04:00
Peter Dave Hello 7753b24948
[Docs] Update README.md for Alpine linux reference
Add 4 packages as Alpine Linux wiki suggested:
(grep util-linux binutils findutils)

https://wiki.alpinelinux.org/wiki/How_to_get_regular_stuff_working
2017-09-07 18:00:08 +08:00
Jordan Harband d91b6197f3
v0.33.4 2017-09-04 22:59:50 -07:00
Jordan Harband 6f19babbff
v0.33.3 2017-09-03 12:46:59 -07:00
GeekBlogTV b3bdbb2712
[Docs] updated to reflect current script output 2017-07-08 01:31:13 -05:00
Mike Ferrari 6921adb2f4
[Docs] add note about Linux troubleshooting 2017-06-26 12:22:34 -07:00
Peter Dave Hello f37ddea78f
[Docs] Fix typos in Docker instructions 2017-07-08 18:50:06 +08:00
Peter Dave Hello 3ac49e5ef1
[New] Introduce Docker environment for nvm 2017-04-02 08:03:32 +08:00
Shiva Bhusal d2644b22f9 [Docs] Install script - Improve installation guide
If installation is prompted to be successful, yet `which nvm` command returns `not found` then you might need to restart your terminal instance. Try opening a new tab/window in your terminal and retry.
2017-06-03 11:49:33 +05:45
Jordan Harband 3497474fef [Docs] move the install script to the top; put the notes in a separate section. 2017-05-26 21:09:59 -07:00
Weston Ganger 7f3145bc98
[New] add support for `$NVM_DIR/default-packages` file 2017-03-28 09:37:14 -07:00
Jordan Harband 0a95e77000
v0.33.2 2017-04-26 00:50:33 -07:00
Piper Chester 964c7b3115
[Docs] README.markdown → README.md 2017-04-08 09:19:15 -07:00