# @erclx/canon 中文文档

规范地址：https://npmcn.com/package/%40erclx/canon/

版本：5\.88\.0
npm 元数据更新时间：2026-11-12T20:12:26.511Z
中文译文更新时间：2026-11-13T20:36:16.808Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40erclx/canon
原文对照：https://npmcn.com/package/%40erclx/canon/?lang=original

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

- 包体积（解压后）：7 MB，1058 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：6 个
- 首次发布：2026-08-31T11:04:04.112Z
- 最新版本发布：2026-11-12T20:12:26.267Z
- 近 30 天下载量：13383（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：250（近 12 个月 250 个）

## 中文简介

运行你的经纪人的工作 并保持它的代码好, 在一个设置为每回.

## 安装

```sh
npm install @erclx/canon
```

也可以使用：`pnpm add @erclx/canon`、`yarn add @erclx/canon`、`bun add @erclx/canon`

## README

![canon](https://npmcn.com/package/%40erclx/canon/assets/brand/mark-color-light.svg)

# 宽度

一个Claude代码插件和CLI从计划到合并运行代理工作.

[![npm version](https://img.shields.io/npm/v/@erclx/canon)](https://www.npmjs.com/package/@erclx/canon) [![CI status](https://img.shields.io/github/actions/workflow/status/erclx/canon/verify.yml?branch=main)](https://github.com/erclx/canon/actions/workflows/verify.yml) [![License MIT](https://img.shields.io/npm/l/@erclx/canon)](https://npmcn.com/package/%40erclx/canon/LICENSE)

![Claude Code's agent view in canon: sessions complete, take answers, and arrive, then a slash opens canon's skill menu](https://npmcn.com/package/%40erclx/canon/assets/loops/readme-light.gif)

## 快开始

```bash
claude plugin marketplace add https://github.com/erclx/canon
claude plugin install canon@canon
bun install --global @erclx/canon
```

然后用 Claude 代码打开一个项目并运行 `/canon:target-setup`把它带入坎恩.

canon期望有人已经很了解Claude Code 它运行在Linux和macOS上,CLI需要Bun.

## 5个角色,各自在自己的会议上担任

你和管弦乐家说话, 开始其他人,听到每个人的回声.

-   管弦乐团在任务板上发出行
-   一个计划员读出代码,写一个你批准的计划
-   一个工人设计了计划 并打开了拉动请求
-   代码审查员从新会话读取 diff
-   一个 UI 审查器在运行中的应用程序中驱动可视化核对表

## 记录每一步写

每张唱片都有固定的形状,因此下个会话知道读到的地方. 记录在下 `.canon/` 在主检出.

-   在建造之前: 接收、基础、计划、任务和董事会
-   围绕拉出请求:代码审查,UI审查,截图证据
-   跨会话:驱动记录、上下文条目和交接压缩将丢失

## 具有上述来源的实践技能

每种技能在它类型的工作开始时都会负载,并且每个规则名称都来源于何处.

| 技能 | 装入 | 锡 |
| --- | --- | --- |
| `code-craft` | 在新函数或模块之前 | Google, (英语) 在代码审查中寻找什么 |
| `test-craft` | 在写测试之前 | Ham Vocke, 实用测试金字塔 |
| `api-design` | 在塑造一面旗帜或输出之前 | 谷歌软件工程 |
| `ui-craft` | 当所提交文件更改时 | W3C,使用ARIA |
| `systematic-debugging` | 在虫子上 没人解释 | 杰西·文森特 超级大国 |

每个规则在分类账中都有自己的源行,当技能的规则及其行数不一致时,技能审计失败.

## 检查一个跳过的步骤

技能说明什么是好 此四部分所持为代理人.

-   代理打开匹配文件时按路径加载规则, 并且每个名称拥有此类文件的技巧
-   虎克在运行前或运行后读取每个动作,拒绝一些动作并报告其他动作返回到相同的转弯
-   门在拉出请求前运行每个阶段, 无法读取其输入的阶段失败而不是通过
-   拒绝规则使代理无法合并, 因为悬钩在超时时无法打开, 而许可规则不会

## 每变一棵工作树

更改同时运行 。 每个工人在自己的树上建自己的树枝,每届都读写 `.canon/` 记录在主检出, 所以没有工作树 保存自己的副本.

## 设立项目

该项目从堆栈本身的工具开始,例如 `bun init` 或者说 `npm create vite`,或与 `/canon:target-scaffold` 在一个空文件夹中,和顶部的光圈层.

1.  `/canon:target-setup` 检测堆栈,显示整个链条,并在你答应之前不写字. 然后它运行 `canon init`检查什么降落,索引文件.
2.  `/canon:target-check` 报告,按域划分,项目持有什么 与现在的船, 和修理什么.
3.  `/canon:target-update` 在发布后升级 CLI 和插件, 预览更改日志和任何迁移, 并抓取您前进的工程 .

3种档案土地 在您的Repo:

-   技能负载从插件中活化, 因此没有复制可漂移
-   规则是文件 `.claude/rules/` 当您编辑匹配路径时加载
-   配置和种子都是你拥有的 真实文件,由 `canon init` 并保持当前 `canon sync`

## 给你的经纪人

-   每个命令运行时没有提示, 有关 Stdout 管道的数据干净
-   `canon <command> --help` 打印每个命令的旗帜、退出代码和示例
-   按路径加载规则, 因此代理为正在编辑的文件获得规则

## 文档

-   [AI 工作流程](https://npmcn.com/package/%40erclx/canon/docs/workflow/ai-workflow.md): 特性运行的循环
-   [操作模式](https://npmcn.com/package/%40erclx/canon/docs/workflow/operating-model.md): 规划人员、工人和审查人员平行
-   [技能地图](https://npmcn.com/package/%40erclx/canon/docs/workflow/skill-map.md):每一技能,在你到达它的时候
-   [探员](https://npmcn.com/package/%40erclx/canon/docs/agents/index.md): 旗帜、退出代码和输出形状
-   [文件索引](https://npmcn.com/package/%40erclx/canon/docs/index.md):每个参考文件,更新其中的条子

## 捐款

问题值得欢迎。 调用请求是邀请,所以阅读 [贡献指南](https://npmcn.com/package/%40erclx/canon/CONTRIBUTING.md) 在你打开一个之前。 释放 [麻省理工学院许可证](https://npmcn.com/package/%40erclx/canon/LICENSE)。 。 。 .

## 常见问题

### @erclx/canon 是什么？

运行你的经纪人的工作 并保持它的代码好, 在一个设置为每回\.

### 如何安装 @erclx/canon？

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

### @erclx/canon 支持 TypeScript 吗？

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

### @erclx/canon 支持 ESM 还是 CommonJS？

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

### @erclx/canon 可以商用吗？

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

### @erclx/canon 的下载量有多少？

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

### @erclx/canon 还在维护吗？

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