# @alfacapital-tech/c4builder 中文文档

规范地址：https://npmcn.com/package/%40alfacapital-tech/c4builder/

版本：0\.14\.0
npm 元数据更新时间：2026-11-04T13:50:05.742Z
中文译文更新时间：2026-11-06T23:05:03.229Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40alfacapital-tech/c4builder
原文对照：https://npmcn.com/package/%40alfacapital-tech/c4builder/?lang=original
项目主页：https://alfacapital-tech.github.io/C4-Builder/
源码仓库：https://github.com/AlfaCapital-Tech/C4-Builder

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

- 包体积（解压后）：37.3 MB，256 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.17
- 运行依赖：12 个
- 首次发布：2026-03-30T10:28:51.926Z
- 最新版本发布：2026-11-04T13:50:05.411Z
- 近 30 天下载量：2195（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 38 个）

## 中文简介

一个 CLI 工具,旨在将标记下和植入 uml 文件的文件夹结构汇编成一个站点、 单个文件标记下或带链接的标记下集

## 安装

```sh
npm install @alfacapital-tech/c4builder
```

也可以使用：`pnpm add @alfacapital-tech/c4builder`、`yarn add @alfacapital-tech/c4builder`、`bun add @alfacapital-tech/c4builder`

## README

**[{\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢](https://alfacapital-tech.github.io/C4-Builder/ru/)** • 妇女 [英文文件](https://alfacapital-tech.github.io/C4-Builder/en/) • 妇女 [站点](https://alfacapital-tech.github.io/C4-Builder/)

# C4- 建造器

**建筑是经纪人写、检查和阅读的代码.**

C4- Builder 是一个CLI,它会构建一个标记下的文件文件夹和 [植物图示](https://plantuml.com/), (中文(简体) ), [D2级](https://d2lang.com/), (中文(简体) ), [不丹](https://www.bpmn.org/), (中文(简体) ), [美人鱼](https://mermaid.js.org/) 或者说 [电线流](https://github.com/vanila-io/wireflow) 文件图表:a [文档化](https://docsify.js.org/) 网站,每个文件夹的标记下文件,或单个文件。 文件夹跟随 [C4型号](https://c4model.com/) (系统+容器+组件),并保持了历史 代码旁边的架构决定.

## 为何这个叉子

原画 [C4- 建造器](https://github.com/adrianvlupu/C4-Builder) 阿德里安・维克多・卢普没有 2024年3月起被开发. 在阿尔法首都,它建造了一个包含更多 超过一百个图表,所以我们继续它作为一个维护的叉子, 适应与AI特工合作:

-   **断取离线渲染.** PlantUML 罐子、图表字体和引擎船 与软件包;布局由PlantUML的内置斯梅塔纳引擎来计算,没有Graphviz. 这个 同一来源在一台笔记本电脑上,在CI和多克生产出相同的SVG,没有网络访问.
-   **`c4builder check`** 验证个人 `.puml`编号 :`.iuml`编号 :`.d2`编号 :`.bpmn`编号 :`.mmd`编号 :`.wireflow.json` 带有自建构件的文件 引擎并返回退出代码和出错行——代理机的快速反馈,预承诺 钩和CI.
-   **插头.** `openspec` 发布一个 [打开Spec](https://github.com/Fission-AI/OpenSpec) 存储 (规格和更改)作为站点部分; `openapi` 使服务合同离线 (原始内容存档于2017-10-12). swagger-ui pages.
-   **D2级** 作为第二个图引擎,定型 **巴布亚新几内亚** 通过resvg,以及 **选项 Java**数字 : 没有系统Java,c4builder下载了私人JRE.
-   **不丹** 进程为 BPMN 2.0 XML 没有坐标: 构建验证模型 并用水平池和车道铺出.
-   **美人鱼** `.mmd` 文档和 ` ```mermaid ` 块由真正的美人鱼在建造时制成, 没有浏览器:每个输出中的图像而不是客户端渲染.
-   **电线流** 用户流量: a `.wireflow.json` 导出编辑器成为有屏幕的图像 没有浏览器或网络.
-   **从一页复出.** 单位 `c4builder --site -w` 选择成为源中的问题 `.md` 代理人的反馈; `c4builder feedback --wait --as <name>` 将批次转到 代理,页面会用编辑方式重新加载.
-   **已维持.** TypeScript, 金色渲染快照, 每次拉取请求的 CI, 释放到 npm和GHCR。 (笑声) 原版的PDF输出被删除.

## 快开始

22.17. Java 17+是可选的.

```bash
npm i -g @alfacapital-tech/c4builder

c4builder --new --name demo -y   # project from the template, full config, no prompts
cd demo
c4builder                        # build into docs/
c4builder --site -w              # live preview at http://localhost:3000
```

自0.5.0起, `c4builder new` 财务报告和审定财务报表 `c4builder config` 工作(0.4.0只有旗帜). 无 `-y`, c4builder 询问工程名称,第一个构建运行设置向导.

代理循环——编辑一个图表,检查,查看结果:

```bash
c4builder check src/context.puml   # exit code 0 or 1, "✗ file: line N: message" on error
c4builder --site -w                # rebuilds and reloads the browser on every save
```

对于代理人: `c4builder skills` 在工程中安装已安装版本的代理技能 (单位:千美元)`c4builder --new` 做一个新的,和 `"generateLLMS": true` 添加 `llms.txt` 编号 : `llms-full.txt` (包括图表来源)到网站.

或与多克(Node、JRE、PlantUML、字体和D2包括):

```bash
docker run --rm -v "$PWD:/pwd" ghcr.io/alfacapital-tech/c4builder:latest c4builder
```

公布候选人名单 `rc` 标签 : `npm i -g @alfacapital-tech/c4builder@rc`。 。 。 .

## 文档

文献网站有俄文(小学)和英文全文:

|  | Русский | 联合国 |
| --- | --- | --- |
| 开始 | [Быстрый](https://alfacapital-tech.github.io/C4-Builder/ru/#/01%20%D0%91%D1%8B%D1%81%D1%82%D1%80%D1%8B%D0%B9%20%D1%81%D1%82%D0%B0%D1%80%D1%82/01%20%D0%91%D1%8B%D1%81%D1%82%D1%80%D1%8B%D0%B9%20%D1%81%D1%82%D0%B0%D1%80%D1%82) | [开始](https://alfacapital-tech.github.io/C4-Builder/en/#/01%20Getting%20started/01%20Getting%20started) |
| 图表、字体、, `check` | [Диаграммы](https://alfacapital-tech.github.io/C4-Builder/ru/#/03%20%D0%94%D0%B8%D0%B0%D0%B3%D1%80%D0%B0%D0%BC%D0%BC%D1%8B/03%20%D0%94%D0%B8%D0%B0%D0%B3%D1%80%D0%B0%D0%BC%D0%BC%D1%8B) | [图表](https://alfacapital-tech.github.io/C4-Builder/en/#/03%20Diagrams/03%20Diagrams) |
| CLI 和 `.c4builder` 密钥 | [CLI \\ \\ \\ \\ \\ \\](https://alfacapital-tech.github.io/C4-Builder/ru/#/05%20CLI%20%D0%B8%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F/05%20CLI%20%D0%B8%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F) | [CLI 配置( C)](https://alfacapital-tech.github.io/C4-Builder/en/#/05%20CLI%20and%20configuration/05%20CLI%20and%20configuration) |
| 插件 | [Плагины](https://alfacapital-tech.github.io/C4-Builder/ru/#/06%20%D0%9F%D0%BB%D0%B0%D0%B3%D0%B8%D0%BD%D1%8B/06%20%D0%9F%D0%BB%D0%B0%D0%B3%D0%B8%D0%BD%D1%8B) | [插件](https://alfacapital-tech.github.io/C4-Builder/en/#/06%20Plugins/06%20Plugins) |
| Docker 和 CI 键盘 | [Docker {% CI }](https://alfacapital-tech.github.io/C4-Builder/ru/#/07%20Docker%20%D0%B8%20CI/07%20Docker%20%D0%B8%20CI) | [嵌入器 & CI](https://alfacapital-tech.github.io/C4-Builder/en/#/07%20Docker%20and%20CI/07%20Docker%20and%20CI) |
| 与代理人合作 | [Агенты](https://alfacapital-tech.github.io/C4-Builder/ru/#/08%20%D0%90%D0%B3%D0%B5%D0%BD%D1%82%D1%8B/08%20%D0%90%D0%B3%D0%B5%D0%BD%D1%82%D1%8B) | [探员](https://alfacapital-tech.github.io/C4-Builder/en/#/08%20Agents/08%20Agents) |
| 开发和发行 | [Разработка](https://alfacapital-tech.github.io/C4-Builder/ru/#/09%20%D0%A0%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0/09%20%D0%A0%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0) | [发展](https://alfacapital-tech.github.io/C4-Builder/en/#/09%20Development/09%20Development) |

每一个版本的变化: [变动情况](https://github.com/AlfaCapital-Tech/C4-Builder/blob/master/CHANGELOG.md)。 。 。 . 为什么事情是这样的:网站的设计日志(OpenSpec store).

## 捐款

```bash
npm ci && npm run build
npm test            # all tests, golden rendering snapshots included
npm run check       # biome lint and format
```

行为变化在 OpenSpec 中描述(`openspec/changes/`)首先,在 `## Unreleased` 内 `CHANGELOG.md` 和以两种语文更新文件网页 (单位:千美元)`docs/ru/src`, (中文(简体) ), `docs/en/src`) (中文(简体) ). 详情见发展版.

## 信贷和许可证

C4- 构建器由 [阿德里安·维克多·卢普](https://github.com/adrianvlupu/C4-Builder); 这个 叉被维护 [阿尔法资本技术](https://alfacapital.tech/)上游变化和 其贡献者在更改日志中列出。 麻省理工学院执照,见 [许可证](https://github.com/AlfaCapital-Tech/C4-Builder/blob/master/license)。 。 。 .

## 常见问题

### @alfacapital-tech/c4builder 是什么？

一个 CLI 工具,旨在将标记下和植入 uml 文件的文件夹结构汇编成一个站点、 单个文件标记下或带链接的标记下集

### 如何安装 @alfacapital-tech/c4builder？

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

### @alfacapital-tech/c4builder 支持 TypeScript 吗？

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

### @alfacapital-tech/c4builder 支持 ESM 还是 CommonJS？

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

### @alfacapital-tech/c4builder 需要什么版本的 Node\.js？

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

### @alfacapital-tech/c4builder 可以商用吗？

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

### @alfacapital-tech/c4builder 的下载量有多少？

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

### @alfacapital-tech/c4builder 还在维护吗？

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