get-node

Download a specific version of Node.js.

This is cached: if the output directory already has a node executable, no download will be performed.

Works on Linux/Mac/Windows.

Example

# Download Node.js latest release
$ get-node
/home/user/.cache/nve/12.10.0/node

$ /home/user/.cache/nve/12.10.0/node
Welcome to Node.js v12.10.0.
Type ".help" for more information.
> .exit

# Download a specific Node.js release
$ get-node 8
/home/user/.cache/nve/8.16.1/node

$ /home/user/.cache/nve/8.16.1/node
> process.version
'v8.16.1'
> .exit

# Any version range can be used
$ get-node 8.12.0
$ get-node '<7'

# Specify the output directory
$ get-node --output=/home/user/.cache/node_releases/ 8
/home/user/.cache/node_releases/8.16.1/node

$ /home/user/.cache/node_releases/8.16.1/node --version
v8.16.1

# Use a mirror website
$ get-node --mirror=https://npm.taobao.org/mirrors/node 8
/home/user/.cache/nve/8.16.1/node

Install

npm install get-node

node >=8.12.0 must already be installed.

Usage (CLI)

get-node [OPTIONS] [VERSION]

VERSION can be any version range such as 12, 12.6.0 or <12.

Options

--output

Alias: -o
Type: string
Default: global cache directory such as /home/user/.cache/nve/.

Output directory for the node executable.

--progress

Alias: -p
Type: boolean
Default: true

Whether to show a progress spinner.

--mirror

Alias: -m
Type: string
Default: https://nodejs.org/dist

Base URL. Can be overridden (for example https://npm.taobao.org/mirrors/node).

The following environment variables can also be used: NODE_MIRROR, NVM_NODEJS_ORG_MIRROR, N_NODE_MIRROR or NODIST_NODE_MIRROR.

Usage (JavaScript)

const getNode = require('get-node')

const options = {}
const { path, version } = await getNode('12', options)
console.log(path) // /home/user/.cache/nve/12.10.0/node
console.log(version) // 12.10.0

getNode(version, options?)

version: string
options: object
Return value: Promise<object>

options has the same members as the CLI options: output, progress, mirror

The returned Promise resolves to an object with the following properties:

path

Type: string

Absolute path to the node executable.

version

Type: string

Normalized Node.js version.

See also

• nve: Run a specific Node.js version
• normalize-node-version: Normalize and validate Node.js versions
• all-node-versions: List all available Node.js versions
• fetch-node-website: Fetch releases on nodejs.org

Support

If you found a bug or would like a new feature, don't hesitate to submit an issue on GitHub.

For other questions, feel free to chat with us on Gitter.

Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.

Contributing

This project was made with ❤️. The simplest way to give back is by starring and sharing it online.

If the documentation is unclear or has a typo, please click on the page's Edit button (pencil icon) and suggest a correction.

If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!

ehmicky 💻 🎨 🤔 📖

Changelog

4.0.0

Breaking changes

• The output directory is now specified as an --output flag instead of a positional argument on the CLI. This means get-node VERSION OUTPUT should now be get-node --output=OUTPUT VERSION.

Features

• Add --help and --version CLI flags
• Add --progress CLI flag
• Add --mirror option
• Improve CLI spinner

Bugs

• Fix error messages not printed correctly (50128cd)