sumulige-claude 1.0.0 → 1.0.1

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.
@@ -33,4 +33,4 @@
33
33
  "Bash(git pull:*)"
34
34
  ]
35
35
  }
36
- }
36
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sumulige-claude",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "The Best Agent Harness for Claude Code",
5
5
  "main": "cli.js",
6
6
  "bin": {
@@ -1,10 +1,53 @@
1
- # Claude Code 使用指南
1
+ # Sumulige Claude 使用指南
2
2
 
3
- > 本文档说明如何在项目中使用 Claude Code
3
+ > 本文档说明如何使用 Sumulige Claude (smc) 和 Claude Code
4
4
 
5
5
  @version: 1.0.0
6
6
 
7
- ## 快速开始
7
+ ---
8
+
9
+ ## 🚀 安装与初始化
10
+
11
+ ### 1. 全局安装
12
+
13
+ ```bash
14
+ npm install -g sumulige-claude
15
+ ```
16
+
17
+ ### 2. 首次初始化
18
+
19
+ ```bash
20
+ smc init
21
+ ```
22
+
23
+ 这会创建全局配置 `~/.claude/config.json`
24
+
25
+ ### 3. 在新项目中使用
26
+
27
+ ```bash
28
+ cd your-project
29
+ smc template # 复制模板到项目
30
+ smc status # 查看状态
31
+ ```
32
+
33
+ ---
34
+
35
+ ## 📋 SMC 命令速查
36
+
37
+ | 命令 | 功能 | 说明 |
38
+ |------|------|------|
39
+ | `smc init` | 初始化 | 创建全局配置 |
40
+ | `smc status` | 查看状态 | 显示 Agents、Skills 状态 |
41
+ | `smc template` | 项目模板 | 复制 `.claude/` 到当前项目 |
42
+ | `smc sync` | 同步配置 | 更新当前项目配置 |
43
+ | `smc agent "任务"` | Agent 协作 | 启动多 Agent 模式 |
44
+ | `smc skill:list` | 技能列表 | 查看可用技能 |
45
+ | `smc skill:create <name>` | 创建技能 | 创建新技能模板 |
46
+ | `smc kickoff` | 项目启动 | 生成项目规划文档 |
47
+
48
+ ---
49
+
50
+ ## 🎯 快速开始
8
51
 
9
52
  ### 1. 启动 Claude Code
10
53
 
@@ -46,28 +89,34 @@ Claude: 开始执行...
46
89
  | `/review` | 审查当前更改 | 提交前自查 |
47
90
  | `/verify-work` | 查看待验证任务 | 检查是否有遗漏 |
48
91
  | `/sessions` | 查看并行会话 | 多终端协作时 |
92
+ | `/todos` | 查看任务列表 | 查看 TODO 进度 |
93
+ | `/skill-create` | 创建新技能 | 扩展 Claude 能力 |
49
94
 
50
95
  ### 4. 典型工作流程
51
96
 
52
97
  ```
53
- 1. Plan 模式开始 (Shift+Tab 两次)
54
-
55
- 2. Claude 分析项目,制定计划
56
-
57
- 3. 你审查并确认计划
58
-
59
- 4. Claude 执行任务
60
-
61
- 5. /review 审查更改
62
-
63
- 6. /test 运行测试
64
-
65
- 7. /commit 创建提交
66
-
67
- 8. /commit-push-pr 推送并创建 PR
98
+ ┌─────────────────────────────────────────────────┐
99
+ │ 1. Plan 模式开始 (Shift+Tab 两次) │
100
+ │ ↓ │
101
+ │ 2. Claude 分析项目,制定计划 │
102
+ │ ↓ │
103
+ │ 3. 你审查并确认计划 │
104
+ │ ↓ │
105
+ │ 4. Claude 执行任务 │
106
+ │ ↓ │
107
+ │ 5. /review 审查更改 │
108
+ │ ↓ │
109
+ │ 6. /test 运行测试 │
110
+ │ ↓ │
111
+ │ 7. /commit 创建提交 │
112
+ │ ↓ │
113
+ │ 8. /commit-push-pr 推送并创建 PR │
114
+ └─────────────────────────────────────────────────┘
68
115
  ```
69
116
 
70
- ## 进阶技巧
117
+ ---
118
+
119
+ ## 🧠 进阶技巧
71
120
 
72
121
  ### 并行多会话工作
73
122
 
@@ -84,6 +133,13 @@ Claude: 开始执行...
84
133
  # 可以用 & 符号将会话传递到 Web
85
134
  ```
86
135
 
136
+ 使用 `smc agent` 可以自动协调多个 Agent:
137
+
138
+ ```bash
139
+ smc agent "重构用户认证模块"
140
+ # Claude 会自动分配 Conductor/Architect/Builder 任务
141
+ ```
142
+
87
143
  ### 验证反馈循环
88
144
 
89
145
  **重要**: 给 Claude 验证工作的方法,质量能提升 2-3 倍
@@ -97,46 +153,181 @@ Claude: [再次测试,通过]
97
153
  你: 好,提交吧
98
154
  ```
99
155
 
100
- ### 自动化功能
156
+ ### 自动化功能 (Hooks)
101
157
 
102
- 本项目已配置以下自动化:
158
+ 项目已配置以下自动化脚本:
103
159
 
104
- - **代码格式化**: 代码编辑后自动格式化
105
- - **验证提醒**: commit/push 后自动提醒验证
106
- - **会话追踪**: 自动记录对话历史
160
+ | Hook | 功能 |
161
+ |------|------|
162
+ | `code-formatter.cjs` | 代码编辑后自动格式化 |
163
+ | `todo-manager.cjs` | TODO 任务自动管理 |
164
+ | `verify-work.cjs` | commit/push 后自动提醒验证 |
165
+ | `thinking-silent.cjs` | ThinkingLens 静默思考 |
166
+ | `rag-skill-loader.cjs` | 动态加载技能 |
167
+ | `multi-session.cjs` | 多会话追踪 |
107
168
 
108
- ## 项目文件说明
169
+ ---
109
170
 
110
- | 文件/目录 | 说明 |
111
- |-----------|------|
112
- | `CLAUDE.md` | Claude 首先阅读的项目说明 |
113
- | `MEMORY.md` | AI 的增量记忆,自动更新 |
114
- | `PROJECT_LOG.md` | 完整的开发历史 |
115
- | `settings.json` | Claude Code 配置 |
116
- | `hooks/` | 自动化脚本 |
117
- | `commands/` | Slash 命令定义 |
118
- | `templates/` | 项目计划模板 |
171
+ ## 📁 项目文件说明
119
172
 
120
- ## 常见问题
173
+ ```
174
+ your-project/
175
+ ├── .claude/
176
+ │ ├── CLAUDE.md # ⭐ Claude 首先阅读,描述项目
177
+ │ ├── MEMORY.md # AI 增量记忆(自动更新)
178
+ │ ├── ANCHORS.md # 重要参考点
179
+ │ ├── settings.json # Claude Code 配置
180
+ │ ├── settings.local.json # 本地配置(不提交)
181
+ │ ├── hooks/ # 自动化脚本
182
+ │ ├── commands/ # Slash 命令定义
183
+ │ ├── skills/ # 技能模块
184
+ │ ├── templates/ # 项目模板
185
+ │ ├── rag/ # 技能索引
186
+ │ └── thinking-routes/ # 思考路线记录
187
+ ├── development/
188
+ │ └── todos/ # TODO 任务管理
189
+ │ ├── INDEX.md # 任务索引
190
+ │ ├── active/ # 进行中
191
+ │ ├── completed/ # 已完成
192
+ │ └── backlog/ # 待办
193
+ └── prompts/ # Prompt 模板
194
+ ```
195
+
196
+ ### 关键文件
197
+
198
+ | 文件 | 重要性 | 说明 |
199
+ |------|--------|------|
200
+ | `CLAUDE.md` | ⭐⭐⭐ | Claude 首先阅读,定义项目规范 |
201
+ | `MEMORY.md` | ⭐⭐ | AI 自动记录的项目记忆 |
202
+ | `settings.json` | ⭐⭐ | Claude Code 配置 |
203
+ | `hooks/` | ⭐⭐ | 自动化脚本 |
204
+ | `commands/` | ⭐ | 自定义 Slash 命令 |
205
+
206
+ ---
207
+
208
+ ## ❓ 常见问题
121
209
 
122
210
  ### Q: Claude 做错了怎么办?
123
211
 
124
- 将错误做法添加到 `CLAUDE.md`,Claude 会记住不再犯。
212
+ 将错误做法添加到 `CLAUDE.md`,Claude 会记住不再犯:
213
+
214
+ ```markdown
215
+ ## 禁止事项
216
+ - 不要在循环中使用 await
217
+ - 不要直接修改 state
218
+ ```
125
219
 
126
220
  ### Q: 如何查看对话历史?
127
221
 
128
- 查看 `.claude/thinking-routes/` 目录或 `PROJECT_LOG.md`。
222
+ ```bash
223
+ # 方法 1: 查看思考路线
224
+ cat .claude/thinking-routes/QUICKREF.md
225
+
226
+ # 方法 2: 查看项目日志
227
+ cat PROJECT_LOG.md
228
+
229
+ # 方法 3: 使用 smc
230
+ smc status
231
+ ```
129
232
 
130
233
  ### Q: 如何让多个项目共享配置?
131
234
 
132
- 将常用配置放入 `CLAUDE.md`,用 `oh-my-claude sync` 同步。
235
+ ```bash
236
+ # 更新 sumulige-claude 模板
237
+ cd ~/your-project
238
+ smc sync # 同步最新配置
239
+ ```
133
240
 
134
241
  ### Q: 权限提示太多怎么办?
135
242
 
136
- 使用 `/permissions` 预先允许常用命令,或编辑 `settings.local.json`。
243
+ 编辑 `.claude/settings.local.json`:
244
+
245
+ ```json
246
+ {
247
+ "permissions": {
248
+ "allow": ["npm test", "npm run *", "git *"]
249
+ }
250
+ }
251
+ ```
252
+
253
+ ### Q: 如何创建自定义技能?
254
+
255
+ ```bash
256
+ smc skill:create my-skill
257
+
258
+ # 或在 Claude Code 中
259
+ /skill-create my-skill
260
+ ```
261
+
262
+ ### Q: 如何更新 sumulige-claude?
263
+
264
+ ```bash
265
+ npm update -g sumulige-claude
266
+ smc sync # 同步新配置到项目
267
+ ```
268
+
269
+ ---
270
+
271
+ ## 🔗 获取帮助
272
+
273
+ ```bash
274
+ # 查看 SMC 帮助
275
+ smc --help
276
+
277
+ # 查看项目 README
278
+ cat README.md
279
+
280
+ # 查看优化指南
281
+ cat .claude/boris-optimizations.md
282
+
283
+ # Claude Code 内置帮助
284
+ /help
285
+ ```
286
+
287
+ ---
288
+
289
+ ## 📊 使用流程图
290
+
291
+ ```
292
+ ┌─────────────────────────────────────────────────────────────┐
293
+ │ 首次安装 │
294
+ ├─────────────────────────────────────────────────────────────┤
295
+ │ npm install -g sumulige-claude │
296
+ │ ↓ │
297
+ │ smc init │
298
+ │ ↓ │
299
+ │ smc status ← 验证安装成功 │
300
+ └─────────────────────────────────────────────────────────────┘
301
+
302
+ ┌─────────────────────────────────────────────────────────────┐
303
+ │ 每个新项目 │
304
+ ├─────────────────────────────────────────────────────────────┤
305
+ │ cd my-project │
306
+ │ ↓ │
307
+ │ smc template ← 复制模板 │
308
+ │ ↓ │
309
+ │ 编辑 .claude/CLAUDE.md ← 描述项目信息 │
310
+ │ ↓ │
311
+ │ claude ← 启动 Claude Code │
312
+ │ ↓ │
313
+ │ Shift+Tab 两次 ← Plan 模式 │
314
+ │ ↓ │
315
+ │ 开始工作... │
316
+ └─────────────────────────────────────────────────────────────┘
317
+
318
+ ┌─────────────────────────────────────────────────────────────┐
319
+ │ 日常开发 │
320
+ ├─────────────────────────────────────────────────────────────┤
321
+ │ claude # 启动 │
322
+ │ /commit # 提交代码 │
323
+ │ /test # 运行测试 │
324
+ │ /review # 审查更改 │
325
+ │ /commit-push-pr # 推送 + 创建 PR │
326
+ │ /todos # 查看任务 │
327
+ │ smc agent "任务描述" # 多 Agent 协作 │
328
+ └─────────────────────────────────────────────────────────────┘
329
+ ```
137
330
 
138
- ## 获取帮助
331
+ ---
139
332
 
140
- - 查看项目根 README: `cat README.md`
141
- - 查看优化指南: `cat .claude/boris-optimizations.md`
142
- - 查看命令帮助: 在 Claude Code 中输入 `/help`
333
+ > 💡 **提示**: 记得经常更新 `CLAUDE.md`,它是 Claude 理解你项目的关键!