Bun

bun add

添加特定包

bun add preact

指定版本、版本范围或标签

bun add zod@3.20.0
bun add zod@^3.0.0
bun add zod@latest

--dev

别名--development, -d, -D

将包添加为开发依赖项 ("devDependencies")

bun add --dev @types/react
bun add -d @types/react

--optional

将包添加为可选依赖项 ("optionalDependencies")

bun add --optional lodash

--peer

要将软件包添加为对等依赖 ("peerDependencies")

bun add --peer @types/bun

--exact

别名-E

要添加软件包并锁定到已解析的版本,请使用 --exact。这将解析软件包的版本,并将其添加到您的 package.json 中,使用确切的版本号而不是版本范围。

bun add react --exact
bun add react -E

这会将以下内容添加到您的 package.json

{
  "dependencies": {
    // without --exact
    "react": "^18.2.0", // this matches >= 18.2.0 < 19.0.0

    // with --exact
    "react": "18.2.0" // this matches only 18.2.0 exactly
  }
}

要查看此命令的完整选项列表

bun add --help

--global

注意 — 这不会修改您当前项目文件夹的 package.json。 别名 - bun add --globalbun add -gbun install --globalbun install -g

要全局安装软件包,请使用 -g/--global 标志。这不会修改您当前项目的 package.json。通常用于安装命令行工具。

bun add --global cowsay # or `bun add -g cowsay`
cowsay "Bun!"
 ______
< Bun! >
 ------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

配置全局安装行为

受信任的依赖项

与其他 npm 客户端不同,Bun 不会为已安装的依赖项执行任意生命周期脚本,例如 postinstall。这些脚本代表潜在的安全风险,因为它们可以在您的机器上执行任意代码。

要告知 Bun 允许特定软件包的生命周期脚本,请将该软件包添加到您的 package.json 中的 trustedDependencies

{
  "name": "my-app",
  "version": "1.0.0",
  "trustedDependencies": ["my-trusted-package"]
}

Bun 会读取此字段,并将为 my-trusted-package 运行生命周期脚本。

Git 依赖项

要从公共或私有 git 仓库添加依赖项

bun add git@github.com:moment/moment.git

注意 — 要安装私有仓库,您的系统需要适当的 SSH 凭据才能访问该仓库。

Bun 支持多种协议,包括 githubgitgit+sshgit+https 以及更多。

{
  "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"
  }
}

Tarball 依赖项

软件包名称可以对应于公开托管的 .tgz 文件。在安装期间,Bun 将从指定的 tarball URL 下载并安装软件包,而不是从软件包注册表下载。

bun add zod@https://registry.npmjs.org/zod/-/zod-3.21.4.tgz

这会将以下行添加到您的 package.json

package.json
{
  "dependencies": {
    "zod": "https://registry.npmjs.org/zod/-/zod-3.21.4.tgz"
  }
}

CLI 用法

$bun add <package> <@version>

标志

Lockfile 选项

-y,--yarn
写入 yarn.lock 文件 (yarn v1)
--no-save
不更新 package.json 或保存 lockfile
--save
保存到 package.json (默认为 true)
--frozen-lockfile
不允许更改 lockfile
--save-text-lockfile
保存基于文本的 lockfile
--lockfile-only
生成 lockfile 而不安装依赖项

依赖类型

-p,--production
不安装 devDependencies
-d,--dev
将依赖项添加到 "devDependencies"
--optional
将依赖项添加到 "optionalDependencies"
--peer
将依赖项添加到 "peerDependencies"

安全与信任

--ca=<val>
提供证书颁发机构签名证书
--cafile=<val>
与 `--ca` 相同,但它是证书的文件路径
--no-verify
跳过验证新下载软件包的完整性
--trust
添加到项目 package.json 中的 trustedDependencies 并安装软件包

安装行为

--dry-run
不安装任何内容
-f,--force
始终从注册表请求最新版本 & 重新安装所有依赖项
--ignore-scripts
跳过项目 package.json 中的生命周期脚本 (永远不会运行依赖项脚本)
--only-missing
仅当 package.json 中尚不存在依赖项时才添加

缓存和性能

--cache-dir=<val>
从特定目录路径存储和加载缓存数据
--no-cache
完全忽略清单缓存
--backend=<val>
用于安装依赖项的平台特定优化。可能的值:“clonefile”(默认)、“hardlink”、“symlink”、“copyfile”
--concurrent-scripts=<val>
生命周期脚本的最大并发作业数(默认为 5)
--network-concurrency=<val>
最大并发网络请求数(默认为 48)

日志记录和输出

--silent
不记录任何内容
--verbose
过度详细的日志记录
--no-progress
禁用进度条
--no-summary
不打印摘要

配置

-c,--config=<val>
指定配置文件的路径 (bunfig.toml)
--registry=<val>
默认情况下使用特定的注册表,覆盖 .npmrc、bunfig.toml 和环境变量
--omit=<val>
从安装中排除 'dev'、'optional' 或 'peer' 依赖项

工作区

-g,--global
全局安装
--cwd=<val>
设置特定的 cwd

其他

-E,--exact
添加确切版本而不是 ^range
-a,--analyze
递归分析 & 安装作为参数传递的文件的依赖项(使用 Bun 的 bundler)
-h,--help
打印此帮助菜单

示例

从 npm 注册表添加依赖项
bun add zod
bun add zod@next
添加 dev、optional 或 peer 依赖项
bun add -d typescript
bun add --optional lodash
完整文档请访问 https://bun.net.cn/docs/cli/add