bun CLI 包含一个 Node.js 兼容的包管理器，旨在成为 npm、yarn 和 pnpm 的速度大幅提升的替代品。它是一个独立的工具，可以在预先存在的 Node.js 项目中使用；如果你的项目有 package.json，bun install 可以帮助你加速工作流程。
⚡️ 速度提升 25 倍 — 在任何 Node.js 项目中从 npm install 切换到 bun install，即可使安装速度提升高达 25 倍。
对于 Linux 用户
安装项目的所有依赖项
bun install运行 bun install 将会
- 安装所有
dependencies、devDependencies和optionalDependencies。Bun 默认会安装peerDependencies。 - 运行你的项目的
{pre|post}install和{pre|post}prepare脚本（在适当的时候）。出于安全原因，Bun *不执行*已安装依赖项的生命周期脚本。 - 写入一个
bun.lock锁文件到项目根目录。
日志记录
要修改日志记录详细程度
bun install --verbose # debug loggingbun install --silent # no logging生命周期脚本
与其他 npm 客户端不同，Bun 不会为已安装的依赖项执行任意生命周期脚本，例如 postinstall。执行任意脚本代表潜在的安全风险。
要告知 Bun 允许特定包的生命周期脚本，请将该包添加到你的 package.json 中的 trustedDependencies。
{
"name": "my-app",
"version": "1.0.0",
"trustedDependencies": ["my-trusted-package"]
}然后重新安装该包。Bun 将读取此字段并为 my-trusted-package 运行生命周期脚本。
生命周期脚本将在安装期间并行运行。要调整并发脚本的最大数量，请使用 --concurrent-scripts 标志。默认值是报告的 CPU 核心数的两倍或 GOMAXPROCS。
bun install --concurrent-scripts 5工作区
Bun 支持 package.json 中的 "workspaces"。有关完整文档，请参阅 包管理器 > 工作区。
{
"name": "my-app",
"version": "1.0.0",
"workspaces": ["packages/*"],
"dependencies": {
"preact": "^10.5.13"
}
}
为特定包安装依赖项
在 monorepo 中，你可以使用 --filter 标志为包的子集安装依赖项。
# Install dependencies for all workspaces except `pkg-c`bun install --filter '!pkg-c'
# Install dependencies for only `pkg-a` in `./packages/pkg-a`bun install --filter './packages/pkg-a'有关使用 bun install 进行过滤的更多信息，请参阅 包管理器 > 过滤
覆盖和解析
Bun 支持 npm 的 "overrides" 和 Yarn 的 "resolutions" 在 package.json 中。这些是用于指定元依赖（你的依赖项的依赖项）的版本范围的机制。有关完整文档，请参阅 包管理器 > 覆盖和解析。
{
"name": "my-app",
"dependencies": {
"foo": "^2.0.0"
},
"overrides": {
"bar": "~4.4.0"
}
}全局包
要全局安装包，请使用 -g/--global 标志。通常，这用于安装命令行工具。
bun install --global cowsay # or `bun install -g cowsay`cowsay "Bun!" ______
< Bun! >
------
\ ^__^
\ (oo)\_______
(__)\ )\/\
||----w |
|| ||生产模式
要在生产模式下安装（即不包含 devDependencies 或 optionalDependencies）
bun install --production为了实现可重现的安装，请使用 --frozen-lockfile。这将安装 lockfile 中指定的每个包的确切版本。如果你的 package.json 与 bun.lock 不一致，Bun 将退出并显示错误。lockfile 将不会被更新。
bun install --frozen-lockfile有关 Bun 的 lockfile bun.lock 的更多信息，请参阅 包管理器 > Lockfile。
省略依赖项
要省略 dev、peer 或 optional 依赖项，请使用 --omit 标志。
# Exclude "devDependencies" from the installation. This will apply to the
# root package and workspaces if they exist. Transitive dependencies will
# not have "devDependencies".bun install --omit dev
# Install only dependencies from "dependencies"bun install --omit=dev --omit=peer --omit=optionalDry run（空跑）
要执行 dry run（即不实际安装任何内容）
bun install --dry-run非 npm 依赖项
Bun 支持从 Git、GitHub 和本地或远程托管的 tarball 安装依赖项。有关完整文档，请参阅 包管理器 > Git、GitHub 和 tarball 依赖项。
{
"dependencies": {
"dayjs": "git+https://github.com/iamkun/dayjs.git",
"lodash": "git+ssh://github.com/lodash/lodash.git#4.17.21",
"moment": "git@github.com:moment/moment.git",
"zod": "github:colinhacks/zod",
"react": "https://registry.npmjs.org/react/-/react-18.2.0.tgz",
"bun-types": "npm:@types/bun"
}
}
配置
bun install 的默认行为可以在 bunfig.toml 中配置。默认值如下所示。
[install]
# whether to install optionalDependencies
optional = true
# whether to install devDependencies
dev = true
# whether to install peerDependencies
peer = true
# equivalent to `--production` flag
production = false
# equivalent to `--save-text-lockfile` flag
saveTextLockfile = false
# equivalent to `--frozen-lockfile` flag
frozenLockfile = false
# equivalent to `--dry-run` flag
dryRun = false
# equivalent to `--concurrent-scripts` flag
concurrentScripts = 16 # (cpu count or GOMAXPROCS) x2
CI/CD
想要加速你的 CI 吗？使用官方的 oven-sh/setup-bun action 在 GitHub Actions pipeline 中安装 bun。
name: bun-types
jobs:
build:
name: build-app
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Install bun
uses: oven-sh/setup-bun@v2
- name: Install dependencies
run: bun install
- name: Build app
run: bun run build