sumulige-claude 1.0.2 → 1.0.3
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/PROJECT_STRUCTURE.md +220 -0
- package/Q&A.md +124 -0
- package/package.json +1 -1
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
# Sumulige Claude 项目详解
|
|
2
|
+
|
|
3
|
+
> **Claude Code 多 Agent 编排框架** - 专为 AI 理解优化
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 📌 项目定位
|
|
8
|
+
|
|
9
|
+
**Sumulige Claude** 是一个 **Claude Code 多 Agent 编排框架**，核心目标是让 AI 辅助开发更智能、更高效。
|
|
10
|
+
|
|
11
|
+
基于 CLI 的 AI 辅助开发与管理系统（包含技能库、RAG 索引、任务追踪等）。
|
|
12
|
+
|
|
13
|
+
### 核心功能
|
|
14
|
+
|
|
15
|
+
| 功能 | 描述 |
|
|
16
|
+
|------|------|
|
|
17
|
+
| **多 Agent 协作** | 5个专业化 Agent（Conductor/Architect/Builder/Reviewer/Librarian）分工协作 |
|
|
18
|
+
| **技能系统** | 可复用的 Claude Skills 管理（安装/创建/依赖检查） |
|
|
19
|
+
| **项目模板** | 一键部署完整的 Claude Code 项目配置 |
|
|
20
|
+
| **TODO 管理** | 按优先级分组的 AI 自动维护任务系统 |
|
|
21
|
+
| **ThinkingLens** | 对话追踪和增量记忆系统 |
|
|
22
|
+
|
|
23
|
+
### Agent 角色说明
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
27
|
+
│ Agent 团队架构 │
|
|
28
|
+
├─────────────────────────────────────────────────────────────┤
|
|
29
|
+
│ Conductor → 任务分解和协调（项目经理） │
|
|
30
|
+
│ Architect → 架构设计和技术决策（架构师） │
|
|
31
|
+
│ Builder → 代码实现和测试（工程师） │
|
|
32
|
+
│ Reviewer → 代码审查和质量检查（审查员） │
|
|
33
|
+
│ Librarian → 文档编写和知识整理（文档员） │
|
|
34
|
+
└─────────────────────────────────────────────────────────────┘
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 📁 项目结构 ASCII 树
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
sumulige-claude/
|
|
43
|
+
├── .claude/ # CLI 工具自身的 Claude Code 配置
|
|
44
|
+
│ ├── rag/ # RAG 技能索引
|
|
45
|
+
│ ├── sessions/ # 会话追踪
|
|
46
|
+
│ ├── skills/ # 内置技能
|
|
47
|
+
│ │ └── api-tester/ # API 测试技能示例
|
|
48
|
+
│ ├── AGENTS.md # Agent 配置
|
|
49
|
+
│ ├── README.md # Claude 项目说明
|
|
50
|
+
│ └── settings.local.json # 本地配置
|
|
51
|
+
│
|
|
52
|
+
├── development/ # 开发任务管理
|
|
53
|
+
│ └── todos/ # TODO 任务系统（GTD 风格）
|
|
54
|
+
│ ├── active/ # 🚧 进行中任务
|
|
55
|
+
│ ├── backlog/ # 📋 待办任务
|
|
56
|
+
│ ├── completed/ # ✅ 已完成任务
|
|
57
|
+
│ ├── archived/ # 📦 已归档任务
|
|
58
|
+
│ └── INDEX.md # 任务总览（可点击跳转）
|
|
59
|
+
│
|
|
60
|
+
├── template/ # ⭐ 项目模板（smc template 部署）
|
|
61
|
+
│ ├── .claude/ # Claude Code 完整配置
|
|
62
|
+
│ │ ├── commands/ # Slash 命令（9个）
|
|
63
|
+
│ │ │ ├── commit-push-pr.md # /commit-push-pr
|
|
64
|
+
│ │ │ ├── commit.md # /commit
|
|
65
|
+
│ │ │ ├── pr.md # /pr
|
|
66
|
+
│ │ │ ├── review.md # /review
|
|
67
|
+
│ │ │ ├── sessions.md # /sessions
|
|
68
|
+
│ │ │ ├── skill-create.md # /skill-create
|
|
69
|
+
│ │ │ ├── test.md # /test
|
|
70
|
+
│ │ │ ├── todos.md # /todos
|
|
71
|
+
│ │ │ └── verify-work.md # /verify-work
|
|
72
|
+
│ │ │
|
|
73
|
+
│ │ ├── hooks/ # 自动化 Hook 脚本
|
|
74
|
+
│ │ │
|
|
75
|
+
│ │ ├── rag/ # RAG 技能索引
|
|
76
|
+
│ │ │ └── skill-index.json # 20+ 技能索引（支持关键词匹配）
|
|
77
|
+
│ │ │
|
|
78
|
+
│ │ ├── skills/ # 项目技能库
|
|
79
|
+
│ │ │ ├── examples/ # 示例技能
|
|
80
|
+
│ │ │ ├── manus-kickoff/ # Manus 风格项目启动技能
|
|
81
|
+
│ │ │ ├── template/ # 技能创建模板
|
|
82
|
+
│ │ │ └── SKILLS.md # 技能索引说明
|
|
83
|
+
│ │ │
|
|
84
|
+
│ │ ├── templates/ # 项目文档模板
|
|
85
|
+
│ │ │ ├── PROJECT_KICKOFF.md # 项目启动清单
|
|
86
|
+
│ │ │ ├── PROJECT_PROPOSAL.md # 项目计划书模板
|
|
87
|
+
│ │ │ └── TASK_PLAN.md # 任务执行计划模板
|
|
88
|
+
│ │ │
|
|
89
|
+
│ │ ├── thinking-routes/ # 思维轨迹系统
|
|
90
|
+
│ │ │
|
|
91
|
+
│ │ ├── CLAUDE-template.md # CLAUDE.md 模板
|
|
92
|
+
│ │ ├── README.md # 项目说明（AI 首先读取）
|
|
93
|
+
│ │ ├── boris-optimizations.md # Boris 最佳实践
|
|
94
|
+
│ │ └── settings.json # Claude Code 设置
|
|
95
|
+
│ │
|
|
96
|
+
│ ├── development/ # 开发任务管理模板
|
|
97
|
+
│ │ └── todos/ # TODO 系统模板
|
|
98
|
+
│ │
|
|
99
|
+
│ ├── prompts/ # 教学资源
|
|
100
|
+
│ │ └── how-to-find.md # 对话查找指南
|
|
101
|
+
│ │
|
|
102
|
+
│ ├── CLAUDE-template.md # CLAUDE.md 模板
|
|
103
|
+
│ ├── README.md # 模板说明
|
|
104
|
+
│ ├── init.sh # 初始化脚本
|
|
105
|
+
│ ├── project-paradigm.md # 项目开发范式
|
|
106
|
+
│ └── thinkinglens-silent.md # ThinkingLens 静默指令
|
|
107
|
+
│
|
|
108
|
+
├── cli.js # ⭐ CLI 核心入口（Node.js）
|
|
109
|
+
├── package.json # npm 包配置
|
|
110
|
+
├── package-lock.json # 依赖锁定
|
|
111
|
+
├── AGENTS.md # Agent 配置说明
|
|
112
|
+
├── README.md # 项目文档（858 行）
|
|
113
|
+
├── PROJECT_STRUCTURE.md # 本文件
|
|
114
|
+
└── .gitignore # Git 忽略规则
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## 🔧 CLI 命令速查
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
smc (sumulige-claude 简写)
|
|
123
|
+
├── init # 初始化配置 (~/.claude/config.json)
|
|
124
|
+
├── status # 查看状态（Agents/Skills/Tasks）
|
|
125
|
+
├── sync # 同步配置到项目
|
|
126
|
+
├── template [path] # 部署项目模板
|
|
127
|
+
├── kickoff # Manus 风格项目规划启动
|
|
128
|
+
│
|
|
129
|
+
├── skill:list # 列出所有技能
|
|
130
|
+
├── skill:create <name> # 创建新技能
|
|
131
|
+
├── skill:check [name] # 检查技能依赖
|
|
132
|
+
├── skill:install <src> # 安装外部技能
|
|
133
|
+
│
|
|
134
|
+
└── agent <task> # 启动 Agent 编排
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## 📊 关键数据结构
|
|
140
|
+
|
|
141
|
+
### 配置文件结构 (`~/.claude/config.json`)
|
|
142
|
+
|
|
143
|
+
```json
|
|
144
|
+
{
|
|
145
|
+
"version": "1.0.0",
|
|
146
|
+
"agents": {
|
|
147
|
+
"conductor": { "model": "claude-opus-4.5", "role": "Task coordination" },
|
|
148
|
+
"architect": { "model": "claude-opus-4.5", "role": "Architecture design" },
|
|
149
|
+
"builder": { "model": "claude-opus-4.5", "role": "Code implementation" },
|
|
150
|
+
"reviewer": { "model": "claude-opus-4.5", "role": "Code review" },
|
|
151
|
+
"librarian": { "model": "claude-opus-4.5", "role": "Documentation" }
|
|
152
|
+
},
|
|
153
|
+
"skills": ["anthropics/skills", "numman-ali/n-skills"],
|
|
154
|
+
"thinkingLens": { "enabled": true, "autoSync": true, "syncInterval": 20 }
|
|
155
|
+
}
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### RAG 技能索引结构 (`skill-index.json`)
|
|
159
|
+
|
|
160
|
+
```json
|
|
161
|
+
{
|
|
162
|
+
"skills": [
|
|
163
|
+
{
|
|
164
|
+
"name": "frontend-design",
|
|
165
|
+
"keywords": ["frontend", "ui", "react"],
|
|
166
|
+
"description": "前端界面设计"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"name": "mcp-builder",
|
|
170
|
+
"keywords": ["api", "mcp", "server"],
|
|
171
|
+
"description": "MCP 服务器构建"
|
|
172
|
+
}
|
|
173
|
+
]
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## 🔄 工作流程图
|
|
180
|
+
|
|
181
|
+
```
|
|
182
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
183
|
+
│ Manus 风格工作流 │
|
|
184
|
+
├─────────────────────────────────────────────────────────────┤
|
|
185
|
+
│ │
|
|
186
|
+
│ 1. smc template → 部署项目模板 │
|
|
187
|
+
│ ↓ │
|
|
188
|
+
│ 2. smc kickoff → AI 生成 TASK_PLAN.md │
|
|
189
|
+
│ ↓ │
|
|
190
|
+
│ 3. Human 确认 → 审批项目计划 │
|
|
191
|
+
│ ↓ │
|
|
192
|
+
│ 4. Agent 协作执行 → Conductor 分配 → Builder 实现 │
|
|
193
|
+
│ ↓ │
|
|
194
|
+
│ 5. ThinkingLens → 自动记录 MEMORY.md + PROJECT_LOG │
|
|
195
|
+
│ │
|
|
196
|
+
└─────────────────────────────────────────────────────────────┘
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## 🎯 AI 理解要点
|
|
202
|
+
|
|
203
|
+
1. **入口文件**: `cli.js` 是 Node.js CLI 工具，通过 npm 全局安装后使用 `smc` 命令
|
|
204
|
+
2. **模板目录**: `template/` 包含完整的 Claude Code 项目配置，通过 `smc template` 复制到目标项目
|
|
205
|
+
3. **技能系统**: 基于 markdown 文件定义，存储在 `.claude/skills/` 目录
|
|
206
|
+
4. **TODO 系统**: 采用文件夹分组（active/backlog/completed/archived）+ INDEX.md 索引
|
|
207
|
+
5. **RAG 索引**: `skill-index.json` 支持关键词自动匹配技能
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## 📦 技术栈
|
|
212
|
+
|
|
213
|
+
- **运行环境**: Node.js
|
|
214
|
+
- **包管理**: npm
|
|
215
|
+
- **发布平台**: [npmjs.com/package/sumulige-claude](https://www.npmjs.com/package/sumulige-claude)
|
|
216
|
+
- **源码仓库**: [github.com/sumulige/sumulige-claude](https://github.com/sumulige/sumulige-claude)
|
|
217
|
+
|
|
218
|
+
---
|
|
219
|
+
|
|
220
|
+
*Generated: 2026-01-13*
|
package/Q&A.md
ADDED
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# Sumulige Claude 常见问题
|
|
2
|
+
|
|
3
|
+
> 帮助你快速理解项目的核心设计理念
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Q1: 为什么要把 sumulige-claude 保留在项目中？
|
|
8
|
+
|
|
9
|
+
### 🔑 一句话答案
|
|
10
|
+
**它不是"工具"，是"数字合伙人"**——需要跟随项目一起成长。
|
|
11
|
+
|
|
12
|
+
### 📊 对比理解
|
|
13
|
+
|
|
14
|
+
| 普通 CLI 工具 | Sumulige Claude |
|
|
15
|
+
|--------------|-----------------|
|
|
16
|
+
| 全局安装，到处通用 | 嵌入项目，专属定制 |
|
|
17
|
+
| 静态能力，版本固定 | 动态进化，持续学习 |
|
|
18
|
+
| 扳手（用完即走） | 副驾驶（全程陪伴） |
|
|
19
|
+
|
|
20
|
+
### 💡 四大设计深意
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
24
|
+
│ 1️⃣ 共同进化 │
|
|
25
|
+
│ Agent 技能随业务逻辑同步迭代 │
|
|
26
|
+
│ 修改算法 → 同步更新 review 技能 │
|
|
27
|
+
├─────────────────────────────────────────────────────────────┤
|
|
28
|
+
│ 2️⃣ 上下文记忆 │
|
|
29
|
+
│ .claude/rag/ 是 Agent 的"海马体" │
|
|
30
|
+
│ 项目架构决策 → 长期记忆沉淀 │
|
|
31
|
+
├─────────────────────────────────────────────────────────────┤
|
|
32
|
+
│ 3️⃣ 团队一致性 │
|
|
33
|
+
│ 工具链即代码 (Toolchain as Code) │
|
|
34
|
+
│ git clone → pnpm install → 获得一致的 AI 环境 │
|
|
35
|
+
├─────────────────────────────────────────────────────────────┤
|
|
36
|
+
│ 4️⃣ 构建联动 │
|
|
37
|
+
│ 修改共享类型 → 自动触发 Agent 重新构建 │
|
|
38
|
+
│ 确保 AI 永不基于过时定义生成代码 │
|
|
39
|
+
└─────────────────────────────────────────────────────────────┘
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Q2: 根目录 `.claude/` 和 `template/.claude/` 有什么区别？
|
|
45
|
+
|
|
46
|
+
### 🔑 一句话答案
|
|
47
|
+
**`template/` 是"工厂"，根目录 `.claude/` 是"产品"。**
|
|
48
|
+
|
|
49
|
+
### � 类比理解
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
template/.claude/ xxx/.claude/
|
|
53
|
+
│ │
|
|
54
|
+
▼ ▼
|
|
55
|
+
🏭 安装光盘 💾 存档文件
|
|
56
|
+
🎓 毕业证书模板 📝 你的毕业证
|
|
57
|
+
🧬 DNA 模板 🧑 具体的人
|
|
58
|
+
📘 类定义 (Class) 📦 实例 (Instance)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### 🔍 详细对比
|
|
62
|
+
|
|
63
|
+
| 特性 | **根目录 `.claude/`** | **template/.claude/** |
|
|
64
|
+
|------|----------------------|----------------------|
|
|
65
|
+
| **性质** | 实例 (Instance) | 模板 (Blueprint) |
|
|
66
|
+
| **状态** | ✅ 有状态 | ❌ 无状态 |
|
|
67
|
+
| **内容** | sessions/, 本地配置, 项目 RAG | commands/, skills/, thinking-routes/ |
|
|
68
|
+
| **作用** | 记录"聊过什么" | 定义"能做什么" |
|
|
69
|
+
| **Git** | 部分忽略 (sessions/) | 完整提交 |
|
|
70
|
+
| **生命周期** | 随项目存在 | 发布即固化 |
|
|
71
|
+
|
|
72
|
+
### 🔄 工作流程
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
┌────────────────┐ smc template ┌────────────────┐
|
|
76
|
+
│ │ ─────────────────▶ │ │
|
|
77
|
+
│ template/ │ │ xxx/ │
|
|
78
|
+
│ .claude/ │ 复制模板 │ .claude/ │
|
|
79
|
+
│ ├─commands/ │ ─────────────────▶ │ ├─commands/ │
|
|
80
|
+
│ ├─skills/ │ │ ├─skills/ │
|
|
81
|
+
│ └─... │ │ ├─sessions/ │ ← 新增：对话记忆
|
|
82
|
+
│ │ │ ├─rag/ │ ← 新增：项目知识
|
|
83
|
+
│ │ │ └─... │
|
|
84
|
+
└────────────────┘ └────────────────┘
|
|
85
|
+
工厂 产品
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### 💡 设计优势
|
|
89
|
+
|
|
90
|
+
| 优势 | 说明 |
|
|
91
|
+
|------|------|
|
|
92
|
+
| **升级解耦** | 更新 template/ → 发布新版 → 用户项目历史不丢失 |
|
|
93
|
+
| **标准化** | 每个新项目自动获得最佳实践配置 |
|
|
94
|
+
| **隔离性** | 项目 A 的对话记忆不会污染项目 B |
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## 总结：一张图看懂架构
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
102
|
+
│ Sumulige Claude 架构 │
|
|
103
|
+
├─────────────────────────────────────────────────────────────┤
|
|
104
|
+
│ │
|
|
105
|
+
│ ┌──────────────────┐ ┌──────────────────┐ │
|
|
106
|
+
│ │ sumulige-claude │ │ 你的项目 │ │
|
|
107
|
+
│ │ (npm 全局安装) │ │ (xxx/) │ │
|
|
108
|
+
│ ├──────────────────┤ ├──────────────────┤ │
|
|
109
|
+
│ │ cli.js │──smc───▶│ .claude/ │ │
|
|
110
|
+
│ │ template/ │ template │ ├─ commands/ │ │
|
|
111
|
+
│ │ └─.claude/ │──────────│ ├─ skills/ │ │
|
|
112
|
+
│ │ ├─commands/ │ 复制 │ ├─ sessions/ │ 记忆 │
|
|
113
|
+
│ │ ├─skills/ │ │ ├─ rag/ │ 知识 │
|
|
114
|
+
│ │ └─templates/ │ │ └─ settings │ 配置 │
|
|
115
|
+
│ └──────────────────┘ └──────────────────┘ │
|
|
116
|
+
│ 能力定义 运行实例 │
|
|
117
|
+
│ (无状态) (有状态) │
|
|
118
|
+
│ │
|
|
119
|
+
└─────────────────────────────────────────────────────────────┘
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
*更多问题？查看 [README.md](./README.md)*
|