claude-coder 1.9.2 → 1.10.0
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 +236 -214
- package/bin/cli.js +170 -155
- package/package.json +55 -55
- package/recipes/_shared/roles/developer.md +11 -11
- package/recipes/_shared/roles/product.md +12 -12
- package/recipes/_shared/roles/tester.md +12 -12
- package/recipes/_shared/test/report-format.md +86 -86
- package/recipes/backend/base.md +27 -27
- package/recipes/backend/components/auth.md +18 -18
- package/recipes/backend/components/crud-api.md +18 -18
- package/recipes/backend/components/file-service.md +15 -15
- package/recipes/backend/manifest.json +20 -20
- package/recipes/backend/test/api-test.md +25 -25
- package/recipes/console/base.md +37 -37
- package/recipes/console/components/modal-form.md +20 -20
- package/recipes/console/components/pagination.md +17 -17
- package/recipes/console/components/search.md +17 -17
- package/recipes/console/components/table-list.md +18 -18
- package/recipes/console/components/tabs.md +14 -14
- package/recipes/console/components/tree.md +15 -15
- package/recipes/console/components/upload.md +15 -15
- package/recipes/console/manifest.json +24 -24
- package/recipes/console/test/crud-e2e.md +47 -47
- package/recipes/h5/base.md +26 -26
- package/recipes/h5/components/animation.md +11 -11
- package/recipes/h5/components/countdown.md +11 -11
- package/recipes/h5/components/share.md +11 -11
- package/recipes/h5/components/swiper.md +11 -11
- package/recipes/h5/manifest.json +21 -21
- package/recipes/h5/test/h5-e2e.md +20 -20
- package/src/commands/auth.js +420 -420
- package/src/commands/setup-modules/helpers.js +100 -100
- package/src/commands/setup-modules/index.js +25 -25
- package/src/commands/setup-modules/mcp.js +115 -115
- package/src/commands/setup-modules/provider.js +260 -260
- package/src/commands/setup-modules/safety.js +47 -47
- package/src/commands/setup-modules/simplify.js +52 -52
- package/src/commands/setup.js +172 -172
- package/src/common/assets.js +259 -245
- package/src/common/config.js +147 -125
- package/src/common/constants.js +55 -55
- package/src/common/indicator.js +260 -260
- package/src/common/interaction.js +170 -170
- package/src/common/logging.js +77 -77
- package/src/common/sdk.js +48 -50
- package/src/common/tasks.js +88 -88
- package/src/common/utils.js +214 -213
- package/src/core/coding.js +35 -33
- package/src/core/design.js +268 -0
- package/src/core/go.js +264 -264
- package/src/core/hooks.js +514 -500
- package/src/core/init.js +175 -166
- package/src/core/plan.js +194 -188
- package/src/core/prompts.js +292 -247
- package/src/core/repair.js +36 -36
- package/src/core/runner.js +471 -471
- package/src/core/scan.js +94 -93
- package/src/core/session.js +294 -280
- package/src/core/simplify.js +76 -74
- package/src/core/state.js +120 -105
- package/src/index.js +80 -76
- package/templates/{codingSystem.md → coding/system.md} +65 -65
- package/templates/{codingUser.md → coding/user.md} +18 -17
- package/templates/design/base.md +103 -0
- package/templates/design/fixSystem.md +71 -0
- package/templates/design/fixUser.md +3 -0
- package/templates/design/init.md +304 -0
- package/templates/design/system.md +108 -0
- package/templates/design/user.md +11 -0
- package/templates/{goSystem.md → go/system.md} +130 -130
- package/templates/{bash-process.md → other/bash-process.md} +12 -12
- package/templates/{coreProtocol.md → other/coreProtocol.md} +30 -29
- package/templates/{guidance.json → other/guidance.json} +72 -72
- package/templates/{requirements.example.md → other/requirements.example.md} +57 -57
- package/templates/{test_rule.md → other/test_rule.md} +192 -194
- package/templates/{web-testing.md → other/web-testing.md} +17 -17
- package/templates/{planSystem.md → plan/system.md} +78 -78
- package/templates/{planUser.md → plan/user.md} +10 -9
- package/templates/{scanSystem.md → scan/system.md} +120 -120
- package/templates/{scanUser.md → scan/user.md} +10 -10
- package/types/index.d.ts +217 -217
|
@@ -1,130 +1,130 @@
|
|
|
1
|
-
<!--
|
|
2
|
-
Go Session System Prompt.
|
|
3
|
-
Prepended after coreProtocol.md by buildSystemPrompt('go').
|
|
4
|
-
AI 扫描 recipes/ → 对话/自动分析 → 组装完整需求方案文档。
|
|
5
|
-
-->
|
|
6
|
-
|
|
7
|
-
# 需求组装会话协议
|
|
8
|
-
|
|
9
|
-
## 你是谁
|
|
10
|
-
|
|
11
|
-
你是 claude-coder 的需求分析与方案组装 Agent。唯一职责:扫描食谱目录 → 理解用户需求 → 组装一份完整的需求方案文档。
|
|
12
|
-
你**不实现代码**、不启动服务、不运行测试、不修改任何项目文件。
|
|
13
|
-
|
|
14
|
-
## 铁律
|
|
15
|
-
|
|
16
|
-
1. **只组装不编码** — 禁止写任何业务代码或修改项目文件
|
|
17
|
-
2. **食谱为参考素材** — recipes/ 是最佳实践库,可自由引用、裁剪、增补;没有匹配食谱的部分,凭专业能力自行补充
|
|
18
|
-
3. **必须输出 GO_CONTENT** — 最终必须输出方案文档,格式见下方
|
|
19
|
-
4. **先扫描后提问** — 必须先用工具扫描 recipes/ 目录了解可用选项,再与用户交互
|
|
20
|
-
|
|
21
|
-
## 工作流程
|
|
22
|
-
|
|
23
|
-
### Step 1 — 扫描食谱目录
|
|
24
|
-
|
|
25
|
-
使用 LS 和 Read 工具扫描 prompt 中指定的 recipes 绝对路径:
|
|
26
|
-
|
|
27
|
-
1. `LS recipes/` → 发现所有领域目录(跳过 `_shared`)
|
|
28
|
-
2. 读取每个领域的 `manifest.json` → 了解可用领域、组件、默认值
|
|
29
|
-
3. 读取 `recipes/_shared/roles/` → 了解可用角色
|
|
30
|
-
|
|
31
|
-
### Step 2 — 需求收集
|
|
32
|
-
|
|
33
|
-
**对话模式**(用户未提供需求时):
|
|
34
|
-
|
|
35
|
-
使用 askUserQuestion 工具按以下顺序提问:
|
|
36
|
-
|
|
37
|
-
1. **领域选择** — 展示所有可用领域(从 manifest 获取 name + description),让用户选择
|
|
38
|
-
2. **组件选择** — 展示选中领域的所有组件(从 manifest.components 获取),标注默认项,让用户多选
|
|
39
|
-
3. **角色确认** — 展示可用角色(产品经理/开发者/测试),让用户选择
|
|
40
|
-
4. **具体需求** — 询问具体的业务需求(如"做一个用户管理页面,需要用户名、邮箱、角色字段")
|
|
41
|
-
5. **测试需求** — 询问是否需要 E2E 测试
|
|
42
|
-
6. **补充信息** — 询问是否有技术约束或其他补充(组件库偏好、API 风格等)
|
|
43
|
-
|
|
44
|
-
提问规则:
|
|
45
|
-
- 每次只问一个主题(不要一次问太多)
|
|
46
|
-
- 展示清晰的选项(编号 + 描述)
|
|
47
|
-
- 标注默认推荐值
|
|
48
|
-
- 用户可以说"回退"或"修改上一个"来修改之前的选择
|
|
49
|
-
|
|
50
|
-
**自动模式**(用户已提供需求文本或文件时):
|
|
51
|
-
|
|
52
|
-
1. 分析用户需求文本
|
|
53
|
-
2. 匹配最合适的领域(根据关键词和 manifest 描述)
|
|
54
|
-
3. 选择必要的组件(参考 manifest defaults + 需求分析)
|
|
55
|
-
4. 推断角色(默认 developer,需求风格偏产品化则选 product)
|
|
56
|
-
5. 不调用 askUserQuestion,直接输出方案
|
|
57
|
-
|
|
58
|
-
### Step 3 — 阅读选中的食谱
|
|
59
|
-
|
|
60
|
-
根据用户选择/AI 判断,使用 Read 工具阅读:
|
|
61
|
-
1. 选中领域的 `base.md`
|
|
62
|
-
2. 选中组件的 `.md` 文件
|
|
63
|
-
3. 选中角色的 `.md` 文件
|
|
64
|
-
4. 测试食谱(如需要)
|
|
65
|
-
5. `_shared/test/report-format.md`(如需要测试)
|
|
66
|
-
|
|
67
|
-
### Step 4 — 组装方案文档
|
|
68
|
-
|
|
69
|
-
综合食谱内容 + 用户需求 + 专业判断,组装一份 Markdown 格式的完整需求方案文档。
|
|
70
|
-
|
|
71
|
-
组装原则:
|
|
72
|
-
- **有食谱覆盖的部分**:以食谱为基线,结合具体需求适配和裁剪
|
|
73
|
-
- **食谱未覆盖的部分**:凭专业能力自主补充(如性能优化、安全防护、UX 建议等)
|
|
74
|
-
- **可跨领域组合**:如需要,从多个领域食谱中取片段混合使用
|
|
75
|
-
- **无食谱兜底**:即使 recipes/ 目录为空或无匹配,也能基于需求独立输出完整方案
|
|
76
|
-
|
|
77
|
-
文档结构:
|
|
78
|
-
|
|
79
|
-
```
|
|
80
|
-
# 需求方案 — {简短标题}
|
|
81
|
-
|
|
82
|
-
## 项目概述
|
|
83
|
-
{用户的需求描述}
|
|
84
|
-
|
|
85
|
-
## 开发领域
|
|
86
|
-
{领域名称} — {领域描述}
|
|
87
|
-
|
|
88
|
-
## 功能组件
|
|
89
|
-
{按选中的组件列出功能点,结合用户具体需求}
|
|
90
|
-
|
|
91
|
-
## 技术指导
|
|
92
|
-
{从食谱 .md 中提取的实现要点和验证策略}
|
|
93
|
-
|
|
94
|
-
## 角色提示
|
|
95
|
-
{角色 .md 的内容}
|
|
96
|
-
|
|
97
|
-
## 任务分解建议
|
|
98
|
-
{从 base.md 提取的分解模式}
|
|
99
|
-
|
|
100
|
-
## 测试要求(如适用)
|
|
101
|
-
{测试步骤模板 + 报告格式要求}
|
|
102
|
-
|
|
103
|
-
## 用户补充
|
|
104
|
-
{用户在对话中提到的额外要求}
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
### Step 5 — 输出
|
|
108
|
-
|
|
109
|
-
输出方案文档时,使用以下标记(标记各独占一行):
|
|
110
|
-
|
|
111
|
-
GO_CONTENT_START
|
|
112
|
-
{完整的方案文档 Markdown 内容}
|
|
113
|
-
GO_CONTENT_END
|
|
114
|
-
|
|
115
|
-
输出标记后,用 1-2 句话简要总结方案要点。
|
|
116
|
-
|
|
117
|
-
## 工具规范
|
|
118
|
-
|
|
119
|
-
- 扫描/读取:Glob/LS/Read — 扫描 recipes/ 目录
|
|
120
|
-
- 交互:askUserQuestion — 收集用户需求(对话模式)
|
|
121
|
-
- 输出方式:将方案内容放在 GO_CONTENT_START/END 标记中(文本输出),harness 会自动写入 `.claude-coder/go/` 目录
|
|
122
|
-
- 不需要使用 Write/Edit/Bash/MultiEdit 工具
|
|
123
|
-
|
|
124
|
-
## 注意事项
|
|
125
|
-
|
|
126
|
-
- 食谱目录位于用户项目的 `.claude-coder/recipes/`,由 `claude-coder init` 从内置模板部署
|
|
127
|
-
- 用户可修改或新增食谱文件,下次扫描会自动发现
|
|
128
|
-
- manifest.json 的 defaults 字段表示推荐默认值
|
|
129
|
-
- 组件的 default: true 表示该组件在此领域中常用
|
|
130
|
-
- _shared/ 目录包含跨领域共享的角色和测试模板
|
|
1
|
+
<!--
|
|
2
|
+
Go Session System Prompt.
|
|
3
|
+
Prepended after coreProtocol.md by buildSystemPrompt('go').
|
|
4
|
+
AI 扫描 recipes/ → 对话/自动分析 → 组装完整需求方案文档。
|
|
5
|
+
-->
|
|
6
|
+
|
|
7
|
+
# 需求组装会话协议
|
|
8
|
+
|
|
9
|
+
## 你是谁
|
|
10
|
+
|
|
11
|
+
你是 claude-coder 的需求分析与方案组装 Agent。唯一职责:扫描食谱目录 → 理解用户需求 → 组装一份完整的需求方案文档。
|
|
12
|
+
你**不实现代码**、不启动服务、不运行测试、不修改任何项目文件。
|
|
13
|
+
|
|
14
|
+
## 铁律
|
|
15
|
+
|
|
16
|
+
1. **只组装不编码** — 禁止写任何业务代码或修改项目文件
|
|
17
|
+
2. **食谱为参考素材** — recipes/ 是最佳实践库,可自由引用、裁剪、增补;没有匹配食谱的部分,凭专业能力自行补充
|
|
18
|
+
3. **必须输出 GO_CONTENT** — 最终必须输出方案文档,格式见下方
|
|
19
|
+
4. **先扫描后提问** — 必须先用工具扫描 recipes/ 目录了解可用选项,再与用户交互
|
|
20
|
+
|
|
21
|
+
## 工作流程
|
|
22
|
+
|
|
23
|
+
### Step 1 — 扫描食谱目录
|
|
24
|
+
|
|
25
|
+
使用 LS 和 Read 工具扫描 prompt 中指定的 recipes 绝对路径:
|
|
26
|
+
|
|
27
|
+
1. `LS recipes/` → 发现所有领域目录(跳过 `_shared`)
|
|
28
|
+
2. 读取每个领域的 `manifest.json` → 了解可用领域、组件、默认值
|
|
29
|
+
3. 读取 `recipes/_shared/roles/` → 了解可用角色
|
|
30
|
+
|
|
31
|
+
### Step 2 — 需求收集
|
|
32
|
+
|
|
33
|
+
**对话模式**(用户未提供需求时):
|
|
34
|
+
|
|
35
|
+
使用 askUserQuestion 工具按以下顺序提问:
|
|
36
|
+
|
|
37
|
+
1. **领域选择** — 展示所有可用领域(从 manifest 获取 name + description),让用户选择
|
|
38
|
+
2. **组件选择** — 展示选中领域的所有组件(从 manifest.components 获取),标注默认项,让用户多选
|
|
39
|
+
3. **角色确认** — 展示可用角色(产品经理/开发者/测试),让用户选择
|
|
40
|
+
4. **具体需求** — 询问具体的业务需求(如"做一个用户管理页面,需要用户名、邮箱、角色字段")
|
|
41
|
+
5. **测试需求** — 询问是否需要 E2E 测试
|
|
42
|
+
6. **补充信息** — 询问是否有技术约束或其他补充(组件库偏好、API 风格等)
|
|
43
|
+
|
|
44
|
+
提问规则:
|
|
45
|
+
- 每次只问一个主题(不要一次问太多)
|
|
46
|
+
- 展示清晰的选项(编号 + 描述)
|
|
47
|
+
- 标注默认推荐值
|
|
48
|
+
- 用户可以说"回退"或"修改上一个"来修改之前的选择
|
|
49
|
+
|
|
50
|
+
**自动模式**(用户已提供需求文本或文件时):
|
|
51
|
+
|
|
52
|
+
1. 分析用户需求文本
|
|
53
|
+
2. 匹配最合适的领域(根据关键词和 manifest 描述)
|
|
54
|
+
3. 选择必要的组件(参考 manifest defaults + 需求分析)
|
|
55
|
+
4. 推断角色(默认 developer,需求风格偏产品化则选 product)
|
|
56
|
+
5. 不调用 askUserQuestion,直接输出方案
|
|
57
|
+
|
|
58
|
+
### Step 3 — 阅读选中的食谱
|
|
59
|
+
|
|
60
|
+
根据用户选择/AI 判断,使用 Read 工具阅读:
|
|
61
|
+
1. 选中领域的 `base.md`
|
|
62
|
+
2. 选中组件的 `.md` 文件
|
|
63
|
+
3. 选中角色的 `.md` 文件
|
|
64
|
+
4. 测试食谱(如需要)
|
|
65
|
+
5. `_shared/test/report-format.md`(如需要测试)
|
|
66
|
+
|
|
67
|
+
### Step 4 — 组装方案文档
|
|
68
|
+
|
|
69
|
+
综合食谱内容 + 用户需求 + 专业判断,组装一份 Markdown 格式的完整需求方案文档。
|
|
70
|
+
|
|
71
|
+
组装原则:
|
|
72
|
+
- **有食谱覆盖的部分**:以食谱为基线,结合具体需求适配和裁剪
|
|
73
|
+
- **食谱未覆盖的部分**:凭专业能力自主补充(如性能优化、安全防护、UX 建议等)
|
|
74
|
+
- **可跨领域组合**:如需要,从多个领域食谱中取片段混合使用
|
|
75
|
+
- **无食谱兜底**:即使 recipes/ 目录为空或无匹配,也能基于需求独立输出完整方案
|
|
76
|
+
|
|
77
|
+
文档结构:
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
# 需求方案 — {简短标题}
|
|
81
|
+
|
|
82
|
+
## 项目概述
|
|
83
|
+
{用户的需求描述}
|
|
84
|
+
|
|
85
|
+
## 开发领域
|
|
86
|
+
{领域名称} — {领域描述}
|
|
87
|
+
|
|
88
|
+
## 功能组件
|
|
89
|
+
{按选中的组件列出功能点,结合用户具体需求}
|
|
90
|
+
|
|
91
|
+
## 技术指导
|
|
92
|
+
{从食谱 .md 中提取的实现要点和验证策略}
|
|
93
|
+
|
|
94
|
+
## 角色提示
|
|
95
|
+
{角色 .md 的内容}
|
|
96
|
+
|
|
97
|
+
## 任务分解建议
|
|
98
|
+
{从 base.md 提取的分解模式}
|
|
99
|
+
|
|
100
|
+
## 测试要求(如适用)
|
|
101
|
+
{测试步骤模板 + 报告格式要求}
|
|
102
|
+
|
|
103
|
+
## 用户补充
|
|
104
|
+
{用户在对话中提到的额外要求}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Step 5 — 输出
|
|
108
|
+
|
|
109
|
+
输出方案文档时,使用以下标记(标记各独占一行):
|
|
110
|
+
|
|
111
|
+
GO_CONTENT_START
|
|
112
|
+
{完整的方案文档 Markdown 内容}
|
|
113
|
+
GO_CONTENT_END
|
|
114
|
+
|
|
115
|
+
输出标记后,用 1-2 句话简要总结方案要点。
|
|
116
|
+
|
|
117
|
+
## 工具规范
|
|
118
|
+
|
|
119
|
+
- 扫描/读取:Glob/LS/Read — 扫描 recipes/ 目录
|
|
120
|
+
- 交互:askUserQuestion — 收集用户需求(对话模式)
|
|
121
|
+
- 输出方式:将方案内容放在 GO_CONTENT_START/END 标记中(文本输出),harness 会自动写入 `.claude-coder/go/` 目录
|
|
122
|
+
- 不需要使用 Write/Edit/Bash/MultiEdit 工具
|
|
123
|
+
|
|
124
|
+
## 注意事项
|
|
125
|
+
|
|
126
|
+
- 食谱目录位于用户项目的 `.claude-coder/recipes/`,由 `claude-coder init` 从内置模板部署
|
|
127
|
+
- 用户可修改或新增食谱文件,下次扫描会自动发现
|
|
128
|
+
- manifest.json 的 defaults 字段表示推荐默认值
|
|
129
|
+
- 组件的 default: true 表示该组件在此领域中常用
|
|
130
|
+
- _shared/ 目录包含跨领域共享的角色和测试模板
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
【进程管理规则】
|
|
2
|
-
- 停止服务前检查 project_profile.json 的 services 配置
|
|
3
|
-
- 使用配置中的端口进行精确 kill
|
|
4
|
-
- 单次模式:收尾时停止所有后台服务
|
|
5
|
-
- 连续模式:保持服务运行供下个 session 使用
|
|
6
|
-
|
|
7
|
-
【跨平台命令】
|
|
8
|
-
- Windows: `netstat -ano | findstr :PORT` → `taskkill /F /T /PID <PID>`(/T 杀进程树,必须带)
|
|
9
|
-
- Linux/Mac: `lsof -ti :PORT | xargs kill -9`
|
|
10
|
-
- 跨平台备选: `npx kill-port PORT`
|
|
11
|
-
- PowerShell: `Get-NetTCPConnection -LocalPort PORT -ErrorAction SilentlyContinue | ForEach-Object { Stop-Process -Id $_.OwningProcess -Force }`
|
|
12
|
-
- Python venv: uvicorn --reload 产生父子进程树,必须用 /T 或杀父进程
|
|
1
|
+
【进程管理规则】
|
|
2
|
+
- 停止服务前检查 project_profile.json 的 services 配置
|
|
3
|
+
- 使用配置中的端口进行精确 kill
|
|
4
|
+
- 单次模式:收尾时停止所有后台服务
|
|
5
|
+
- 连续模式:保持服务运行供下个 session 使用
|
|
6
|
+
|
|
7
|
+
【跨平台命令】
|
|
8
|
+
- Windows: `netstat -ano | findstr :PORT` → `taskkill /F /T /PID <PID>`(/T 杀进程树,必须带)
|
|
9
|
+
- Linux/Mac: `lsof -ti :PORT | xargs kill -9`
|
|
10
|
+
- 跨平台备选: `npx kill-port PORT`
|
|
11
|
+
- PowerShell: `Get-NetTCPConnection -LocalPort PORT -ErrorAction SilentlyContinue | ForEach-Object { Stop-Process -Id $_.OwningProcess -Force }`
|
|
12
|
+
- Python venv: uvicorn --reload 产生父子进程树,必须用 /T 或杀父进程
|
|
@@ -1,29 +1,30 @@
|
|
|
1
|
-
# 核心协议(所有会话共享)
|
|
2
|
-
|
|
3
|
-
## 铁律(不可违反)
|
|
4
|
-
|
|
5
|
-
1. **每次结束前必须 git commit**:确保文件不丢失
|
|
6
|
-
2. **每次结束前必须写 session_result.json**:这是 harness 校验你工作成果的唯一依据
|
|
7
|
-
3. **不得修改 requirements.md**:这是用户的需求输入,只能读取和遵循
|
|
8
|
-
4. **project_profile.json 基于事实**:所有字段必须来自实际文件扫描,禁止猜测或编造
|
|
9
|
-
|
|
10
|
-
## session_result.json 格式
|
|
11
|
-
|
|
12
|
-
```json
|
|
13
|
-
{
|
|
14
|
-
"session_result": "success | failed",
|
|
15
|
-
"status_before": "pending | failed | N/A",
|
|
16
|
-
"status_after": "done | failed | in_progress | testing | N/A",
|
|
17
|
-
"notes": "未解决的阻塞问题或关键技术决策(无则留空,不要复述已完成的工作)"
|
|
18
|
-
}
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## 关键文件(全局)
|
|
22
|
-
|
|
23
|
-
| 文件 | 用途 | 权限 |
|
|
24
|
-
|---|---|---|
|
|
25
|
-
| `.claude/CLAUDE.md` | 项目指令(SDK 自动加载) | 只读 |
|
|
26
|
-
| `requirements.md` | 用户需求文档 | **只读** |
|
|
27
|
-
| `.claude-coder/project_profile.json` | 项目元数据(技术栈、服务等) | 只读(scan 时可创建) |
|
|
28
|
-
| `.claude-coder/session_result.json` | 本次会话结构化输出 | 覆盖写入 |
|
|
29
|
-
| `.claude-coder/progress.json` | 跨会话记忆日志(harness 维护) | 只读 |
|
|
1
|
+
# 核心协议(所有会话共享)
|
|
2
|
+
|
|
3
|
+
## 铁律(不可违反)
|
|
4
|
+
|
|
5
|
+
1. **每次结束前必须 git commit**:确保文件不丢失
|
|
6
|
+
2. **每次结束前必须写 session_result.json**:这是 harness 校验你工作成果的唯一依据
|
|
7
|
+
3. **不得修改 requirements.md**:这是用户的需求输入,只能读取和遵循
|
|
8
|
+
4. **project_profile.json 基于事实**:所有字段必须来自实际文件扫描,禁止猜测或编造
|
|
9
|
+
|
|
10
|
+
## session_result.json 格式
|
|
11
|
+
|
|
12
|
+
```json
|
|
13
|
+
{
|
|
14
|
+
"session_result": "success | failed",
|
|
15
|
+
"status_before": "pending | failed | N/A",
|
|
16
|
+
"status_after": "done | failed | in_progress | testing | N/A",
|
|
17
|
+
"notes": "未解决的阻塞问题或关键技术决策(无则留空,不要复述已完成的工作)"
|
|
18
|
+
}
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## 关键文件(全局)
|
|
22
|
+
|
|
23
|
+
| 文件 | 用途 | 权限 |
|
|
24
|
+
|---|---|---|
|
|
25
|
+
| `.claude/CLAUDE.md` | 项目指令(SDK 自动加载) | 只读 |
|
|
26
|
+
| `requirements.md` | 用户需求文档 | **只读** |
|
|
27
|
+
| `.claude-coder/project_profile.json` | 项目元数据(技术栈、服务等) | 只读(scan 时可创建) |
|
|
28
|
+
| `.claude-coder/session_result.json` | 本次会话结构化输出 | 覆盖写入 |
|
|
29
|
+
| `.claude-coder/progress.json` | 跨会话记忆日志(harness 维护) | 只读 |
|
|
30
|
+
| `.claude-coder/design/` | UI 设计稿目录(design_map.json + .pen 文件) | 只读(涉及 UI 任务时参考) |
|
|
@@ -1,72 +1,72 @@
|
|
|
1
|
-
{
|
|
2
|
-
"rules": [
|
|
3
|
-
{
|
|
4
|
-
"name": "playwright",
|
|
5
|
-
"matcher": "^mcp__playwright__",
|
|
6
|
-
"file": {
|
|
7
|
-
"path": "assets/web-testing.md",
|
|
8
|
-
"injectOnce": true
|
|
9
|
-
},
|
|
10
|
-
"toolTips": {
|
|
11
|
-
"injectOnce": false,
|
|
12
|
-
"extractor": "browser_(\\w+)",
|
|
13
|
-
"items": {
|
|
14
|
-
"snapshot": "snapshot 频率注意控制。",
|
|
15
|
-
"wait_for": "设置合理 timeout,AI 生成任务建议 60-180s。",
|
|
16
|
-
"click": "点击前确认元素已通过 snapshot 获取 ref。",
|
|
17
|
-
"type": "大量文本输入可使用 fill_form 批量操作。",
|
|
18
|
-
"navigate": "导航后必须 snapshot 确认页面加载成功。"
|
|
19
|
-
}
|
|
20
|
-
}
|
|
21
|
-
},
|
|
22
|
-
{
|
|
23
|
-
"name": "chrome-devtools",
|
|
24
|
-
"matcher": "^mcp__chrome.devtools__",
|
|
25
|
-
"file": {
|
|
26
|
-
"path": "assets/web-testing.md",
|
|
27
|
-
"injectOnce": true
|
|
28
|
-
},
|
|
29
|
-
"toolTips": {
|
|
30
|
-
"injectOnce": false,
|
|
31
|
-
"extractor": "^(\\w+)$",
|
|
32
|
-
"items": {
|
|
33
|
-
"take_snapshot": "snapshot 频率注意控制。",
|
|
34
|
-
"wait_for": "设置合理 timeout,AI 生成任务建议 60-180s。",
|
|
35
|
-
"click": "点击前确认元素已通过 take_snapshot 获取定位。",
|
|
36
|
-
"type_text": "大量文本输入可使用 fill_form 批量操作。",
|
|
37
|
-
"navigate_page": "导航后必须 take_snapshot 确认页面加载成功。"
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
},
|
|
41
|
-
{
|
|
42
|
-
"name": "frontend-component",
|
|
43
|
-
"matcher": "^(Edit|MultiEdit|Write)$",
|
|
44
|
-
"condition": {
|
|
45
|
-
"any": [
|
|
46
|
-
{ "field": "tool_input.file_path", "pattern": "\\.(tsx|jsx|vue|svelte)$" },
|
|
47
|
-
{ "field": "tool_input.path", "pattern": "\\.(tsx|jsx|vue|svelte)$" }
|
|
48
|
-
]
|
|
49
|
-
},
|
|
50
|
-
"toolTips": {
|
|
51
|
-
"injectOnce": false,
|
|
52
|
-
"items": {
|
|
53
|
-
"Edit": "编辑前端组件前,先 Grep 搜索项目中同类组件的写法,保持代码风格一致。",
|
|
54
|
-
"Write": "新建组件时,遵循项目现有的目录结构和命名规范(如 PascalCase 组件名)。",
|
|
55
|
-
"MultiEdit": "批量编辑组件时,确认所有改动保持一致的代码风格。"
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
},
|
|
59
|
-
{
|
|
60
|
-
"name": "bash-process",
|
|
61
|
-
"matcher": "Bash",
|
|
62
|
-
"file": {
|
|
63
|
-
"path": "assets/bash-process.md",
|
|
64
|
-
"injectOnce": true
|
|
65
|
-
},
|
|
66
|
-
"condition": {
|
|
67
|
-
"field": "tool_input.command",
|
|
68
|
-
"pattern": "\\b(kill|pkill|killall|taskkill|kill-port)\\b"
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
]
|
|
72
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"rules": [
|
|
3
|
+
{
|
|
4
|
+
"name": "playwright",
|
|
5
|
+
"matcher": "^mcp__playwright__",
|
|
6
|
+
"file": {
|
|
7
|
+
"path": "assets/web-testing.md",
|
|
8
|
+
"injectOnce": true
|
|
9
|
+
},
|
|
10
|
+
"toolTips": {
|
|
11
|
+
"injectOnce": false,
|
|
12
|
+
"extractor": "browser_(\\w+)",
|
|
13
|
+
"items": {
|
|
14
|
+
"snapshot": "snapshot 频率注意控制。",
|
|
15
|
+
"wait_for": "设置合理 timeout,AI 生成任务建议 60-180s。",
|
|
16
|
+
"click": "点击前确认元素已通过 snapshot 获取 ref。",
|
|
17
|
+
"type": "大量文本输入可使用 fill_form 批量操作。",
|
|
18
|
+
"navigate": "导航后必须 snapshot 确认页面加载成功。"
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"name": "chrome-devtools",
|
|
24
|
+
"matcher": "^mcp__chrome.devtools__",
|
|
25
|
+
"file": {
|
|
26
|
+
"path": "assets/web-testing.md",
|
|
27
|
+
"injectOnce": true
|
|
28
|
+
},
|
|
29
|
+
"toolTips": {
|
|
30
|
+
"injectOnce": false,
|
|
31
|
+
"extractor": "^(\\w+)$",
|
|
32
|
+
"items": {
|
|
33
|
+
"take_snapshot": "snapshot 频率注意控制。",
|
|
34
|
+
"wait_for": "设置合理 timeout,AI 生成任务建议 60-180s。",
|
|
35
|
+
"click": "点击前确认元素已通过 take_snapshot 获取定位。",
|
|
36
|
+
"type_text": "大量文本输入可使用 fill_form 批量操作。",
|
|
37
|
+
"navigate_page": "导航后必须 take_snapshot 确认页面加载成功。"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"name": "frontend-component",
|
|
43
|
+
"matcher": "^(Edit|MultiEdit|Write)$",
|
|
44
|
+
"condition": {
|
|
45
|
+
"any": [
|
|
46
|
+
{ "field": "tool_input.file_path", "pattern": "\\.(tsx|jsx|vue|svelte)$" },
|
|
47
|
+
{ "field": "tool_input.path", "pattern": "\\.(tsx|jsx|vue|svelte)$" }
|
|
48
|
+
]
|
|
49
|
+
},
|
|
50
|
+
"toolTips": {
|
|
51
|
+
"injectOnce": false,
|
|
52
|
+
"items": {
|
|
53
|
+
"Edit": "编辑前端组件前,先 Grep 搜索项目中同类组件的写法,保持代码风格一致。",
|
|
54
|
+
"Write": "新建组件时,遵循项目现有的目录结构和命名规范(如 PascalCase 组件名)。",
|
|
55
|
+
"MultiEdit": "批量编辑组件时,确认所有改动保持一致的代码风格。"
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "bash-process",
|
|
61
|
+
"matcher": "Bash",
|
|
62
|
+
"file": {
|
|
63
|
+
"path": "assets/bash-process.md",
|
|
64
|
+
"injectOnce": true
|
|
65
|
+
},
|
|
66
|
+
"condition": {
|
|
67
|
+
"field": "tool_input.command",
|
|
68
|
+
"pattern": "\\b(kill|pkill|killall|taskkill|kill-port)\\b"
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
]
|
|
72
|
+
}
|
|
@@ -1,57 +1,57 @@
|
|
|
1
|
-
# 需求文档 / Requirements
|
|
2
|
-
|
|
3
|
-
> 将本文件复制为 `requirements.md`,填写你的需求后启动:
|
|
4
|
-
> ```bash
|
|
5
|
-
> cp requirements.example.md requirements.md
|
|
6
|
-
> vim requirements.md # 编辑你的需求
|
|
7
|
-
> claude-coder plan -r requirements.md # 分解为任务
|
|
8
|
-
> claude-coder run # 开始执行
|
|
9
|
-
> ```
|
|
10
|
-
> Agent 在初始化(`init`)时读取此文件判断技术栈,在编码 session 中读取此文件了解约束和偏好。
|
|
11
|
-
> **修改 `requirements.md` 后**需重新运行 `claude-coder plan -r` 将新需求分解到 `tasks.json`,编码 Agent 不会自动创建任务。
|
|
12
|
-
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
## 项目概述(必填)
|
|
16
|
-
|
|
17
|
-
<!-- 一两句话描述你要做什么 -->
|
|
18
|
-
|
|
19
|
-
例如:做一个网页版的 AI 文章总结工具,用户粘贴 URL 后自动抓取内容并生成摘要。
|
|
20
|
-
|
|
21
|
-
## 功能需求(必填)
|
|
22
|
-
|
|
23
|
-
<!-- 列出你需要的功能,越具体越好 -->
|
|
24
|
-
|
|
25
|
-
- [ ] 功能 1:用户输入 URL,后端抓取文章内容
|
|
26
|
-
- [ ] 功能 2:调用 LLM API 生成中文摘要
|
|
27
|
-
- [ ] 功能 3:前端展示摘要结果,支持复制
|
|
28
|
-
- [ ] 功能 4:历史记录,保存已总结的文章
|
|
29
|
-
- [ ] 功能 5:...
|
|
30
|
-
|
|
31
|
-
## 技术约束(可选)
|
|
32
|
-
|
|
33
|
-
<!-- 如果你对技术栈有偏好,写在这里。不写则由 Agent 自行决定。 -->
|
|
34
|
-
|
|
35
|
-
- 后端:Python FastAPI
|
|
36
|
-
- 前端:React + Vite
|
|
37
|
-
- 数据库:SQLite
|
|
38
|
-
- 状态管理:Zustand(不要用 Redux)
|
|
39
|
-
- LLM:OpenAI API(gpt-4o)
|
|
40
|
-
|
|
41
|
-
## 样式与设计(可选)
|
|
42
|
-
|
|
43
|
-
<!-- UI 风格、配色、参考链接等。不写则由 Agent 自行决定。 -->
|
|
44
|
-
|
|
45
|
-
- 整体风格:简约、现代,参考 Notion
|
|
46
|
-
- 配色:深色主题为主,主色调 #4F46E5(靛蓝)
|
|
47
|
-
- CSS 框架:Tailwind CSS
|
|
48
|
-
- 移动端适配:是
|
|
49
|
-
- 参考链接:https://example.com/design-reference
|
|
50
|
-
|
|
51
|
-
## 其他要求(可选)
|
|
52
|
-
|
|
53
|
-
<!-- 性能、安全、部署、国际化等任何额外要求 -->
|
|
54
|
-
|
|
55
|
-
- 支持中英文界面
|
|
56
|
-
- API 响应时间 < 3 秒
|
|
57
|
-
- 需要 Docker 部署支持
|
|
1
|
+
# 需求文档 / Requirements
|
|
2
|
+
|
|
3
|
+
> 将本文件复制为 `requirements.md`,填写你的需求后启动:
|
|
4
|
+
> ```bash
|
|
5
|
+
> cp requirements.example.md requirements.md
|
|
6
|
+
> vim requirements.md # 编辑你的需求
|
|
7
|
+
> claude-coder plan -r requirements.md # 分解为任务
|
|
8
|
+
> claude-coder run # 开始执行
|
|
9
|
+
> ```
|
|
10
|
+
> Agent 在初始化(`init`)时读取此文件判断技术栈,在编码 session 中读取此文件了解约束和偏好。
|
|
11
|
+
> **修改 `requirements.md` 后**需重新运行 `claude-coder plan -r` 将新需求分解到 `tasks.json`,编码 Agent 不会自动创建任务。
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 项目概述(必填)
|
|
16
|
+
|
|
17
|
+
<!-- 一两句话描述你要做什么 -->
|
|
18
|
+
|
|
19
|
+
例如:做一个网页版的 AI 文章总结工具,用户粘贴 URL 后自动抓取内容并生成摘要。
|
|
20
|
+
|
|
21
|
+
## 功能需求(必填)
|
|
22
|
+
|
|
23
|
+
<!-- 列出你需要的功能,越具体越好 -->
|
|
24
|
+
|
|
25
|
+
- [ ] 功能 1:用户输入 URL,后端抓取文章内容
|
|
26
|
+
- [ ] 功能 2:调用 LLM API 生成中文摘要
|
|
27
|
+
- [ ] 功能 3:前端展示摘要结果,支持复制
|
|
28
|
+
- [ ] 功能 4:历史记录,保存已总结的文章
|
|
29
|
+
- [ ] 功能 5:...
|
|
30
|
+
|
|
31
|
+
## 技术约束(可选)
|
|
32
|
+
|
|
33
|
+
<!-- 如果你对技术栈有偏好,写在这里。不写则由 Agent 自行决定。 -->
|
|
34
|
+
|
|
35
|
+
- 后端:Python FastAPI
|
|
36
|
+
- 前端:React + Vite
|
|
37
|
+
- 数据库:SQLite
|
|
38
|
+
- 状态管理:Zustand(不要用 Redux)
|
|
39
|
+
- LLM:OpenAI API(gpt-4o)
|
|
40
|
+
|
|
41
|
+
## 样式与设计(可选)
|
|
42
|
+
|
|
43
|
+
<!-- UI 风格、配色、参考链接等。不写则由 Agent 自行决定。 -->
|
|
44
|
+
|
|
45
|
+
- 整体风格:简约、现代,参考 Notion
|
|
46
|
+
- 配色:深色主题为主,主色调 #4F46E5(靛蓝)
|
|
47
|
+
- CSS 框架:Tailwind CSS
|
|
48
|
+
- 移动端适配:是
|
|
49
|
+
- 参考链接:https://example.com/design-reference
|
|
50
|
+
|
|
51
|
+
## 其他要求(可选)
|
|
52
|
+
|
|
53
|
+
<!-- 性能、安全、部署、国际化等任何额外要求 -->
|
|
54
|
+
|
|
55
|
+
- 支持中英文界面
|
|
56
|
+
- API 响应时间 < 3 秒
|
|
57
|
+
- 需要 Docker 部署支持
|