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
const childProcess = require('child_process');
const npmRunPath = require('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: npmRunPath.env()
});
Returns the augmented path string.
Type: object
Type: string
Default: process.cwd()
Working directory.
Type: string
Default: PATH
PATH to be appended.
Set it to an empty string to exclude the default PATH.
Returns the augmented process.env
object.
Type: object
Type: string
Default: process.cwd()
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.
- npm-run-path-cli - CLI for this module
- execa - Execute a locally installed binary
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.