npmpackage.info

npm-run-path

Get your PATH prepended with locally installed binaries

6.0.0

104

MIT

JavaScript

629.00 B

11,983,656,290 4.4

Installations

npm install npm-run-path

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=18

Node Version

18.20.4

NPM Version

10.6.0 Pull Requests

Open

0

Total

20

Closed

3

Merged

17

Issues

Open

0

Total

3

Closed

3

Releases

v6.0.0

Updated on Aug 26, 2024

v5.3.0

Updated on Feb 23, 2024

v5.2.0

Updated on Dec 21, 2023

v5.1.0

Updated on Feb 09, 2022

v5.0.1

Updated on Oct 05, 2021

v5.0.0

Updated on Oct 05, 2021

View All 10 releases

Contributors

Unable to fetch Contributors

View All 7 Contributors

Languages

JavaScript

TypeScript

JavaScript (79.42%)

TypeScript (20.58%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

sindresorhus

Download Statistics

Total Downloads

11,983,656,290

Last Day

3,577,555

Last Week

59,223,350

Last Month

286,486,587

Last Year

3,311,175,580

GitHub Statistics

MIT License

104 Stars

43 Commits

12 Forks

6 Watchers

1 Branches

7 Contributors

Updated on Oct 28, 2024

Bundle Size

1.18 kB

Minified

629.00 B

Minified + Gzipped

Bundlephobia

Sponsor this package

https://github.com/sponsors/sindresorhus

Maintainers

Package Meta Information

Latest Version

6.0.0

Package Id

npm-run-path@6.0.0

Unpacked Size

8.44 kB

Size

2.94 kB

File Count

NPM Version

10.6.0

Node Version

18.20.4

Published on

Aug 26, 2024

Total Downloads

Cumulative downloads

Total Downloads

11,983,656,290

Last Day

-6.1%

3,577,555

Compared to previous day

Last Week

-17.2%

59,223,350

Compared to previous week

Last Month

-5.2%

286,486,587

Compared to previous month

Last Year

17.7%

3,311,175,580

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

path-key unicorn-magic

Dev Dependencies

ava tsd xo

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

1npm install npm-run-path

Usage

1import childProcess from 'node:child_process';
2import {npmRunPath, npmRunPathEnv} from 'npm-run-path';
3
4console.log(process.env.PATH);
5//=> '/usr/local/bin'
6
7console.log(npmRunPath());
8//=> '/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'
9
10// `foo` is a locally installed binary
11childProcess.execFileSync('foo', {
12	env: npmRunPathEnv()
13});

API

npmRunPath(options?)

options: Options
Returns: string

Returns the augmented PATH string.

npmRunPathEnv(options?)

options: Options
Returns: object

Returns the augmented process.env object.

options

Type: object

cwd

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

The working directory.

execPath

Type: string | URL
Default: process.execPath

The path to the current Node.js executable.

This can be either an absolute path or a path relative to the cwd option.

addExecPath

Type: boolean
Default: true

Whether to push the current Node.js executable's directory (execPath option) to the front of PATH.

preferLocal

Type: boolean
Default: true

Whether to push the locally installed binaries' directory to the front of PATH.

path

Type: string
Default: PATH

The PATH to be appended.

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

Only available with npmRunPath(), not npmRunPathEnv().

env

Type: object
Default: process.env

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.

Only available with npmRunPathEnv(), not npmRunPath().

npm-run-path-cli - CLI for this module
execa - Execute a locally installed binary

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.4

/10

Last Scanned on 2025-03-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to npm-run-path

npm-path

2.0.4

Get a PATH with all executables available to npm scripts.

npm-which

3.0.1

Locate a program or locally installed node module's executable

@esm2cjs/npm-run-path

5.1.1-cjs.0

Get your PATH prepended with locally installed binaries. This is a fork of sindresorhus/npm-run-path, but with CommonJS support.

npm-run-path-compat

2.0.3

Get your PATH prepended with locally installed binaries

npm-run-path

Installations

Developer Guide

Yes

ESM

>=18

18.20.4

10.6.0

Pull Requests

0

20

3

17

Issues

0

3

3

Releases

Contributors

Unable to fetch Contributors

Languages

validate.email 🚀

Developer

sindresorhus

Download Statistics

GitHub Statistics

Bundle Size

1.18 kB

629.00 B

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

11,983,656,290

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

npm-run-path

Install

Usage

API

npmRunPath(options?)

npmRunPathEnv(options?)

options

cwd

execPath

addExecPath

preferLocal

path

env

Related

10

10

10

10

10

4

0

0

0

0

0

0

0

4.4

/10

Other packages similar to npm-run-path