npm-run-path
Advanced tools
Get your PATH prepended with locally installed binaries
Weekly downloads
Changelog
cwd
option to be a URL
(#15) fd16028https://github.com/sindresorhus/npm-run-path/compare/v5.0.1...v5.1.0
Readme
Get your PATH prepended with locally installed binaries
In npm run scripts you can execute locally installed binaries by name. This enables the same outside npm.
npm install npm-run-path
import childProcess from 'node:child_process';
import {npmRunPath, npmRunPathEnv} from 'npm-run-path';
console.log(process.env.PATH);
//=> '/usr/local/bin'
console.log(npmRunPath());
//=> '/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'
// `foo` is a locally installed binary
childProcess.execFileSync('foo', {
env: npmRunPathEnv()
});
Returns the augmented PATH string.
Type: object
Type: string | URL
Default: process.cwd()
The working directory.
Type: string
Default: PATH
The PATH to be appended.
Set it to an empty string to exclude the default PATH.
Type: string
Default: process.execPath
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.
Returns the augmented process.env
object.
Type: object
Type: string | URL
Default: process.cwd()
The working directory.
Type: object
Accepts an object of environment variables, like process.env
, and modifies the PATH using the correct PATH key. Use this if you're modifying the PATH for use in the child_process
options.
Type: string
Default: process.execPath
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.
This can be either an absolute path or a path relative to the cwd
option.
Get your PATH prepended with locally installed binaries
The npm package npm-run-path receives a total of 34,784,841 weekly downloads. As such, npm-run-path popularity was classified as popular.
We found that npm-run-path demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.