{"id":15007644,"url":"https://github.com/ehmicky/nvexeca","last_synced_at":"2025-04-05T18:07:01.976Z","repository":{"id":40571879,"uuid":"219198261","full_name":"ehmicky/nvexeca","owner":"ehmicky","description":"nvm + execa = nvexeca","archived":false,"fork":false,"pushed_at":"2025-03-29T03:48:59.000Z","size":11576,"stargazers_count":43,"open_issues_count":0,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-30T14:01:59.281Z","etag":null,"topics":["bash","cli","command-line","dependency-management","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-11-02T18:44:11.000Z","updated_at":"2025-03-29T03:49:03.000Z","dependencies_parsed_at":"2024-07-13T21:45:40.843Z","dependency_job_id":"fe384ee2-ca48-4ae9-93ba-654ff643d676","html_url":"https://github.com/ehmicky/nvexeca","commit_stats":{"total_commits":726,"total_committers":3,"mean_commits":242.0,"dds":"0.016528925619834656","last_synced_commit":"12db9259051ab50fb4e138eb475e45ad78bdbe3c"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fnvexeca","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fnvexeca/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fnvexeca/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fnvexeca/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/nvexeca/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247378141,"owners_count":20929296,"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":["bash","cli","command-line","dependency-management","es6","exec","javascript","library","node","nodejs","npmjs","npx","nvm","operating-system","package-manager","shell","terminal","typescript","versioning","versions"],"created_at":"2024-09-24T19:13:02.577Z","updated_at":"2025-04-05T18:07:01.953Z","avatar_url":"https://github.com/ehmicky.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/ehmicky/design/main/nve/nve_dark.svg\"/\u003e\n  \u003cimg alt=\"nvexeca logo\" src=\"https://raw.githubusercontent.com/ehmicky/design/main/nve/nve.svg\" width=\"500\"/\u003e\n\u003c/picture\u003e\n\n[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js\u0026colorA=404040\u0026logoColor=66cc33)](https://www.npmjs.com/package/nvexeca)\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/nvexeca)\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\nnvm + execa = nvexeca.\n\n[Execa](https://github.com/sindresorhus/execa) improves\n[child processes](https://nodejs.org/api/child_process.html) execution with a\npromise interface, cross-platform support, local binaries, interleaved output,\n[and more](https://github.com/sindresorhus/execa#features).\n\nnvexeca is a thin wrapper around Execa to run any file or command using any\nNode.js version.\n\nUnlike [`nvm exec`](https://github.com/nvm-sh/nvm/blob/master/README.md#usage)\nit:\n\n- is run programmatically\n- does not need a separate installation step for each Node version\n- can run the major release's latest minor/patch version automatically\n- does not require Bash\n- is installed as a Node module\n- works on Windows. No need to run as Administrator.\n\n`nvexeca` executes a **single file or command**. It does not change the `node`\nnor `npm` global binaries. To run a specific Node.js version for an **entire\nproject or shell session**, please use [`nvm`](https://github.com/nvm-sh/nvm),\n[`nvm-windows`](https://github.com/coreybutler/nvm-windows),\n[`n`](https://github.com/tj/n) or [`nvs`](https://github.com/jasongin/nvs)\ninstead.\n\n# Example\n\n```js\nimport nvexeca from 'nvexeca'\n\nconst { childProcess, versionRange, version } = await nvexeca('8', 'node', [\n  '--version',\n])\nconsole.log(`Node ${versionRange} (${version})`) // Node 8 (8.16.2)\nconst { exitCode, stdout, stderr } = await childProcess\nconsole.log(`Exit code: ${exitCode}`) // 0\nconsole.log(stdout) // v8.16.2\n```\n\n# Install\n\n```bash\nnpm install nvexeca\n```\n\n`node \u003e=18.18.0` must be installed. However the command run by `nvexeca` can use\nany Node version (providing it is compatible with it).\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 as a CLI instead, please check\n[`nve`](https://github.com/ehmicky/nve).\n\n# Usage\n\n## nvexeca(versionRange, command, args?, options?)\n\nExecutes `command ...args` with a specific Node.js `versionRange`.\n\n### Arguments\n\n#### versionRange\n\n_Type_: `string`\n\nThis 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#### command\n\n_Type_: `string`\n\nFile or command to execute. Both global and local binaries can be executed.\n\nMust be compatible with the specific Node `versionRange`. For example `npm` is\n[only compatible with Node `\u003e=6`](https://github.com/npm/cli#important).\n\n#### args\n\n_Type_: `string[]?`\n\nArguments to pass to the [`command`](#command).\n\n### Options\n\n_Type_: `object?`\n\nAll Execa options are available. Please refer to Execa for the list of\n[possible options](https://github.com/sindresorhus/execa/blob/main/docs/api.md#options).\n\nThe\n[`preferLocal` option](https://github.com/sindresorhus/execa/blob/main/docs/api.md#optionspreferlocal)\nis always `true`.\n\nThe following options are also available.\n\n#### dry\n\n_Type_: `boolean`\\\n_Default_: `false`\n\nDo not execute the command. This can be used to cache the initial Node.js binary\ndownload.\n\n#### progress\n\n_Type_: `boolean`\\\n_Default_: `false`\n\nWhether to show a progress bar when the Node binary is downloading.\n\n#### mirror\n\n_Type_: `string`\\\n_Default_: `https://nodejs.org/dist`\n\nBase URL to retrieve Node binaries. Can be overridden (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_: `process.cwd()`\n\nCurrent working directory of the child process.\n\nWhen using the [`local` alias](#nvexecaversionrange-command-args-options), this\nalso starts looking for a Node.js version file from this directory.\n\n### Return value\n\n_Type_: `Promise\u003cobject\u003e`\n\n`Promise` resolved after the Node.js version has been cached locally (if it has\nnot been cached yet).\n\nIf you want to wait for the `command` to complete as well, you should `await`\nthe returned `childProcess`.\n\n```js\nconst { childProcess } = await nvexeca('8', 'node', ['--version'])\nconst { exitCode, stdout, stderr } = await childProcess\n```\n\n#### childProcess\n\n_Type_:\n[`ResultPromise?`](https://github.com/sindresorhus/execa/blob/main/docs/api.md#return-value)\n\n[`childProcess` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess).\nIt is also a `Promise` resolving or rejecting with a\n[`Result`](https://github.com/sindresorhus/execa/blob/main/docs/api.md#result).\nThe `Promise` should be awaited if you want to wait for the process to complete.\n\nThis is `undefined` when the [`dry`](#dry) option is `true`.\n\n#### versionRange\n\n_Type_: `string`\n\nNode.js version passed as input, such as `\"v10\"`.\n\n#### version\n\n_Type_: `string`\n\nNormalized Node.js version. For example if `\"v10\"` was passed as input,\n`version` will be `\"10.17.0\"`.\n\n#### command\n\n_Type_: `string`\n\nFile or command that was executed.\n\n#### args\n\n_Type_: `string[]`\n\nArguments that were passed to the `command`.\n\n#### execaOptions\n\n_Type_: `object`\n\n[Options](https://github.com/sindresorhus/execa/blob/main/docs/api.md#options)\nthat were passed to [Execa](https://github.com/sindresorhus/execa).\n\n## Initial download\n\nThe first time `nvexeca` is run with a new `VERSION`, the Node binary is\ndownloaded under the hood. This initially takes few seconds. However subsequent\nruns are almost instantaneous.\n\n## Native modules\n\nIf your code is using native modules, `nvexeca` works providing:\n\n- they are built with [N-API](https://nodejs.org/api/n-api.html)\n- the target Node.js version is `\u003e=8.12.0` (since N-API was not available or\n  stable before that)\n\nOtherwise the following error message is shown:\n`Error: The module was compiled against a different Node.js version`.\n\n# See also\n\n- [`nve`](https://github.com/ehmicky/nve): `nvexeca` as a CLI\n- [`execa`](https://github.com/sindresorhus/execa): Process execution for humans\n- [`get-node`](https://github.com/ehmicky/get-node): Download Node.js\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\n\u003c!-- Thanks go to our wonderful contributors: --\u003e\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/nvexeca/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/nvexeca/commits?author=ehmicky\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/nicolas-goudry\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/8753998?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eNicolas Goudry\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/nvexeca/commits?author=nicolas-goudry\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/papb\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/20914054?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ePedro Augusto de Paula Barbosa\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#question-papb\" title=\"Answering Questions\"\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%2Fnvexeca","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Fnvexeca","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fnvexeca/lists"}