# npm-run-path 中文文档

规范地址：https://npmcn.com/package/npm-run-path/

版本：6\.0\.0
npm 元数据更新时间：2024-08-26T08:40:09.963Z
中文译文更新时间：2026-11-04T20:15:48.917Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/npm-run-path
原文对照：https://npmcn.com/package/npm-run-path/?lang=original
项目主页：https://github.com/sindresorhus/npm-run-path#readme
源码仓库：https://github.com/sindresorhus/npm-run-path

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.6 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：2 个
- 首次发布：2015-12-28T18:54:14.293Z
- 最新版本发布：2024-08-26T08:40:09.814Z
- 近 30 天下载量：641006612（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

在PATH前面加上本地安装的二进制文件

## 安装

```sh
npm install npm-run-path
```

也可以使用：`pnpm add npm-run-path`、`yarn add npm-run-path`、`bun add npm-run-path`

## README

# npm-run-path

> 让你的 [路径](https://en.wikipedia.org/wiki/PATH_\(variable\)) 加上本地安装的二进制文件

在 [NPM运行脚本](https://docs.npmjs.com/cli/run-script) 您可以按名称执行本地安装的二进制文件。这会在npm外部启用相同的功能。

## 安装

```sh
npm install npm-run-path
```

## 用法

```js
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`： [`Options`](https://npmcn.com/package/npm-run-path/#readme-options)  
_返回_： `string`

返回扩增的PATH字符串。

### npmRunPathEnv(选项?)

`options`： [`Options`](https://npmcn.com/package/npm-run-path/#readme-options)  
_返回_： `object`

返回增广 [`process.env`](https://nodejs.org/api/process.html#process_process_env) 对象。

### 选项

类型: `object`

#### 慢性消耗病

类型: `string | URL`  
默认值: `process.cwd()`

工作目录。

#### execPath

类型: `string | URL`  
默认值: [`process.execPath`](https://nodejs.org/api/process.html#processexecpath)

当前Node.js可执行文件的路径。

可以是绝对路径，也可以是相对路径 [`cwd` 选项](https://npmcn.com/package/npm-run-path/#readme-cwd)。

#### addExecPath

类型: `boolean`  
默认值: `true`

是否推送当前Node.js可执行文件目录([`execPath`](https://npmcn.com/package/npm-run-path/#readme-execpath) 选项)到PATH的前面。

#### preferLocal

类型: `boolean`  
默认值: `true`

是否将本地安装的二进制文件目录推到PATH的前面。

#### 路径

类型: `string`  
默认值: [`PATH`](https://github.com/sindresorhus/path-key)

要追加的PATH。

将其设置为空字符串以排除默认的PATH。

仅适用于 [`npmRunPath()`](https://npmcn.com/package/npm-run-path/#readme-npmrunpathoptions),而不是 [`npmRunPathEnv()`](https://npmcn.com/package/npm-run-path/#readme-npmrunpathenvoptions)。

#### env

类型: `object`  
默认值: [`process.env`](https://nodejs.org/api/process.html#processenv)

接受环境变量的对象，如 `process.env`，并使用正确的方法修改PATH [关键路径](https://github.com/sindresorhus/path-key)． 如果要修改PATH以便在 `child_process` 选项。

仅适用于 [`npmRunPathEnv()`](https://npmcn.com/package/npm-run-path/#readme-npmrunpathenvoptions),而不是 [`npmRunPath()`](https://npmcn.com/package/npm-run-path/#readme-npmrunpathoptions)。

## 相关

-   [npm-run-path-cli](https://github.com/sindresorhus/npm-run-path-cli) —该模块的CLI
-   [execa](https://github.com/sindresorhus/execa) —执行本地安装的二进制文件

## 常见问题

### npm-run-path 是什么？

在PATH前面加上本地安装的二进制文件

### 如何安装 npm-run-path？

在项目目录运行 npm install npm-run-path，或使用 pnpm add / yarn add / bun add。

### npm-run-path 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### npm-run-path 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### npm-run-path 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### npm-run-path 可以商用吗？

npm-run-path 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### npm-run-path 的下载量有多少？

根据 npm 官方下载统计，npm-run-path 在 2026/10/05 – 2026/11/03 这 30 天内被下载 641,006,612 次，日均约 21,366,887 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### npm-run-path 还在维护吗？

最新版本 6\.0\.0 发布于 2024/08/26（2 年前）；至今共发布 14 个版本，其中过去 12 个月发布了 0 个；首次发布于 2015/12/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。