sindresorhus

npm-run-path

	PATH to be appended. Default: [`PATH`](https://github.com/sindresorhus/path-key).

	Set it to an empty string to exclude the default PATH.

	Path to the Node.js executable to use in child processes if that is different from the current one. Its directory is pushed to the front of PATH.

	This can be either an absolute path or a path relative to the `cwd` option.

export type ProcessEnv = Record<string, string | undefined>;

	Accepts an object of environment variables, like `process.env`, and modifies the PATH using the correct [PATH key](https://github.com/sindresorhus/path-key). Use this if you're modifying the PATH for use in the `child_process` options.

	The path to the current Node.js executable. Its directory is pushed to the front of PATH.

Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries.

import childProcess from 'node:child_process';

//=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin'

export function npmRunPath(options?: RunPathOptions): string;

@returns The augmented [`process.env`](https://nodejs.org/api/process.html#process_process_env) object.

import {npmRunPathEnv} from 'npm-run-path';

export function npmRunPathEnv(options?: EnvOptions): ProcessEnv;

export function npmRunPath(options = {}) {

	const cwdString = cwd instanceof URL ? url.fileURLToPath(cwd) : cwd;

		result.push(path.join(cwdPath, 'node_modules/.bin'));

	// Ensure the running `node` binary is used.

	result.push(path.resolve(cwd, execPath, '..'));

	result.push(path.resolve(cwdString, execPath, '..'));

	return [...result, path_].join(path.delimiter);

export function npmRunPathEnv({env = process.env, ...options} = {}) {

	"description": "Get your PATH prepended with locally installed binaries",

	"repository": "sindresorhus/npm-run-path",

	"funding": "https://github.com/sponsors/sindresorhus",

		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"

> Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries

In [npm run scripts](https://docs.npmjs.com/cli/run-script) you can execute locally installed binaries by name. This enables the same outside npm.

import {npmRunPath, npmRunPathEnv} from 'npm-run-path';

Default: [`PATH`](https://github.com/sindresorhus/path-key)

Set it to an empty string to exclude the default PATH.

The path to the current Node.js executable. Its directory is pushed to the front of PATH.

This can be either an absolute path or a path relative to the [`cwd` option](#cwd).

Returns the augmented [`process.env`](https://nodejs.org/api/process.html#process_process_env) object.

Accepts an object of environment variables, like `process.env`, and modifies the PATH using the correct [PATH key](https://github.com/sindresorhus/path-key). Use this if you're modifying the PATH for use in the `child_process` options.

The path to the Node.js executable to use in child processes if that is different from the current one. Its directory is pushed to the front of PATH.

- [npm-run-path-cli](https://github.com/sindresorhus/npm-run-path-cli) - CLI for this module

- [execa](https://github.com/sindresorhus/execa) - Execute a locally installed binary

		<a href="https://tidelift.com/subscription/pkg/npm-npm-run-path?utm_source=npm-npm-run-path&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>

		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.

		@@ -7,3 +7,3 @@ export interface RunPathOptions {
		*/
		readonly cwd?: string;
		readonly cwd?: string \| URL;

		@@ -35,3 +35,3 @@ /**
		*/
		readonly cwd?: string;
		readonly cwd?: string \| URL;

		@@ -38,0 +38,0 @@ /**

		import process from 'node:process';
		import path from 'node:path';
		import url from 'node:url';
		import pathKey from 'path-key';
		@@ -13,3 +14,4 @@
		let previous;
		let cwdPath = path.resolve(cwd);
		const cwdString = cwd instanceof URL ? url.fileURLToPath(cwd) : cwd;
		let cwdPath = path.resolve(cwdString);
		const result = [];
		@@ -24,3 +26,3 @@
		// Ensure the running `node` binary is used.
		result.push(path.resolve(cwd, execPath, '..'));
		result.push(path.resolve(cwdString, execPath, '..'));

		@@ -27,0 +29,0 @@ return [...result, path_].join(path.delimiter);

		{
		"name": "npm-run-path",
		"version": "5.0.1",
		"version": "5.1.0",
		"description": "Get your PATH prepended with locally installed binaries",
		@@ -5,0 +5,0 @@ "license": "MIT",

		@@ -43,3 +43,3 @@ # npm-run-path

		Type: `string`\
		Type: `string \| URL`\
		Default: `process.cwd()`
		@@ -77,3 +77,3 @@

		Type: `string`\
		Type: `string \| URL`\
		Default: `process.cwd()`
		@@ -80,0 +80,0 @@

Improved metrics