# @buun\_group/plotwork 中文文档

规范地址：https://npmcn.com/package/%40buun_group/plotwork/

版本：0\.10\.0
npm 元数据更新时间：2026-10-30T05:43:58.714Z
中文译文更新时间：2026-11-08T20:40:50.094Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40buun_group/plotwork
原文对照：https://npmcn.com/package/%40buun_group/plotwork/?lang=original
项目主页：https://docs.plotwork.dev/
源码仓库：https://github.com/plotwork-official/plotwork-cli

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

- 包体积（解压后）：19.7 MB，73 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2026-10-10T14:05:00.811Z
- 最新版本发布：2026-10-30T05:43:58.402Z
- 近 30 天下载量：7233（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 44 个）

## 中文简介

Plotwork 命令行: 校验、 渲染、 同步和转换您仓库中的图表, 离线 。 保持Markdown文件中的图片与源码同步,并检查CI. 它什么都不算,也不寄出去.

## 安装

```sh
npm install @buun_group/plotwork
```

也可以使用：`pnpm add @buun_group/plotwork`、`yarn add @buun_group/plotwork`、`bun add @buun_group/plotwork`

## README

[![Plotwork](https://assets.plotwork.dev/brand/logo/plotwork-lockup-on-light.svg)](https://plotwork.dev/)

# 绘图命令行

在您的仓库中检查、绘制和同步绘图图 。 图表是文本中的几行 `diagram` markdown文件的围栏; `plotwork sync` 将其画成一个SVG,遵循读者的光线或黑暗设定,并用栅栏下写出相片,所以在GitHub上显示. 它运行在你的机器和CI.

## TL; DR 数据

| 问题 | 答复 |
| --- | --- |
| 它需要账户还是钥匙? | 没有. |
| 它使用网络吗? | 没有 它只读写您命名的文件, 并读取它自己的图标艺术 `icons/` 在程序旁 : 当一个图用它时, 将会从其中读取一个 几百 个图外的图标 。 它能提出的一个请求是,你给一个主机图片链接 `read`。 。 。 . |
| 这算什么? | 没有。 它没有使用量 也没有发送任何,无论 `PLOTWORK_USAGE` 设定为. |
| 我该怎么操作? | `npx @buun_group/plotwork <command>`。 。 。 . |
| 哪个节点版本? | 节点22或更新. |
| 哪里是每个选择? | `plotwork <command> --help` 打印一个命令的选项、默认、示例和退出代码。 这个 [命令引用](https://docs.plotwork.dev/cli/commands) 每个命令都有相同的一页. |
| 我该怎么让照片在CI里步入正轨? | `npx @buun_group/plotwork sync --check --format github "docs/**/*.md"`,或绘图同步动作。 见 [在 CI 中保持图表同步](https://docs.plotwork.dev/diagrams-in-ci)。 。 。 . |
| 能从我的Terraform, Bicep, Pulumi, Cloud Formation, CDK, Helm, Kustomize, 后台, Structurizr, AsyncAPI, OpenAPI, 或 SQL 文件, 或我的管道中找到一个图表吗? | 对 将文件命名于 `sources` 联 合 国 `plotwork.config.json` 运行 `npx @buun_group/plotwork generate`· ; `generate --check` 文件移动时失败, 图表没有 。 见 [图表作为代码](https://docs.plotwork.dev/diagrams-as-code)。 。 。 . |
| GitHub的黑暗模式下的照片会看起来正确吗? | 对. `sync` 财务报告和审定财务报表 `generate` 每个图中写一个遵循读取器光线或黑暗设置的SVG,并去除旧的 `.dark.svg` 他们画的文件. `"defaults": { "scheme": "light-and-dark" }` 内 `plotwork.config.json` 写出一个灯光和一个暗文件, GitHub 按它自己的主题设置在两者之间选择 。 见 [图表作为代码](https://docs.plotwork.dev/diagrams-as-code)。 。 。 . |
| 这些照片是什么样子的? | 标有动词、主动动词或被动动词("读取","消费","存储入")的箭头,画出这种关系的图标,一个序列框取出它的操作符名 (`alt`, (中文(简体) ), `loop`, (中文(简体) ), `par`)以正黑体字取出。 一个 `icon=` 没有图标是警告的名称 `W208` (单位:千美元)`validate --strict` 失败了),项目绘制了它的默认图标,因此一个缺失的品牌永远不会停止一幅图片. |
| 哪个执照? | 麻省理工学院. 守则和他人提供的数据保留自己的执照,列于 `THIRD-PARTY-NOTICES.md`。 。 。 . |

## 图标

| 命令 | 它会做什么 |
| --- | --- |
| `plotwork validate <file> [--strict]` | 检查 Markdown 或 图表文件中的每个图表 。 每个错误都有一行,一列,还有提示. `--strict` 警告失败,但样式建议失败(`W204`, (中文(简体) ), `W205`, (中文(简体) ), `W500`),用动词标记的手写箭头("已读","publishes")绘制其图标,一个叫"VPC","Production"或"Kafka"的组取出其类型. |
| `plotwork render <file> --out <svg> [--scheme light|dark|auto] [--theme <colour theme>]` | 绘制第一个带有源代码的SVG图. `--no-embed-source` 将源出. 文件可以是 Plotwork 工具的视图链接(`viewUrl`, (中文(简体) ), `svgUrl`),在引文中:图从这里读出,没有请求. |
| `plotwork sync <files...> [--check] [--format github]` | 在每个图栏下写出SVG和图片块. 每个词都是文件,文件夹,或被引用的 glob. `--check` 写不出来, 当图片被扭曲时失败; `--format github` 打印出每根被扭曲的栅栏和每条错误,作为线上的 GitHub 注释. |
| `plotwork generate [--check] [--capture] [--source <name>] [--since <ref>] [--config <file>] [--format github|json|sarif|junit]` | 构建在 `sources` 联 合 国 `plotwork.config.json` 从其文件(Terraform 及其模块和环境,或 Terraform 计划或状态为 JSON, Bicep, ARM, Pulumi, Cloud Formation, CDK) `cdk.out`、 OpenAPI、 编译、 Kubernetes、 Helm、 Kustomize、 后台目录、 Structurizr 工作空间、 AsyncAPI 文件( 上面的每个应用程序都绘制以及下面发送的内容)、 SQL、 Prisma、 Drizzle、 GitHub 动作工作流程、 GitLab CI/CD 和 Azure管道管道、 GraphQL 和 协议缓冲器系统、 无服务器框架服务、 Dockerfiles、 nginx 配置、 dbt 项目、 JavaScript 工作空间、 CSV、 JSON、文件夹、 git 日志) 、 应用其覆盖文件并撰写 `.diagram` 文档或马克当栅栏及其图片。 每个被导入的箭头都显示它与图标和行颜色的关系(读取一个眼睛,赠出一个密钥),每个帧都被打出,所以有它的颜色. `--check` 在漂移时不写则失败, 指定每个节点和边缘添加、 删除或更改 . `--capture` 将生成的图表的手编辑转换到其覆盖文件. `--since origin/main` 仅运行自git ref后文件变化的来源. `--format sarif` 为代码扫描和 `--format junit` 用于测试视图,其退出代码与 `--check`。 。 。 . |
| `plotwork import <file> [--out <file>] [--write]` | 将美人鱼转换为绘图: a `.mmd` 到源文件,或每个 `mermaid` markdown 文件的栅栏(仅重写为 `--write`) (中文(简体) ). |
| `plotwork read <file.svg|link> [--out <file>]` | 打印一个 Plotwork SVG 携带的源,这样可以编辑. |
| `plotwork export <file> --format confluence|confluence-wiki|notion [--image <link>]` | 打印粘贴的已准备好的文本, 用于聚合或逗号 。 无 `--image`SVG就写在旁边 让你上传. |
| `plotwork outline <file>` | 打印每个图表的简单文字大纲. |
| `plotwork icons <query>` | 搜索捆绑的图标. |

出站代码:当一切都好时为0;图中问题为1;命令行出错为2.

## 许可证

@buun group/plotwork 获得麻省理工学院许可. 文本在文件中 `LICENSE`。 。 。 .

单文件 `plotwork.mjs` 也包含了其他人所写的代码和数据:ELK布局引擎,图标艺术品,和字体测量. 每个人保留自己的执照. `THIRD-PARTY-NOTICES.md` 列出每个版本、版权和许可证全文。 这一包的麻省理工学院许可证并不取代这些许可证.

软件包包括AWS,Microsoft Azure,Google Cloud的官方架构图标,未修改. 他们属于他们的主人 **没有** 由麻省理工学院许可证管辖。 他们的条件和商标通知在 `THIRD-PARTY-NOTICES.md`。 。 。 .

## 关于此寄存器

此寄存器持有被发布到 npm 的已建软件包 。 这里的更改被下个发行所取代,所以打开一个问题而不是拉出请求. 已出版的版本从未被更改;固定是新版本.

每次释放都带着 `checksums.txt` 包里每个文件的SHA-256 要检查下载 :

```sh
sha256sum --check checksums.txt
```

## 另见

| 链接 | 为什么 |
| --- | --- |
| [命令行文档](https://docs.plotwork.dev/cli/overview) | 在 GitHub 动作、 GitLab 、 Azure Pipelines 、 Jenkins 和 CircleCI 上安装, 每个命令, CI , 退出代码和故障排除 |
| [文档](https://docs.plotwork.dev/) | 图表语言和指南 |
| [问题](https://github.com/plotwork-official/plotwork-cli/issues) | 报告问题或提问 |
| [安全政策](https://github.com/plotwork-official/plotwork-cli/security/policy) | 私下报告脆弱性 |

## 常见问题

### @buun\_group/plotwork 是什么？

Plotwork 命令行: 校验、 渲染、 同步和转换您仓库中的图表, 离线 。 保持Markdown文件中的图片与源码同步,并检查CI\. 它什么都不算,也不寄出去\.

### 如何安装 @buun\_group/plotwork？

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

### @buun\_group/plotwork 支持 TypeScript 吗？

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

### @buun\_group/plotwork 支持 ESM 还是 CommonJS？

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

### @buun\_group/plotwork 需要什么版本的 Node\.js？

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

### @buun\_group/plotwork 可以商用吗？

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

### @buun\_group/plotwork 的下载量有多少？

根据 npm 官方下载统计，@buun\_group/plotwork 在 2026/10/09 – 2026/11/07 这 30 天内被下载 7,233 次，日均约 241 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @buun\_group/plotwork 还在维护吗？

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