从 npm install 迁移到 bun install · 文档

bun install 是一个快速且兼容 Node.js 的 npm 客户端。

要从 npm install 迁移到 bun install，请改用 bun install，不要再使用 npm install。

为 Node.js 和 Bun 设计：bun install 会安装一个兼容 Node.js 的 node_modules 文件夹。你可以在 Node.js 项目中直接替代 npm install 使用，无需修改任何代码，也无需使用 Bun 的运行时。
自动将 package-lock.json 转换为 Bun 的 bun.lock 锁文件格式，并保留现有已解析的依赖版本。你可以在工作中悄悄使用 bun install 替代 npm install，而不会被任何人察觉。
兼容 .npmrc：bun install 会从 npm 的 .npmrc 中读取 npm registry 配置，因此 npm 和 Bun 可以使用相同的配置。
硬链接：在 Windows 和 Linux 上，bun install 使用硬链接来节省磁盘空间并加快安装速度。

terminal

# 迁移只需一条命令
bun i

# 添加依赖：
bun i @types/bun

# 添加开发依赖：
bun i -d @types/bun

# 移除依赖：
bun rm @types/bun

更快地运行 package.json 脚本

使用单个命令运行 package.json 中的脚本、node_modules/.bin 中的可执行文件（如 npx），以及 JavaScript/TypeScript 文件（如 node）。

NPM	Bun
`npm run <script>`	`bun <script>`
`npm exec <bin>`	`bun <bin>`
`node <file>`	`bun <file>`
`npx <package>`	`bunx <package>`

bun run <executable> 使用本地安装的可执行文件。

terminal

# 运行 package.json 脚本：
bun my-script
bun run my-script

# 运行 node_modules/.bin 中的可执行程序：
bun my-executable # 例如 tsc，esbuild 等
bun run my-executable

# 运行一个 JavaScript/TypeScript 文件：
bun ./index.ts

支持工作区（Workspaces）

bun install 支持类似 npm 的工作区功能，并且提供更多特性。

在 package.json 中，将 "workspaces" 设置为相对路径数组。

package.json

{
  "name": "my-app",
  "workspaces": ["packages/*", "apps/*"]
}

按工作区名称筛选脚本

在 Bun 中，--filter 标志接受一个 glob 模式，并按照依赖顺序，为每个名称与其匹配的工作区包并发运行命令。

terminal

bun --filter 'lib-*' my-script
# 替代以下写法：
# npm run --workspace lib-foo --workspace lib-bar my-script

更新依赖

bun update <package> 将依赖更新到满足 package.json 中 semver 范围的最新版本。

terminal

# 更新单个依赖
bun update @types/bun

# 更新所有依赖
bun update

# 忽略 semver 范围，更新到最新版本
bun update @types/bun --latest

# 更新依赖到指定版本
bun update @types/bun@1.3.3

# 更新所有依赖到最新版本
bun update --latest

查看过期依赖

要查看过期依赖，请运行 bun outdated。它的工作方式类似于 npm outdated，但输出更加紧凑。

terminal

bun outdated

Text

┌────────────────────────────────────────┬─────────┬────────┬────────┐
│ Package                                │ Current │ Update │ Latest │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @types/bun (dev)                       │ 1.1.6   │ 1.1.10 │ 1.1.10 │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @types/react (dev)                     │ 18.3.3  │ 18.3.8 │ 18.3.8  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @typescript-eslint/eslint-plugin (dev) │ 7.16.1  │ 7.18.0 │ 8.6.0  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @typescript-eslint/parser (dev)        │ 7.16.1  │ 7.18.0 │ 8.6.0  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @vscode/debugadapter (dev)             │ 1.66.0  │ 1.67.0 │ 1.67.0 │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ esbuild (dev)                          │ 0.21.5  │ 0.21.5 │ 0.24.0 │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ eslint (dev)                           │ 9.7.0   │ 9.11.0 │ 9.11.0 │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ mitata (dev)                           │ 0.1.11  │ 0.1.14 │ 1.0.2  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ prettier-plugin-organize-imports (dev) │ 4.0.0   │ 4.1.0  │ 4.1.0  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ source-map-js (dev)                    │ 1.2.0   │ 1.2.1  │ 1.2.1  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ typescript (dev)                       │ 5.5.3   │ 5.6.2  │ 5.6.2  │
└────────────────────────────────────────┴─────────┴────────┴────────┘

列出已安装的包

bun pm ls 列出 node_modules 文件夹中安装的软件包，并使用 Bun 的锁文件作为真实来源。传递 -a 标志还可以列出传递依赖项。

terminal

# 列出顶级已安装的包：
bun pm ls

Text

my-pkg node_modules (781 installed)
├── @types/node@20.16.5
├── @types/react@18.3.8
├── @types/react-dom@18.3.0
├── eslint@8.57.1
├── eslint-config-next@14.2.8
...

terminal

# 列出所有已安装的包：
bun pm ls -a

Text

my-pkg node_modules
├── @alloc/quick-lru@5.2.0
├── @isaacs/cliui@8.0.2
│   └── strip-ansi@7.1.0
│       └── ansi-regex@6.1.0
├── @jridgewell/gen-mapping@0.3.5
├── @jridgewell/resolve-uri@3.1.2
...

创建包的压缩包

bun pm pack 会在当前目录中创建包的 tarball。

terminal

# 创建一个 tarball
bun pm pack

Text

Total files: 46
Shasum: 2ee19b6f0c6b001358449ca0eadead703f326216
Integrity: sha512-ZV0lzWTEkGAMz[...]Gl4f8lA9sl97g==
Unpacked size: 0.41MB
Packed size: 117.50KB

Shebang

如果软件包在 #!/usr/bin/env node shebang 中引用了 node，bun run 默认会遵循该设置并使用系统的 node 可执行文件。若要强制使用 Bun，请将 --bun 传递给 bun run。

传递 --bun 时，Bun 会在临时目录中创建一个名为 "node"、指向本地安装的 Bun 可执行文件的符号链接，并在脚本运行期间将其添加到 PATH 中。

terminal

# 强制使用 Bun 运行时而非 node
bun --bun my-script

# 以下用法同样有效：
bun run --bun my-script

全局安装

使用 bun i -g <package> 全局安装软件包。默认情况下，它们会安装到主目录下的 .bun/install/global/node_modules 文件夹中。

terminal

# 全局安装一个包
bun i -g eslint

# 运行全局安装的包，无需 `bun run` 前缀
eslint --init