1
0
mirror of https://github.com/nvm-sh/nvm.git synced 2026-10-24 15:23:42 +08:00
Commit Graph

204 Commits

Author SHA1 Message Date
Curt J. Sampson
b16fb6ece9 [readme] Docker: build time is "several" minutes, not 8
On my system, even without using local mirrors, the build is only two
minutes, even though I have only a 1 Gbps Internet connection and I'm
half-way across the world in Tokyo.

There probably are still users with much slower Internet connections
where the build could take eight minutes or more, but "several" still
covers that.
2025-09-15 18:06:37 +09:00
Curt J. Sampson
190cb9458b [readme] Docker: Just say "Ubuntu" (no version) for base image
The base image is updated regularly (it's currently 22.04), and it's
easy to forget to update this readme, so best we simply not repeat
ourselves and instead let people look at `Dockerfile` to see exactly
which version of Ubuntu it's using.
2025-09-15 08:20:51 +00:00
Jordan Harband
ee4fa818d2 [Docs] document nvm reinstall-packages as a standalone command
The standalone `nvm reinstall-packages <version>`
command can migrate global npm packages between already-installed versions,
but it was only mentioned in `nvm --help`, not in the README.
Add a section covering it.

Refs #3858
2026-06-29 14:51:15 -05:00
Jordan Harband
a6ec739430 [Docs] document current and clarify .nvmrc fallback in help/README
- Help text for `nvm install`/`use`/`exec`/`run`/`which` now ends with
  "Uses .nvmrc if version is omitted; otherwise errors."
  so it's clear that omitting the version is not a free fallback.
- Help signatures for `use`/`exec`/`run` now show `[current | <version>]`
  to mirror `nvm which` and document that `current` is accepted.
- `nvm current` description now spells out that it resolves via `$PATH`
  and is not affected by `.nvmrc`.
- README: add `current` to the list of special aliases, with the same caveat.
  The `.nvmrc` section now states that `nvm use`/`install`/`which`
  exit with status 127 when neither a version nor an `.nvmrc` resolves,
  notes the (current) `exec`/`run` fallback as undefined behavior,
  and points readers at `current` for the explicit "active node" use case.

Refs #3755
2026-06-10 15:16:24 -07:00
Jordan Harband
1889911f08 v0.40.5 2026-06-04 09:33:05 -07:00
Mozi
3e4b0f05b7 [readme] do not use tilde expansion in ENV of Dockerfile
It won't expand. my bad.
2026-04-11 00:34:20 -04:00
Mozi
001ea8cac1 [readme] use tilde expansion instead of "$HOME" for consistency
at least in this code block.
2026-03-05 15:06:38 -05:00
Mozi
b0f82ac1b2 [readme] use "$HOME" instead of hardcoded "/home/user"
For now, only "test/fast/Unit tests/nvm_change_path" uses "/home/user".
2026-03-05 05:42:57 -05:00
Peter Dave Hello
59d4ea8f3e [Docs] Clean up wording in docs and shell comments
Adjust a few spelling, grammar, and naming inconsistencies in the docs and related shell comments without changing behavior.
2026-03-23 23:48:23 +08:00
Hemant Mann
82e3803e93 [readme] Revise Node.js version usage examples 2026-03-14 18:08:20 +05:30
Jordan Harband
ae31eceecc [meta] run npm run doctoc 2026-03-24 11:50:40 -07:00
Jordan Harband
59bd32be6b [New] nvm install --offline: install from cache without network access
Add `--offline` flag to `nvm install` that resolves versions using only locally installed versions and cached downloads. No network calls are made.

New helper functions `nvm_ls_cached` and `nvm_offline_version` scan `$NVM_DIR/.cache/bin/` for previously downloaded tarballs.
In offline mode, `nvm_download_artifact` returns cached tarballs directly without checksum verification or download attempts.
The curl/wget requirement is skipped when `--offline` is set.
Supports `--lts` via locally stored LTS alias files.
2026-03-13 16:13:19 -04:00
Jordan Harband
62387b8f92 v0.40.4 2026-01-29 14:12:03 -08:00
Jordan Harband
4c3edc5e56 [actions] migrate Travis CI tests to GitHub Actions 2026-01-27 10:31:07 -08:00
Shay Molcho
0509776196 [readme] add missing colon
Inserted missing colons in specific parts of the text to maintain consistency with the existing format. This adjustment ensures a uniform writing style, improves readability, and aligns the text structure with the rest of the document.
2025-01-28 08:28:41 +02:00
Sylvain Lesage
0fbe3a6776 [readme] add background on io.js 2025-08-20 09:58:31 -04:00
Noritaka Kobayashi
4d364c2e7b [readme] fix typo 2025-10-18 10:28:48 +09:00
Wei Zhang
c3d674f8f9 [readme] update installation by docker to v0.40.3 2025-06-06 17:13:54 +08:00
Jordan Harband
977563e97d v0.40.3 2025-04-23 16:34:31 -07:00
Jordan Harband
ffec9fec72 v0.40.2
New Stuff
 - `install.sh`: add `$ZDOTDIR` to zsh search (#3458)

Fixes
 - `reinstall-packages`: do not reinstall corepack (#3544)
 - avoid bash-specific syntax (#3499)
 - `install-latest-npm`: npm v11 is out
 - `nvm_install_latest_npm`: avoid unbound variable (#3447)
 - give a more helpful message when `lts` alias is mistakenly used (#3441)
 - `nvm ls`, `nvm alias`, `nvm install`: error when an LTS name is invalid
 - `nvm_normalize_lts`: error when an LTS name is not lowercase (#3417)

Documentation
 - [readme] update link
 - [readme] fix `--no-use` example (#3479)
 - [readme] update copyright notice (#3507)
 - [readme] note zsh-nvm's AUTO_USE option (#2670)
 - [readme] add note about reloading zshrc after editing (#3052)
 - [readme] Update shell profile file install notes (#2241)
 - [readme] add docker tips (#2318)
 - [readme] remove `avn` from readme (#3469)
 - [readme] fnm -> nvm.fish (#2541)

Refactors
 - prefer `case` over if/else chains
 - combine `sed -e` invocations/arguments

Tests
 - `nvm exec`/`nvm run`: add `--silent` tests (#1259)
 - [actions] release test needs git tags
 - migrate `installation_iojs` test suite to GitHub Actions (#3476)
 - Migrate slow test suite from Travis CI (#3470)
 - temporarily skip this failing travis test to unblock progress
 - [actions] TOC: use latest LTS node
 - `install.sh`: clean up `nvm_detect_profile` tests
 - `nvm_detect_profile`: refactor (#3467)
 - run urchin tests on pull requests (#3466)
 - update mocks
 - ensure that unit tests use only mocked LTS names
 - [actions] use `node/install` instead of `node/run`

Meta
 - disable blank issues
 - update issue template
 - add DCO (#3456)
 - Rename .github/ISSUE_TEMPLATE.md to .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md (#3454)
2025-03-11 13:39:40 -07:00
Jordan Harband
8dbc22f0e9 [readme] update link 2025-03-11 12:46:19 -07:00
Jordan Harband
5c12680a62 [Dev Deps] update markdown-link-check 2025-03-11 12:43:42 -07:00
Jérémy GAU
247ed8a186 [readme] fix --no-use example 2024-11-28 20:33:25 +01:00
Chris de Almeida
d90a7910db [readme] update copyright notice 2025-01-10 14:41:50 -06:00
Andy Gimblett
8c30ac633b [readme] note zsh-nvm's AUTO_USE option 2021-12-01 14:55:38 +00:00
Nicola Lanzoni
ecdc865a5a [readme] add note about reloading zshrc after editing 2023-03-09 09:39:55 -03:00
Asad Akbar
9bcbbef4eb [readme] Update shell profile file install notes
* Adds a note for how to fix the issue when the install script is not   updating the correct profile file.
2020-06-19 16:36:09 -07:00
Björn Holm
b77fcec399 [readme] add docker tips
- covers installation using BASH_ENV

Co-authored-by: Christopher Dieringer <cdaringe@users.noreply.github.com>
Co-authored-by: Björn Holm <blollle@gmail.com>
2022-11-14 00:16:13 +01:00
Andrew Chang-DeWitt
287d535f2c [readme] remove avn from readme
`avn` is archived ([see repo](https://github.com/direnv/direnv)) and should probably no longer be recommended by nvm.

This also adds a solution using `direnv` and proposes a possible `.envrc` to use.
See [wbyoung/avn#109](https://github.com/wbyoung/avn/issues/109#issuecomment-1281865585) for more suggested `.envrc` files.
2024-11-13 14:41:39 -06:00
Kid
572c757f6d [readme] fnm -> nvm.fish 2021-07-18 18:32:40 +08:00
Jordan Harband
179d45050b v0.40.1 2024-08-27 13:44:15 -07:00
Jordan Harband
deac4e0932 v0.40.0 2024-07-30 12:50:18 -07:00
Jordan Harband
24deac7ac5 [readme] add OpenJS Ecosystem Sustainability Program partner
- https://openjsf.org/ecosystem-sustainability-program
2024-07-30 10:08:48 -07:00
David Welch
bd090ef7f8 [New] Add support for NVM_AUTH_HEADER env var
Closes #3366

Co-authored-by: David Welch <david@davidwelch.co>
Co-authored-by: Andre Kradolfer <narfdre@gmail.com>
2024-06-21 08:55:22 -06:00
Jordan Harband
29dce5edfd [New] allow .nvmrc files to support comments
In theory, `npx nvmrc` can now be used to validate an `.nvmrc` file that `nvm` will support. Allowances have been made for future extensibility, and aliases may no longer contain a `#`.

Fixes #3336. Closes #2288.

Co-authored-by: Jordan Harband <ljharb@gmail.com>
Co-authored-by: Yash Singh <saiansh2525@gmail.com>
2024-06-07 10:13:00 -07:00
Jordan Harband
95081f0bc2 [readme] update CII badge URLs 2024-06-06 14:19:11 -07:00
Huy Z
294ff9e3aa [readme] Fix uninstall instructions
`nvm unload` will unset NVM_DIR. So gotta save NVM_DIR first.
2024-02-13 03:39:07 -08:00
Jordi Paris Ferrer
c82e7a6f62 Fix typo in WSL section of README
`u` -> `you`
2024-02-17 16:39:36 -08:00
jbidad
4e2a71ba9b [Docs] add nvm unload to uninstall nvm instructions 2024-01-18 12:07:01 +03:30
Jordan Harband
bab86d5de5 v0.39.7 2023-12-05 21:50:27 -08:00
Jordan Harband
c73009f503 v0.39.6 2023-12-04 22:03:25 -08:00
Ben Wiley
7aee54b76c [readme] reorganize “deeper shell integration” instructions 2017-06-29 14:23:03 -04:00
Chris Meyers
6262b5a666 [readme] rearrange install args 2023-10-23 21:48:11 -06:00
Ellet
925cff2c78 [readme] update M1 to “Apple Silicon” because of M2 and M3; fix typos 2023-12-01 05:56:48 +03:00
Hao Cheng
064f2597d1 [readme] fix level of headings 2023-11-12 14:18:39 +01:00
Justin Dhillon
fd412645ca [readme] add section on bare nvm install 2023-10-23 10:25:26 -07:00
Michael Di Prisco
8a83b36688 [readme] missing parenthesis 2023-10-06 02:36:26 +02:00
Jordan Harband
c92adb3c47 v0.39.5 2023-08-21 21:10:10 -07:00
heungjun.park
a1601eddb8 [readme] add examples of setting specific versions as default
Co-authored-by: heungjun.park <rockheung@gmail.com>
Co-authored-by: Jordan Harband <ljharb@gmail.com>
2023-07-20 17:39:37 +09:00
Jordan Harband
8fbf8ab694 v0.39.4 2023-07-24 18:29:54 -07:00