{"id":13825849,"url":"https://github.com/ehmicky/get-node","last_synced_at":"2025-03-16T03:07:26.041Z","repository":{"id":40558551,"uuid":"201292135","full_name":"ehmicky/get-node","owner":"ehmicky","description":"Download a specific version of Node.js","archived":false,"fork":false,"pushed_at":"2024-09-14T23:11:59.000Z","size":12511,"stargazers_count":20,"open_issues_count":0,"forks_count":9,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-19T12:11:13.513Z","etag":null,"topics":["cli","command-line","dependency-management","download","es6","exec","javascript","library","node","nodejs","npmjs","npx","nvm","operating-system","package-manager","shell","terminal","typescript","versioning","versions"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ehmicky.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-08T16:00:22.000Z","updated_at":"2024-09-14T23:12:02.000Z","dependencies_parsed_at":"2024-06-24T03:23:51.804Z","dependency_job_id":"27d86416-6fd5-444c-afe0-edd0b6bafa3a","html_url":"https://github.com/ehmicky/get-node","commit_stats":{"total_commits":1211,"total_committers":4,"mean_commits":302.75,"dds":"0.014037985136250986","last_synced_commit":"bef17dc3fd5281c8149dffe2ab628d9979fcbe41"},"previous_names":[],"tags_count":65,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fget-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fget-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fget-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fget-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/get-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243818200,"owners_count":20352629,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line","dependency-management","download","es6","exec","javascript","library","node","nodejs","npmjs","npx","nvm","operating-system","package-manager","shell","terminal","typescript","versioning","versions"],"created_at":"2024-08-04T09:01:27.997Z","updated_at":"2025-03-16T03:07:26.022Z","avatar_url":"https://github.com/ehmicky.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js\u0026colorA=404040\u0026logoColor=66cc33)](https://www.npmjs.com/package/get-node)\n[![TypeScript](https://img.shields.io/badge/-Typed-808080?logo=typescript\u0026colorA=404040\u0026logoColor=0096ff)](/src/main.d.ts)\n[![Codecov](https://img.shields.io/badge/-Tested%20100%25-808080?logo=codecov\u0026colorA=404040)](https://codecov.io/gh/ehmicky/get-node)\n[![Mastodon](https://img.shields.io/badge/-Mastodon-808080.svg?logo=mastodon\u0026colorA=404040\u0026logoColor=9590F9)](https://fosstodon.org/@ehmicky)\n[![Medium](https://img.shields.io/badge/-Medium-808080.svg?logo=medium\u0026colorA=404040)](https://medium.com/@ehmicky)\n\nDownload a specific version of Node.js.\n\nThe Node.js release is downloaded, uncompressed and untared to an executable\nfile ready to run.\n\n# Hire me\n\nPlease\n[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)\nif you're looking for a Node.js API or CLI engineer (11 years of experience).\nMost recently I have been [Netlify Build](https://github.com/netlify/build)'s\nand [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'\ntechnical lead for 2.5 years. I am available for full-time remote positions.\n\n# Features\n\nFast:\n\n- the download is cached\n- the best compression algorithm available on your machine is used\n- everything is streamed\n\nReliable:\n\n- the binary is checked against\n  [official checksums](https://github.com/nodejs/node#verifying-binaries)\n- can be safely run concurrently\n- atomic writes\n\nFeatures include:\n\n- Linux/Mac/Windows support\n- works with old Node.js versions\n- [progress bar](#progress)\n- using [version ranges](#getnodeversionrange-options)\n- specifying [a mirror website](#mirror) for nodejs.org\n- helpful error messages\n- can guess the current project's version using its\n  [`.nvmrc` or `package.json` (`engines.node` field)](#getnodeversionrange-options)\n\n# Example\n\n```js\nimport getNode from 'get-node'\n\n// Download a specific Node.js release\nconst { path, version } = await getNode('8')\nconsole.log(path) // /home/user/.cache/nve/8.17.0/node\nconsole.log(version) // 8.17.0\n```\n\n```js\n// Download Node.js latest release\nconst { path, version } = await getNode('latest')\nconsole.log(path) // /home/user/.cache/nve/16.3.0/node\nconsole.log(version) // 16.3.0\n```\n\n```js\n// Any version range can be used\nawait getNode('8.12.0')\nawait getNode('\u003c7')\n```\n\n```js\n// Download latest LTS Node.js version\nawait getNode('lts')\n```\n\n```js\n// Download Node.js version from `~/.nvmrc` or the current process version\nawait getNode('global')\n```\n\n```js\n// Download current directory's Node.js version using its `.nvmrc` or\n// `package.json` (`engines.node` field)\nawait getNode('local')\n```\n\n```js\n// Download Node.js version from a specific file like `.nvmrc` or `package.json`\nawait getNode('/path/to/.nvmrc')\n```\n\n```js\n// Specify the output directory\nconst { path } = await getNode('8', {\n  output: '/home/user/.cache/node_releases/',\n})\nconsole.log(path) // /home/user/.cache/node_releases/13.0.1/node\n```\n\n```js\n// Use a mirror website\nawait getNode('8', { mirror: 'https://npmmirror.com/mirrors/node' })\n```\n\n```js\n// Specify the CPU architecture\nawait getNode('8', { arch: 'x32' })\n```\n\n# Install\n\n```bash\nnpm install get-node\n```\n\n`node \u003e=18.18.0` must be globally installed. However any Node version can be\ndownloaded.\n\nThis package is an ES module and must be loaded using\n[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),\nnot `require()`. If TypeScript is used, it must be configured to\n[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),\nnot CommonJS.\n\nTo use this module as a CLI instead, please check\n[`get-node-cli`](https://github.com/ehmicky/get-node-cli).\n\n# Usage\n\n## getNode(versionRange, options?)\n\n`versionRange`: `string`\\\n`options`: `object?`\\\n_Return value_: `Promise\u003cobject\u003e`\n\n`versionRange` can be:\n\n- any [version range](https://github.com/npm/node-semver) such as `12`, `12.6.0`\n  or `\u003c12`\n- `latest`: Latest available Node version\n- `lts`: Latest LTS Node version\n- `global`: Global Node version\n  - Using the home directory [`.nvmrc`](https://github.com/nvm-sh/nvm#nvmrc) or\n    [`package.json` (`engines.node` field)](https://docs.npmjs.com/files/package.json#engines)\n  - [Some similar files](https://github.com/ehmicky/preferred-node-version/blob/main/README.md)\n    used by other Node.js version managers are also searched for\n  - If nothing is found, defaults to the current process's Node version\n- `local`: Current directory's Node version\n  - Using the current directory or parent directories\n    [`.nvmrc`](https://github.com/nvm-sh/nvm#nvmrc),\n    [`package.json` (`engines.node` field)](https://docs.npmjs.com/files/package.json#engines)\n    or\n    [similar files](https://github.com/ehmicky/preferred-node-version/blob/main/README.md)\n  - Defaults to the `global` version\n- a file path towards a [`.nvmrc`](https://github.com/nvm-sh/nvm#nvmrc),\n  [`package.json` (`engines.node` field)](https://docs.npmjs.com/files/package.json#engines)\n  or\n  [similar files](https://github.com/ehmicky/preferred-node-version/blob/main/README.md)\n\n### Options\n\n#### output\n\n_Type_: `string`\\\n_Default_: [global cache directory](https://github.com/ehmicky/global-cache-dir)\nsuch as `/home/user/.cache/nve/`.\n\nOutput directory for the `node` executable.\n\nIt the directory already has a `node` executable, no download is performed. This\nenables caching.\n\n#### progress\n\n_Type_: `boolean`\\\n_Default_: `false`\n\nWhether to show a progress bar.\n\n#### mirror\n\n_Type_: `string`\\\n_Default_: `https://nodejs.org/dist`\n\nBase URL to retrieve Node.js binaries. Can be customized (for example\n`https://npmmirror.com/mirrors/node`).\n\nThe following environment variables can also be used: `NODE_MIRROR`,\n`NVM_NODEJS_ORG_MIRROR`, `N_NODE_MIRROR` or `NODIST_NODE_MIRROR`.\n\n#### fetch\n\n_Type_: `boolean`\\\n_Default_: `undefined`\n\nThe list of available Node.js versions is cached for one hour by default. If the\n`fetch` option is:\n\n- `true`: the cache will not be used\n- `false`: the cache will be used even if it's older than one hour\n\n#### arch\n\n_Type_: `string`\\\n_Default_: [`process.arch`](https://nodejs.org/api/process.html#process_process_arch)\n\nNode.js binary's CPU architecture. This is useful for example when you're on x64\nbut would like to run Node.js x32.\n\nAll the values from\n[`process.arch`](https://nodejs.org/api/process.html#process_process_arch) are\nallowed except `mips` and `mipsel`.\n\n#### cwd\n\n_Type_: `string | URL`\\\n_Default_: `.`\n\nWhen using the [`local` alias](#getnodeversionrange-options), start looking for\na Node.js version file from this directory.\n\n#### signal\n\n_Type_:\n[`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)\n\nCancels when the signal is aborted.\n\n### Return value\n\nThe returned `Promise` resolves to an object with the following properties.\n\n#### path\n\n_Type_: `string`\n\nAbsolute path to the `node` executable.\n\n#### version\n\n_Type_: `string`\n\n[Normalized](https://github.com/ehmicky/normalize-node-version) Node.js version.\n\n# See also\n\n- [`get-node-cli`](https://github.com/ehmicky/get-node-cli): `get-node` as a CLI\n- [`nve`](https://github.com/ehmicky/nve): Run a specific Node.js version (CLI)\n- [`nvexeca`](https://github.com/ehmicky/nve): Run a specific Node.js version\n  (programmatic)\n- [`preferred-node-version`](https://github.com/ehmicky/preferred-node-version):\n  Get the preferred Node.js version of a project or user\n- [`node-version-alias`](https://github.com/ehmicky/node-version-alias): Resolve\n  Node.js version aliases like `latest`, `lts` or `erbium`\n- [`normalize-node-version`](https://github.com/ehmicky/normalize-node-version):\n  Normalize and validate Node.js versions\n- [`all-node-versions`](https://github.com/ehmicky/all-node-versions): List all\n  available Node.js versions\n- [`fetch-node-website`](https://github.com/ehmicky/fetch-node-website): Fetch\n  releases on nodejs.org\n- [`global-cache-dir`](https://github.com/ehmicky/global-cache-dir): Get the\n  global cache directory\n\n# Support\n\nFor any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).\n\nEveryone is welcome regardless of personal background. We enforce a\n[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and\ninclusive environment.\n\n# Contributing\n\nThis project was made with ❤️. The simplest way to give back is by starring and\nsharing it online.\n\nIf the documentation is unclear or has a typo, please click on the page's `Edit`\nbutton (pencil icon) and suggest a correction.\n\nIf you would like to help us fix a bug or add a new feature, please check our\n[guidelines](CONTRIBUTING.md). Pull requests are welcome!\n\nThanks go to our wonderful contributors:\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://fosstodon.org/@ehmicky\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/8136211?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eehmicky\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/get-node/commits?author=ehmicky\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#design-ehmicky\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#ideas-ehmicky\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/ehmicky/get-node/commits?author=ehmicky\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/tunnckocore\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/5038030?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eCharlike Mike Reagent\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/get-node/issues?q=author%3AtunnckoCore\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://instagram.com/private.number_\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1075694?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ehiroki osame\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/get-node/commits?author=privatenumber\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/ehmicky/get-node/commits?author=privatenumber\" title=\"Tests\"\u003e⚠️\u003c/a\u003e \u003ca href=\"#ideas-privatenumber\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fget-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Fget-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fget-node/lists"}