@cat-kit/agent-context 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +112 -0
- package/dist/stats.html +1 -1
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# Agent Context
|
|
2
|
+
|
|
3
|
+
`@cat-kit/agent-context` 为主流 AI 编程助手生成统一的 `ac` 前缀工作流命令，让你用一套固定流程驱动 AI 完成从需求到交付的全过程。
|
|
4
|
+
|
|
5
|
+
## 它解决什么问题
|
|
6
|
+
|
|
7
|
+
不同 AI 编程工具（Claude、Codex、Cursor、Copilot……）各有自己的命令格式和目录约定。当你同时使用多个工具时，需要为每个工具分别编写和维护工作流命令，内容重复且容易不一致。
|
|
8
|
+
|
|
9
|
+
`agent-context` 只需一条命令，就能为你选择的所有工具生成格式正确、内容统一的工作流命令文件。
|
|
10
|
+
|
|
11
|
+
## 安装
|
|
12
|
+
|
|
13
|
+
推荐全局安装：
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g @cat-kit/agent-context
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## 快速开始
|
|
20
|
+
|
|
21
|
+
在项目根目录执行：
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
agent-context setup
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
交互式选择你使用的 AI 工具后，工具会自动在项目中生成对应的命令文件。之后你就可以在 AI 助手中直接调用这些命令了。
|
|
28
|
+
|
|
29
|
+
## 工作流
|
|
30
|
+
|
|
31
|
+
Agent Context 定义了 6 个命令，覆盖一个计划从创建到归档的完整生命周期：
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
init → plan → replan → implement → patch → done
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
| 命令 | 作用 | 典型场景 |
|
|
38
|
+
| ----------- | ---------------- | ---------------------------------- |
|
|
39
|
+
| `init` | 初始化项目上下文 | 当你第一次在这个项目使用时 |
|
|
40
|
+
| `plan` | 创建新计划 | 开始一个新需求或任务 |
|
|
41
|
+
| `replan` | 重新规划 | 计划不合理或需求变更时调整 |
|
|
42
|
+
| `implement` | 实施计划 | 让 AI 按计划逐步编码 |
|
|
43
|
+
| `patch` | 补丁修复 | 实施完成后发现需要小幅修改 |
|
|
44
|
+
| `done` | 归档计划 | 任务彻底完成，归档并进入下一个计划 |
|
|
45
|
+
|
|
46
|
+
### 典型工作流示例
|
|
47
|
+
|
|
48
|
+
**场景：为项目添加一个新功能**
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
1. /ac-init ← 首次使用，初始化项目上下文
|
|
52
|
+
2. /ac-plan ← 描述需求，AI 生成实施计划
|
|
53
|
+
3. /ac-implement ← AI 按计划编码实施
|
|
54
|
+
4. /ac-patch ← 修复实施中遗漏的细节
|
|
55
|
+
5. /ac-done ← 确认完成，归档计划
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**场景：计划不满意，需要调整**
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
1. /ac-plan ← 创建计划
|
|
62
|
+
2. /ac-replan ← 描述调整方向，AI 重新规划
|
|
63
|
+
3. /ac-implement ← 按新计划实施
|
|
64
|
+
4. /ac-done ← 归档
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## 支持的工具
|
|
68
|
+
|
|
69
|
+
| 工具 | 命令文件目录 | 调用方式示例 |
|
|
70
|
+
| -------------- | ------------------- | ------------ |
|
|
71
|
+
| Claude | `.claude/commands/` | `/ac:init` |
|
|
72
|
+
| Codex | `.codex/commands/` | `/ac-init` |
|
|
73
|
+
| Cursor | `.cursor/commands/` | `/ac-init` |
|
|
74
|
+
| Antigravity | `.agents/` | `/ac-init` |
|
|
75
|
+
| GitHub Copilot | `.github/prompts/` | `#ac-init` |
|
|
76
|
+
|
|
77
|
+
## 命令参考
|
|
78
|
+
|
|
79
|
+
### `agent-context setup`
|
|
80
|
+
|
|
81
|
+
初始化工作流命令。交互式选择目标工具后，在项目中生成对应的命令文件。
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
# 交互式
|
|
85
|
+
agent-context setup
|
|
86
|
+
|
|
87
|
+
# 直接指定工具，跳过选择
|
|
88
|
+
agent-context setup --tools claude,cursor,copilot
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### `agent-context update`
|
|
92
|
+
|
|
93
|
+
更新已有的工作流命令文件（仅更新已安装的工具，不新增）。适用于升级 `@cat-kit/agent-context` 版本后同步最新模板。
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
agent-context update
|
|
97
|
+
|
|
98
|
+
# 仅检查是否有待更新内容，不实际写入
|
|
99
|
+
agent-context update --check
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### 通用选项
|
|
103
|
+
|
|
104
|
+
| 选项 | 说明 |
|
|
105
|
+
| ----------------- | ---------------------- |
|
|
106
|
+
| `--tools <tools>` | 指定目标工具，逗号分隔 |
|
|
107
|
+
| `--yes` | 非交互模式 |
|
|
108
|
+
| `--check` | 仅检查，不写入文件 |
|
|
109
|
+
|
|
110
|
+
## License
|
|
111
|
+
|
|
112
|
+
MIT
|
package/dist/stats.html
CHANGED
|
@@ -4930,7 +4930,7 @@ var drawChart = (function (exports) {
|
|
|
4930
4930
|
</script>
|
|
4931
4931
|
<script>
|
|
4932
4932
|
/*<!--*/
|
|
4933
|
-
const data = {"version":2,"tree":{"name":"root","children":[{"name":"index.d.ts","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/index.d.ts","uid":"
|
|
4933
|
+
const data = {"version":2,"tree":{"name":"root","children":[{"name":"index.d.ts","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/index.d.ts","uid":"ad83e1e8-1"}]},{"name":"index.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/index.ts","uid":"ad83e1e8-3"}]},{"name":"adapters/tool-targets.d.ts","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/adapters/tool-targets.d.ts","uid":"ad83e1e8-5"}]},{"name":"adapters/tool-targets.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/adapters/tool-targets.ts","uid":"ad83e1e8-7"}]},{"name":"domain/types.d.ts","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/types.d.ts","uid":"ad83e1e8-9"}]},{"name":"domain/workflow-content.d.ts","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-content.d.ts","uid":"ad83e1e8-11"}]},{"name":"domain/workflow-content.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-content.ts","uid":"ad83e1e8-13"}]},{"name":"domain/workflow-context.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-context.ts","uid":"ad83e1e8-15"}]},{"name":"domain/workflow-templates/done.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/done.ts","uid":"ad83e1e8-17"}]},{"name":"domain/workflow-templates/implement.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/implement.ts","uid":"ad83e1e8-19"}]},{"name":"domain/workflow-templates/init.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/init.ts","uid":"ad83e1e8-21"}]},{"name":"domain/workflow-templates/patch.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/patch.ts","uid":"ad83e1e8-23"}]},{"name":"domain/workflow-templates/plan.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/plan.ts","uid":"ad83e1e8-25"}]},{"name":"domain/workflow-templates/replan.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/replan.ts","uid":"ad83e1e8-27"}]},{"name":"generators/workflow.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/generators/workflow.ts","uid":"ad83e1e8-29"}]},{"name":"runtime/execute.d.ts","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/runtime/execute.d.ts","uid":"ad83e1e8-31"}]},{"name":"runtime/execute.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/runtime/execute.ts","uid":"ad83e1e8-33"}]},{"name":"shared/fs.js","children":[{"name":"home/whj/codes/cat-kit/packages/agent-context/src/shared/fs.ts","uid":"ad83e1e8-35"}]}],"isRoot":true},"nodeParts":{"ad83e1e8-1":{"renderedLength":0,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-0"},"ad83e1e8-3":{"renderedLength":0,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-2"},"ad83e1e8-5":{"renderedLength":378,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-4"},"ad83e1e8-7":{"renderedLength":2332,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-6"},"ad83e1e8-9":{"renderedLength":552,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-8"},"ad83e1e8-11":{"renderedLength":159,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-10"},"ad83e1e8-13":{"renderedLength":340,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-12"},"ad83e1e8-15":{"renderedLength":926,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-14"},"ad83e1e8-17":{"renderedLength":1638,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-16"},"ad83e1e8-19":{"renderedLength":2036,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-18"},"ad83e1e8-21":{"renderedLength":2170,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-20"},"ad83e1e8-23":{"renderedLength":1811,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-22"},"ad83e1e8-25":{"renderedLength":2476,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-24"},"ad83e1e8-27":{"renderedLength":1720,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-26"},"ad83e1e8-29":{"renderedLength":468,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-28"},"ad83e1e8-31":{"renderedLength":257,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-30"},"ad83e1e8-33":{"renderedLength":750,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-32"},"ad83e1e8-35":{"renderedLength":1128,"gzipLength":0,"brotliLength":0,"metaUid":"ad83e1e8-34"}},"nodeMetas":{"ad83e1e8-0":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/index.d.ts","moduleParts":{"index.d.ts":"ad83e1e8-1"},"imported":[{"uid":"ad83e1e8-4"},{"uid":"ad83e1e8-10"},{"uid":"ad83e1e8-30"},{"uid":"ad83e1e8-8"}],"importedBy":[],"isEntry":true},"ad83e1e8-2":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/index.ts","moduleParts":{"index.js":"ad83e1e8-3"},"imported":[{"uid":"ad83e1e8-6"},{"uid":"ad83e1e8-12"},{"uid":"ad83e1e8-32"}],"importedBy":[],"isEntry":true},"ad83e1e8-4":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/adapters/tool-targets.d.ts","moduleParts":{"adapters/tool-targets.d.ts":"ad83e1e8-5"},"imported":[{"uid":"ad83e1e8-8"}],"importedBy":[{"uid":"ad83e1e8-0"}]},"ad83e1e8-6":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/adapters/tool-targets.ts","moduleParts":{"adapters/tool-targets.js":"ad83e1e8-7"},"imported":[{"uid":"ad83e1e8-36"},{"uid":"ad83e1e8-37"}],"importedBy":[{"uid":"ad83e1e8-2"},{"uid":"ad83e1e8-32"},{"uid":"ad83e1e8-28"}]},"ad83e1e8-8":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/types.d.ts","moduleParts":{"domain/types.d.ts":"ad83e1e8-9"},"imported":[],"importedBy":[{"uid":"ad83e1e8-0"},{"uid":"ad83e1e8-4"},{"uid":"ad83e1e8-10"},{"uid":"ad83e1e8-30"}]},"ad83e1e8-10":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-content.d.ts","moduleParts":{"domain/workflow-content.d.ts":"ad83e1e8-11"},"imported":[{"uid":"ad83e1e8-8"}],"importedBy":[{"uid":"ad83e1e8-0"}]},"ad83e1e8-12":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-content.ts","moduleParts":{"domain/workflow-content.js":"ad83e1e8-13"},"imported":[{"uid":"ad83e1e8-38"}],"importedBy":[{"uid":"ad83e1e8-2"},{"uid":"ad83e1e8-28"}]},"ad83e1e8-14":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-context.ts","moduleParts":{"domain/workflow-context.js":"ad83e1e8-15"},"imported":[],"importedBy":[{"uid":"ad83e1e8-38"},{"uid":"ad83e1e8-20"},{"uid":"ad83e1e8-24"},{"uid":"ad83e1e8-26"},{"uid":"ad83e1e8-18"},{"uid":"ad83e1e8-22"},{"uid":"ad83e1e8-16"}]},"ad83e1e8-16":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/done.ts","moduleParts":{"domain/workflow-templates/done.js":"ad83e1e8-17"},"imported":[{"uid":"ad83e1e8-14"}],"importedBy":[{"uid":"ad83e1e8-38"}]},"ad83e1e8-18":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/implement.ts","moduleParts":{"domain/workflow-templates/implement.js":"ad83e1e8-19"},"imported":[{"uid":"ad83e1e8-14"}],"importedBy":[{"uid":"ad83e1e8-38"}]},"ad83e1e8-20":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/init.ts","moduleParts":{"domain/workflow-templates/init.js":"ad83e1e8-21"},"imported":[{"uid":"ad83e1e8-14"}],"importedBy":[{"uid":"ad83e1e8-38"}]},"ad83e1e8-22":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/patch.ts","moduleParts":{"domain/workflow-templates/patch.js":"ad83e1e8-23"},"imported":[{"uid":"ad83e1e8-14"}],"importedBy":[{"uid":"ad83e1e8-38"}]},"ad83e1e8-24":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/plan.ts","moduleParts":{"domain/workflow-templates/plan.js":"ad83e1e8-25"},"imported":[{"uid":"ad83e1e8-14"}],"importedBy":[{"uid":"ad83e1e8-38"}]},"ad83e1e8-26":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/replan.ts","moduleParts":{"domain/workflow-templates/replan.js":"ad83e1e8-27"},"imported":[{"uid":"ad83e1e8-14"}],"importedBy":[{"uid":"ad83e1e8-38"}]},"ad83e1e8-28":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/generators/workflow.ts","moduleParts":{"generators/workflow.js":"ad83e1e8-29"},"imported":[{"uid":"ad83e1e8-6"},{"uid":"ad83e1e8-12"}],"importedBy":[{"uid":"ad83e1e8-32"}]},"ad83e1e8-30":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/runtime/execute.d.ts","moduleParts":{"runtime/execute.d.ts":"ad83e1e8-31"},"imported":[{"uid":"ad83e1e8-8"}],"importedBy":[{"uid":"ad83e1e8-0"}]},"ad83e1e8-32":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/runtime/execute.ts","moduleParts":{"runtime/execute.js":"ad83e1e8-33"},"imported":[{"uid":"ad83e1e8-6"},{"uid":"ad83e1e8-28"},{"uid":"ad83e1e8-34"}],"importedBy":[{"uid":"ad83e1e8-2"}]},"ad83e1e8-34":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/shared/fs.ts","moduleParts":{"shared/fs.js":"ad83e1e8-35"},"imported":[{"uid":"ad83e1e8-36"},{"uid":"ad83e1e8-37"},{"uid":"ad83e1e8-39"}],"importedBy":[{"uid":"ad83e1e8-32"}]},"ad83e1e8-36":{"id":"node:path","moduleParts":{},"imported":[],"importedBy":[{"uid":"ad83e1e8-6"},{"uid":"ad83e1e8-34"}]},"ad83e1e8-37":{"id":"node:fs","moduleParts":{},"imported":[],"importedBy":[{"uid":"ad83e1e8-6"},{"uid":"ad83e1e8-34"}]},"ad83e1e8-38":{"id":"/home/whj/codes/cat-kit/packages/agent-context/src/domain/workflow-templates/index.ts","moduleParts":{},"imported":[{"uid":"ad83e1e8-14"},{"uid":"ad83e1e8-20"},{"uid":"ad83e1e8-24"},{"uid":"ad83e1e8-26"},{"uid":"ad83e1e8-18"},{"uid":"ad83e1e8-22"},{"uid":"ad83e1e8-16"}],"importedBy":[{"uid":"ad83e1e8-12"}]},"ad83e1e8-39":{"id":"node:fs/promises","moduleParts":{},"imported":[],"importedBy":[{"uid":"ad83e1e8-34"}]}},"env":{"rollup":"4.23.0"},"options":{"gzip":false,"brotli":false,"sourcemap":false}};
|
|
4934
4934
|
|
|
4935
4935
|
const run = () => {
|
|
4936
4936
|
const width = window.innerWidth;
|
package/package.json
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cat-kit/agent-context",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.4",
|
|
5
5
|
"description": "代理上下文管理工具",
|
|
6
6
|
"bin": {
|
|
7
7
|
"agent-context": "./dist/cli.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
10
|
"dist",
|
|
11
|
-
"src"
|
|
11
|
+
"src",
|
|
12
|
+
"README.md"
|
|
12
13
|
],
|
|
13
14
|
"exports": {
|
|
14
15
|
".": {
|