Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

npm-run-path

Package Overview
Dependencies
1
Maintainers
1
Versions
11
Issues
File Explorer

Advanced tools

npm-run-path

Get your PATH prepended with locally installed binaries

    5.1.0latest

Version published
Maintainers
1
Weekly downloads
42,798,980
decreased by-2.88%

Weekly downloads

Changelog

Source

  • Allow cwd option to be a URL (#15) fd16028

https://github.com/sindresorhus/npm-run-path/compare/v5.0.1...v5.1.0

Readme

Source

npm-run-path

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

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() });

API

npmRunPath(options?)

Returns the augmented PATH string.

options

Type: object

cwd

Type: string | URL
Default: process.cwd()

The working directory.

path

Type: string
Default: PATH

The PATH to be appended.

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

execPath

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.

npmRunPathEnv(options?)

Returns the augmented process.env object.

options

Type: object

cwd

Type: string | URL
Default: process.cwd()

The 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

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 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.

Keywords

FAQs

What is npm-run-path?

Get your PATH prepended with locally installed binaries

Is npm-run-path popular?

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.

Is npm-run-path well maintained?

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.

Last updated on 09 Feb 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc