D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
lib
/
node_modules
/
npm
/
node_modules
/
npm-run-path
/
Filename :
readme.md
back
Copy
# npm-run-path [](https://travis-ci.org/sindresorhus/npm-run-path) > 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. ## Install ``` $ npm install --save npm-run-path ``` ## Usage ```js 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() }); ``` ## API ### npmRunPath([options]) #### options ##### cwd Type: `string`<br> Default: `process.cwd()` Working directory. ##### path Type: `string`<br> Default: [`PATH`](https://github.com/sindresorhus/path-key) PATH to be appended.<br> Set it to an empty string to exclude the default PATH. ### npmRunPath.env([options]) #### options ##### cwd Type: `string`<br> Default: `process.cwd()` Working directory. ##### env Type: `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. ## Related - [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 ## License MIT © [Sindre Sorhus](https://sindresorhus.com)