Nonchalantly Perusing Magazines
    Wondering what’s next for npm?Check out our public roadmap! »

    npm-run-path
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.1 • Public • Published

    npm-run-path Build Status

    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.

    Install

    $ npm install npm-run-path
    

    Usage

    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?)

    Returns the augmented path string.

    options

    Type: object

    cwd

    Type: string
    Default: process.cwd()

    Working directory.

    path

    Type: string
    Default: PATH

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

    execPath

    Type: string
    Default: process.execPath

    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.

    npmRunPath.env(options?)

    Returns the augmented process.env object.

    options

    Type: object

    cwd

    Type: string
    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. Use this if you're modifying the PATH for use in the child_process options.

    execPath

    Type: string
    Default: process.execPath

    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.

    Related


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i npm-run-path

    DownloadsWeekly Downloads

    29,869,241

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    8.13 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar