Skip to content

bun install 是一个与 Node.js 兼容的 npm 客户端,旨在成为 npm 的超快速替代品。

我们做了大量工作,确保从 npm installbun install 的迁移路径像运行 bun install 而不是 npm install 一样简单。

  • 专为 Node.js 和 Bun 设计bun install 安装与 Node.js 兼容的 node_modules 文件夹。你可以在 Node.js 项目中用它替代 npm install,无需任何代码更改,也无需使用 Bun 运行时。
  • 自动转换 package-lock.json:将 npm 的 package-lock.json 自动转换为 Bun 的 bun.lock 锁文件格式,保留你现有的已解析依赖版本,无需任何手动操作。你可以在工作中秘密地使用 bun install 替代 npm install,而不会有人注意到。
  • .npmrc 兼容:bun install 从 npm 的 .npmrc 读取 npm 注册表配置,因此你可以为 npm 和 Bun 使用相同的配置。
  • 硬链接:在 Windows 和 Linux 上,bun install 使用硬链接来节省磁盘空间和安装时间。
bash
# 迁移只需要一个命令
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 一样)——所有这些都可以通过一个简单的命令完成。

NPMBun
npm run <script>bun <script>
npm exec <bin>bun <bin>
node <file>bun <file>
npx <package>bunx <package>

当你使用 bun run <executable> 时,它会选择本地安装的可执行文件

sh
# 运行 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

工作空间?有的。

bun install 支持工作空间,类似于 npm,但具有更多功能。

在 package.json 中,你可以将 "workspaces" 设置为相对路径数组。

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

按工作空间名称过滤脚本

在 Bun 中,--filter 标志接受 glob 模式,并会为所有 name 匹配该模式的工作空间包并发运行命令,同时尊重依赖顺序。

sh
bun --filter 'lib-*' my-script
# 而不是:
# npm run --workspace lib-foo --workspace lib-bar my-script

更新依赖

要更新依赖,你可以使用 bun update <package>。这会将依赖更新到满足 package.json 中指定的 semver 范围的最新版本。

sh
# 更新单个依赖
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,但输出更紧凑。

sh
bun outdated
txt
┌────────────────────────────────────────┬─────────┬────────┬────────┐
│ 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。这将使用 Bun 的锁文件作为真实来源,列出 node_modules 文件夹中安装的所有包。你可以传递 -a 标志来列出所有已安装的包,包括传递依赖。

sh
# 列出顶层已安装的包:
bun pm ls
txt
my-pkg node_modules (781)
├── @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
...
sh
# 列出所有已安装的包:
bun pm ls -a
txt
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
...

创建包 tarball

要创建包 tarball,你可以使用 bun pm pack。这将在当前目录中创建包的 tarball。

sh
# 创建 tarball
bun pm pack
txt
Total files: 46
Shasum: 2ee19b6f0c6b001358449ca0eadead703f326216
Integrity: sha512-ZV0lzWTEkGAMz[...]Gl4f8lA9sl97g==
Unpacked size: 0.41MB
Packed size: 117.50KB

Shebang

如果包在 #!/usr/bin/env node shebang 中引用了 nodebun run 默认会尊重它并使用系统的 node 可执行文件。你可以通过向 bun run 传递 --bun 来强制它使用 Bun 的 node

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

sh
# 强制使用 Bun 运行时而不是 node
bun --bun my-script

# 这也适用:
bun run --bun my-script

全局安装

你可以使用 bun i -g <package> 全局安装包。默认情况下,这将安装到你主目录下的 .bun/install/global/node_modules 文件夹中。

sh
# 全局安装包
bun i -g eslint

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

Bun学习网由www.bunjs.com.cn整理维护