Get-node NPM | npm.io

Download a specific version of Node.js.

The Node.js release is downloaded, uncompressed and untared to an executable file ready to run.

Hire me

Please reach out if you're looking for a Node.js API or CLI engineer (11 years of experience). Most recently I have been Netlify Build's and Netlify Plugins' technical lead for 2.5 years. I am available for full-time remote positions.

Features

Fast:

the download is cached
the best compression algorithm available on your machine is used
everything is streamed

Reliable:

the binary is checked against official checksums
can be safely run concurrently
atomic writes

Features include:

Linux/Mac/Windows support
works with old Node.js versions
progress bar
using version ranges
specifying a mirror website for nodejs.org
helpful error messages
can guess the current project's version using its .nvmrc or package.json (engines.node field)

Example

import getNode from 'get-node'

// Download a specific Node.js release
const { path, version } = await getNode('8')
console.log(path) // /home/user/.cache/nve/8.17.0/node
console.log(version) // 8.17.0

// Download Node.js latest release
const { path, version } = await getNode('latest')
console.log(path) // /home/user/.cache/nve/16.3.0/node
console.log(version) // 16.3.0

// Any version range can be used
await getNode('8.12.0')
await getNode('<7')

// Download latest LTS Node.js version
await getNode('lts')

// Download Node.js version from `~/.nvmrc` or the current process version
await getNode('global')

// Download current directory's Node.js version using its `.nvmrc` or
// `package.json` (`engines.node` field)
await getNode('local')

// Download Node.js version from a specific file like `.nvmrc` or `package.json`
await getNode('/path/to/.nvmrc')

// Specify the output directory
const { path } = await getNode('8', {
  output: '/home/user/.cache/node_releases/',
})
console.log(path) // /home/user/.cache/node_releases/13.0.1/node

// Use a mirror website
await getNode('8', { mirror: 'https://npmmirror.com/mirrors/node' })

// Specify the CPU architecture
await getNode('8', { arch: 'x32' })

Install

npm install get-node

node >=18.18.0 must be globally installed. However any Node version can be downloaded.

This package is an ES module and must be loaded using an import or import() statement, not require(). If TypeScript is used, it must be configured to output ES modules, not CommonJS.

To use this module as a CLI instead, please check get-node-cli.

Usage

getNode(versionRange, options?)

versionRange: string\ options: object?\ Return value: Promise<object>

versionRange can be:

any version range such as 12, 12.6.0 or <12
latest: Latest available Node version
lts: Latest LTS Node version
global: Global Node version
- Using the home directory .nvmrc or package.json (engines.node field)
- Some similar files used by other Node.js version managers are also searched for
- If nothing is found, defaults to the current process's Node version
local: Current directory's Node version
- Using the current directory or parent directories .nvmrc, package.json (engines.node field) or similar files
- Defaults to the global version
a file path towards a .nvmrc, package.json (engines.node field) or similar files