From fd412645ca7aed43937bf3018262e621b94908b1 Mon Sep 17 00:00:00 2001 From: Justin Dhillon Date: Mon, 23 Oct 2023 10:25:26 -0700 Subject: [PATCH] [readme] add section on bare `nvm install` --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae9b63c..de24075 100644 --- a/README.md +++ b/README.md @@ -542,7 +542,7 @@ $ echo "node" > .nvmrc # to default to the latest version [NB these examples assume a POSIX-compliant shell version of `echo`. If you use a Windows `cmd` development environment, eg the `.nvmrc` file is used to configure a remote Linux deployment, then keep in mind the `"`s will be copied leading to an invalid file. Remove them.] -Then when you run nvm: +Then when you run nvm use: ```sh $ nvm use @@ -550,6 +550,19 @@ Found '/path/to/project/.nvmrc' with version <5.9> Now using node v5.9.1 (npm v3.7.3) ``` +Running nvm install will also switch over to the correct version, but if the correct node version isn't already installed, it will install it for you. + +```sh +$ nvm install +Found '/path/to/project/.nvmrc' with version <5.9> +Downloading and installing node v5.9.1... +Downloading https://nodejs.org/dist/v5.9.1/node-v5.9.1-linux-x64.tar.xz... +#################################################################################### 100.0% +Computing checksum with sha256sum +Checksums matched! +Now using node v5.9.1 (npm v3.7.3) +``` + `nvm use` et. al. will traverse directory structure upwards from the current directory looking for the `.nvmrc` file. In other words, running `nvm use` et. al. in any subdirectory of a directory with an `.nvmrc` will result in that `.nvmrc` being utilized. The contents of a `.nvmrc` file **must** be the `` (as described by `nvm --help`) followed by a newline. No trailing spaces are allowed, and the trailing newline is required.