# @fluid-tools/build-cli 中文文档

规范地址：https://npmcn.com/package/%40fluid-tools/build-cli/

版本：0\.68\.0
npm 元数据更新时间：2026-10-15T19:11:46.315Z
中文译文更新时间：2026-11-15T02:18:00.139Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fluid-tools/build-cli
原文对照：https://npmcn.com/package/%40fluid-tools/build-cli/?lang=original
项目主页：https://fluidframework.com/
源码仓库：https://github.com/microsoft/FluidFramework

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

- 包体积（解压后）：3.7 MB，608 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.22\.2
- 运行依赖：62 个
- 首次发布：2022-08-25T16:07:17.830Z
- 最新版本发布：2026-10-15T19:11:46.111Z
- 近 30 天下载量：5659（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：181（近 12 个月 8 个）

## 中文简介

为流体框架构建工具

## 安装

```sh
npm install @fluid-tools/build-cli
```

也可以使用：`pnpm add @fluid-tools/build-cli`、`yarn add @fluid-tools/build-cli`、`bun add @fluid-tools/build-cli`

## README

# @fluid-tools/build-cli (英语)

flub是流体框架GitHub寄存器的构建和放出工具. flub旨在取代现有的 液态建构工具,主要是通过重新使用现有建构工具的功能并将其包装为更一致的, 使用可维护的 CLI [奥克利夫](https://oclif.io/)。 。 。 .

-   [@fluid-tools/build-cli (英语)](https://npmcn.com/package/%40fluid-tools/build-cli/#readme-fluid-toolsbuild-cli)
-   [使用量](https://npmcn.com/package/%40fluid-tools/build-cli/#readme-usage)
-   [命令主题](https://npmcn.com/package/%40fluid-tools/build-cli/#readme-command-topics)

# 使用量

```sh-session
$ npm install -g @fluid-tools/build-cli
$ flub COMMAND
running command...
$ flub (--version|-V)
@fluid-tools/build-cli/0.0.0
$ flub --help [COMMAND]
USAGE
  $ flub COMMAND
...
```

# 命令主题

-   [`flub ai`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/ai.md) - AI授权助理 启动正确的AI代理.
-   [`flub autocomplete`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/autocomplete.md) - 显示自动完成安装指令.
-   [`flub build-perf`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/build-perf.md) - 建立收集、处理和分析积分指标的可观察性命令.
-   [`flub bump`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/bump.md) - 跳出软件包的版本、发布组及其依赖性.
-   [`flub check`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/check.md) - 检查命令用于验证Repo状态、应用政策等.
-   [`flub commands`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/commands.md) - 列出所有的flub命令.
-   [`flub exec`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/exec.md) - 在包或放行组上下文中运行 shell 命令.
-   [`flub generate`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/generate.md) - 生成命令用于创建/更新代码,docs,readmes等.
-   [`flub help`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/help.md) - 显示flub的帮助.
-   [`flub info`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/info.md) - 获取关于Repo的信息, 释放组,和包.
-   [`flub list`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/list.md) - 按地形顺序在发布组中列出软件包.
-   [`flub merge`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/merge.md) - 根据批量大小同步分枝
-   [`flub modify`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/modify.md) - 修改命令用于修改项目以添加或去除依赖,更新Fluid导入等.
-   [`flub promote`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/promote.md) - 推广命令,将公布的软件包推广到npm登记册.
-   [`flub publish`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/publish.md) - 发布命令将软件包发布到npm登记册.
-   [`flub release`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/release.md) - 释放命令用于管理流体释放过程.
-   [`flub rename-types`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/rename-types.md) - 将声明文件从.d.ts重命名为.d.mts.
-   [`flub report`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/report.md) - 报告关于密码库的分析,如密码覆盖和捆绑尺寸测量.
-   [`flub transform`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/transform.md) - 变形命令用于将代码,docs等转换成可替代的形式.
-   [`flub typetests`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/typetests.md) - 更新包中类型测试的配置.json文件. 如果之前的版本在运行准备后发生变化,那么npm安装必须在构建前运行.
-   [`flub vnext`](https://npmcn.com/package/%40fluid-tools/build-cli/docs/vnext.md) - Vnext命令是使用新的基础设施执行标准flub命令的新措施.

## 开发者笔记

此软件包输出其构建文件到 `lib/` 改为 `dist/` 就像我们其他的包裹一样 原因是 oclif通过常规使用 lib 文件夹, 并且有 oclif 错误可以通过将内容放入 lib 来避免 。 见 例如 [https://github.com/microsoft/FluidFramework/pull/12155 页面存档备份,存于互联网档案馆](https://github.com/microsoft/FluidFramework/pull/12155)

### 测试

这个 `release` 命令提供 a `testMode` 旗帜,在处理状态时需要检查哪个子类。 如果输入 测试模式,所有处理过的状态应立即返回真实状态。 这使测试能够核实新状态得到处理 在某种程度上。 其他命令可以采用,但只有 `release command` 今日用来.

这个 `release` 命令还提供 a `state` 可以用来将状态机器初始化到特定状态的旗帜. 这是用来测试的.

### 手动集成测试和调试

有一些VS码发射目标,例如: `flub generate typetests` 这在某些情况下可能可行.

在通过 packet.json 脚本引用 flub 时运行本地创建的 flub 版本,使用 pnpm 覆盖 . 对于客户端:

```
            "@fluid-tools/build-cli": "file:./build-tools/packages/build-cli",
            "@fluidframework/build-tools": "file:./build-tools/packages/build-tools",
            "@fluid-tools/version-tools": "file:./build-tools/packages/version-tools"
```

这种方法可用于: `flub generate typetests` ,以确保 `--entrypoint` 包含来自脚本的配置(如果有的话),并且可以通过 JavaScript 调试控制台调试,尽管断点需要在 `.js` 文件在 `node_modules` (例如 `node_modules/.pnpm/file+build-tools+packages+build-cli_@types+node@18.19.1/node_modules/@fluid-tools/build-cli/lib/commands/generate/typetests.js`) (中文(简体) ).

或者, `link:` 超接会给出相似的结果,并且已知会支持直接在其中设置断点 `.ts` 文档。 使用时 `link:` 在 `build-tools` 已安装。 见 [pnpm.ic 文档](https://pnpm.io/cli/link#whats-the-difference-between-pnpm-link-and-using-the-file-protocol) 更多信息.

```
            "@fluid-tools/build-cli": "link:./build-tools/packages/build-cli",
            "@fluidframework/build-tools": "link:./build-tools/packages/build-tools",
            "@fluid-tools/version-tools": "link:./build-tools/packages/version-tools"
```

两种模式都需要 `pnpm i --no-frozen-lockfile` 设置后 `overrides`。如果有任何构建工具包 `dependencies` 使用时更新 `file:`中,请为两个工作区重新运行.

## 贡献准则

你们可以 [贡献](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) 通过这些方式实现流体框架:

-   回答问题 [GitHub 讨论](https://github.com/microsoft/FluidFramework/discussions)。 。 。 .
-   [提交错误报告](https://github.com/microsoft/FluidFramework/issues) 并且帮助验证修正.
-   审查 [源代码更改](https://github.com/microsoft/FluidFramework/pulls)。 。 。 .
-   [贡献错误修正](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md)。 。 。 .

详细指示改为: [repo 文档](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md)。 。 。 .

本项目遵循 [Microsoft 开源行为守则](https://opensource.microsoft.com/codeofconduct/)。 。 。 . 更多信息,改为: [《行为守则》经常被问到的问题](https://opensource.microsoft.com/codeofconduct/faq/)。 。 。 . 问题或评论,联系 [打开码@ microsoft.com](mailto:opencode@microsoft.com)。 。 。 .

这个项目可能包含微软项目的商标或标志,产品,或服务. 这些商标或标志的使用必须遵循微软 [商标和品牌准则](https://www.microsoft.com/trademarks)。 。 。 . 在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.

## 帮助

读取 [流体框架文件](https://fluidframework.com/docs/) 用于了解流体框架概念和API.

要求提供文件未载列的资料, [创建问题](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Contributing/Submitting-Bugs-and-Feature-Requests.md)。 。 。 .

## 商标

这个项目可能包含微软项目的商标或标志,产品,或服务.

这些商标或标志的使用必须遵循微软的 [商标和品牌准则](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general)。 。 。 .

在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.

## 常见问题

### @fluid-tools/build-cli 是什么？

为流体框架构建工具

### 如何安装 @fluid-tools/build-cli？

在项目目录运行 npm install @fluid-tools/build-cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 flub，可以用 npx flub 直接运行。

### @fluid-tools/build-cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/fluid-tools\_\_build-cli 是否存在。

### @fluid-tools/build-cli 支持 ESM 还是 CommonJS？

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

### @fluid-tools/build-cli 需要什么版本的 Node\.js？

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

### @fluid-tools/build-cli 可以商用吗？

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

### @fluid-tools/build-cli 的下载量有多少？

根据 npm 官方下载统计，@fluid-tools/build-cli 在 2026/10/15 – 2026/11/13 这 30 天内被下载 5,659 次，日均约 189 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fluid-tools/build-cli 还在维护吗？

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