Skip to content

Commit c7d7035

Browse files
qdrivenqdriven
committed
update docs
1 parent 4de1b73 commit c7d7035

10 files changed

Lines changed: 108 additions & 104 deletions

File tree

‎AGENTS.md‎

Lines changed: 47 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ spark git gitcode # 添加 Gitcode 远程
9898
spark git config # 配置 Git 用户
9999
spark git url # 获取仓库 URL
100100
spark git batch-clone # 克隆用户/组织所有仓库
101+
spark git issues # 从 Markdown 文档/任务创建 GitHub Issue
101102
```
102103

103104
#### `spark git update`
@@ -173,14 +174,14 @@ spark git url # 当前目录
173174
spark git url /path/to/repo
174175
```
175176

176-
#### `spark git clone-org`
177-
克隆 GitHub 组织的所有仓库到本地。
177+
#### `spark git batch-clone`
178+
克隆 GitHub 组织或个人账号的所有仓库到本地。
178179

179180
```bash
180-
spark git clone-org variableway # 使用组织名
181-
spark git clone-org https://github.com/variableway # 使用 URL
182-
spark git clone-org variableway --ssh # 使用 SSH
183-
spark git clone-org variableway -o ./repos # 指定输出目录
181+
spark git batch-clone variableway # 使用组织名
182+
spark git batch-clone https://github.com/variableway # 使用 URL
183+
spark git batch-clone variableway --ssh # 使用 SSH
184+
spark git batch-clone variableway -o ./repos # 指定输出目录
184185
```
185186

186187
| 选项 | 说明 |
@@ -191,6 +192,28 @@ spark git clone-org variableway -o ./repos # 指定输出目录
191192
| `--include-forks` | 包含 fork 的仓库 |
192193
| `-o, --output` | 输出目录 (默认: 当前目录) |
193194

195+
#### `spark git issues`
196+
从 Markdown 创建 GitHub Issue，支持目录模式和任务文件模式。
197+
198+
```bash
199+
# 目录模式：目录下每个 .md 文件创建一个 Issue
200+
spark git issues -d ./docs -r owner/repo
201+
202+
# 任务模式：按 # Task / ## Task 分段创建 Issue
203+
spark git issues -f tasks/issues/task-bug-fix.md -r owner/repo
204+
205+
# 自动从当前仓库解析 owner/repo
206+
spark git issues -f tasks/issues/task-bug-fix.md --dry-run
207+
```
208+
209+
| 选项 | 说明 |
210+
|------|------|
211+
| `-r, --repo` | 目标仓库（`owner/repo`），未指定时自动解析 |
212+
| `-d, --dir` | Markdown 目录（目录模式） |
213+
| `-f, --file` | 任务文件（任务模式） |
214+
| `-l, --labels` | Issue 标签（逗号分隔） |
215+
| `--dry-run` | 仅预览，不创建 Issue |
216+
194217
#### `spark git update-org-status`
195218
获取 GitHub 组织的所有仓库信息，按 star 数量排序，并更新到 README.md。
196219

@@ -276,7 +299,7 @@ spark:
276299

277300
### AI Agent 管理 (已禁用)
278301

279-
> ⚠️ 此功能当前已禁用，命令入口已关闭（`cmd/agent.go` 中 `rootCmd.AddCommand(agentCmd)` 已注释）。待后续重新设计后再启用。
302+
> NOTE: 此功能当前已禁用，命令入口已关闭（`cmd/agent.go` 中 `rootCmd.AddCommand(agentCmd)` 已注释）。待后续重新设计后再启用。
280303

281304
#### `spark agent`
282305
管理多种 AI Agent 的配置文件。
@@ -306,25 +329,25 @@ spark agent current # 查看当前项目使用的模板
306329
### 任务管理
307330

308331
#### `spark task`
309-
任务管理和特性实现命令。
332+
任务管理和 issue 实现命令。
310333

311334
```bash
312335
# 初始化任务目录结构
313336
spark task init # 创建 tasks/ 目录结构
314337
315-
# 列出所有任务和特性
316-
spark task list # 列出任务目录和特性文件
338+
# 列出所有任务和 issue
339+
spark task list # 列出任务目录和 issue 文件
317340
318-
# 创建新特性
319-
spark task create my-feature # 创建 tasks/features/my-feature.md
341+
# 创建新 issue
342+
spark task create my-feature # 创建 tasks/issues/my-feature.md
320343
spark task create my-feature --content "Custom description"
321344
322-
# 删除特性
323-
spark task delete my-feature # 删除特性文件
345+
# 删除 issue
346+
spark task delete my-feature # 删除 issue 文件
324347
spark task delete my-feature --force # 强制删除不提示
325348
326-
# 实现特性（使用 kimi CLI）
327-
spark task impl my-feature # 执行特性实现
349+
# 实现 issue（使用 kimi CLI）
350+
spark task impl my-feature # 执行 issue 实现
328351
329352
# 分发和同步任务
330353
spark task dispatch my-task --dest ./workspace
@@ -334,23 +357,23 @@ spark task sync my-task --work-path ./workspace
334357
| 子命令 | 说明 |
335358
|--------|------|
336359
| `init` | 初始化任务目录结构 |
337-
| `list` | 列出所有任务和特性 |
338-
| `create` | 创建新特性文件（文件名空格自动转换为 `-`）|
339-
| `delete` | 删除特性文件 |
340-
| `impl` | 实现特性（使用 kimi CLI）|
360+
| `list` | 列出所有任务和 issue |
361+
| `create` | 创建新 issue 文件（文件名空格自动转换为 `-`）|
362+
| `delete` | 删除 issue 文件 |
363+
| `impl` | 实现 issue（使用 kimi CLI）|
341364
| `dispatch` | 分发任务到新目录 |
342365
| `sync` | 同步任务回任务目录 |
343366

344-
**特性文件创建说明**:
367+
**Issue 文件创建说明**:
345368
- 文件名中的空格和下划线会自动转换为 `-`
346369
- `--content` 参数的内容会写入 `## 描述` section
347-
- 如果存在 `example-feature.md`，会将其作为模板
370+
- 如果存在 `example-issue.md`，会将其作为模板
348371

349372
**任务目录结构**:
350373
```
351374
tasks/
352-
├── example-feature.md # 示例特性模板
353-
├── features/ # 特性文件目录
375+
├── example-issue.md # 示例 issue 模板
376+
├── issues/ # issue 文件目录
354377
├── config/ # 配置任务目录
355378
├── analysis/ # 分析任务目录
356379
├── mindstorm/ # 头脑风暴目录

‎README.md‎

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -87,20 +87,7 @@ go test ./internal/git/... -v -run TestFunctionName
8787

8888
### spark agent — AI Agent Configuration
8989

90-
| Command | Description |
91-
|---------|-------------|
92-
| `spark agent list` | List supported agents |
93-
| `spark agent view <agent>` | View agent config files |
94-
| `spark agent edit <agent> [index]` | Edit agent config in editor |
95-
| `spark agent reset <agent>` | Reset agent config |
96-
| `spark agent profile list` | List config profiles |
97-
| `spark agent profile add <name> -t <type>` | Add new profile |
98-
| `spark agent profile show <name>` | Show profile config |
99-
| `spark agent profile edit <name> [index]` | Edit profile config |
100-
| `spark agent use <profile> [-p <dir>]` | Apply profile to project |
101-
| `spark agent current [-p <dir>]` | Show active profile |
102-
103-
Supported agents: `claude-code`, `codex`, `kimi`, `glm`
90+
Currently disabled in command registration. The `spark agent` entry is not added to root command.
10491

10592
---
10693

‎docs/Agents.md‎

Lines changed: 50 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
2. **Mono-repo 管理** - 将多个仓库添加为子模块，统一管理
1111
3. **子模块同步** - 同步 Mono 仓库中的所有子模块
1212
4. **Git 用户配置** - 配置仓库的 Git 用户信息
13-
5. **AI Agent 配置管理** - 管理多种 AI Agent（Claude Code、Codex、Kimi、GLM）的配置文件
13+
5. ~~**AI Agent 配置管理** - 管理多种 AI Agent（Claude Code、Codex、Kimi、GLM）的配置文件~~ (已禁用，待重新设计)
1414
6. **任务管理** - 任务分发、同步和 GitHub 仓库创建
1515
7. **Gitcode 远程管理** - 为仓库添加 Gitcode 远程地址
1616

@@ -98,6 +98,7 @@ spark git gitcode # 添加 Gitcode 远程
9898
spark git config # 配置 Git 用户
9999
spark git url # 获取仓库 URL
100100
spark git batch-clone # 克隆用户/组织所有仓库
101+
spark git issues # 从 Markdown 文档/任务创建 GitHub Issue
101102
```
102103

103104
#### `spark git update`
@@ -164,14 +165,14 @@ spark git url # 当前目录
164165
spark git url /path/to/repo
165166
```
166167

167-
#### `spark git clone-org`
168-
克隆 GitHub 组织的所有仓库到本地。
168+
#### `spark git batch-clone`
169+
克隆 GitHub 组织或个人账号的所有仓库到本地。
169170

170171
```bash
171-
spark git clone-org variableway # 使用组织名
172-
spark git clone-org https://github.com/variableway # 使用 URL
173-
spark git clone-org variableway --ssh # 使用 SSH
174-
spark git clone-org variableway -o ./repos # 指定输出目录
172+
spark git batch-clone variableway # 使用组织名
173+
spark git batch-clone https://github.com/variableway # 使用 URL
174+
spark git batch-clone variableway --ssh # 使用 SSH
175+
spark git batch-clone variableway -o ./repos # 指定输出目录
175176
```
176177

177178
| 选项 | 说明 |
@@ -182,6 +183,28 @@ spark git clone-org variableway -o ./repos # 指定输出目录
182183
| `--include-forks` | 包含 fork 的仓库 |
183184
| `-o, --output` | 输出目录 (默认: 当前目录) |
184185

186+
#### `spark git issues`
187+
从 Markdown 创建 GitHub Issue，支持目录模式和任务文件模式。
188+
189+
```bash
190+
# 目录模式：目录下每个 .md 文件创建一个 Issue
191+
spark git issues -d ./docs -r owner/repo
192+
193+
# 任务模式：按 # Task / ## Task 分段创建 Issue
194+
spark git issues -f tasks/issues/task-bug-fix.md -r owner/repo
195+
196+
# 自动从当前仓库解析 owner/repo
197+
spark git issues -f tasks/issues/task-bug-fix.md --dry-run
198+
```
199+
200+
| 选项 | 说明 |
201+
|------|------|
202+
| `-r, --repo` | 目标仓库（`owner/repo`），未指定时自动解析 |
203+
| `-d, --dir` | Markdown 目录（目录模式） |
204+
| `-f, --file` | 任务文件（任务模式） |
205+
| `-l, --labels` | Issue 标签（逗号分隔） |
206+
| `--dry-run` | 仅预览，不创建 Issue |
207+
185208
#### `spark git update-org-status`
186209
获取 GitHub 组织的所有仓库信息，按 star 数量排序，并更新到 README.md。
187210

@@ -265,7 +288,9 @@ spark:
265288

266289
**跨平台支持**: Mac、Linux、Windows
267290

268-
### AI Agent 管理
291+
### AI Agent 管理 (已禁用)
292+
293+
> NOTE: 此功能当前已禁用，命令入口已关闭（`cmd/agent.go` 中 `rootCmd.AddCommand(agentCmd)` 已注释）。待后续重新设计后再启用。
269294

270295
#### `spark agent`
271296
管理多种 AI Agent 的配置文件。
@@ -295,25 +320,25 @@ spark agent current # 查看当前项目使用的模板
295320
### 任务管理
296321

297322
#### `spark task`
298-
任务管理和特性实现命令。
323+
任务管理和 issue 实现命令。
299324

300325
```bash
301326
# 初始化任务目录结构
302327
spark task init # 创建 tasks/ 目录结构
303328
304-
# 列出所有任务和特性
305-
spark task list # 列出任务目录和特性文件
329+
# 列出所有任务和 issue
330+
spark task list # 列出任务目录和 issue 文件
306331
307-
# 创建新特性
308-
spark task create my-feature # 创建 tasks/features/my-feature.md
332+
# 创建新 issue
333+
spark task create my-feature # 创建 tasks/issues/my-feature.md
309334
spark task create my-feature --content "Custom description"
310335
311-
# 删除特性
312-
spark task delete my-feature # 删除特性文件
336+
# 删除 issue
337+
spark task delete my-feature # 删除 issue 文件
313338
spark task delete my-feature --force # 强制删除不提示
314339
315-
# 实现特性（使用 kimi CLI）
316-
spark task impl my-feature # 执行特性实现
340+
# 实现 issue（使用 kimi CLI）
341+
spark task impl my-feature # 执行 issue 实现
317342
318343
# 分发和同步任务
319344
spark task dispatch my-task --dest ./workspace
@@ -323,23 +348,23 @@ spark task sync my-task --work-path ./workspace
323348
| 子命令 | 说明 |
324349
|--------|------|
325350
| `init` | 初始化任务目录结构 |
326-
| `list` | 列出所有任务和特性 |
327-
| `create` | 创建新特性文件（文件名空格自动转换为 `-`）|
328-
| `delete` | 删除特性文件 |
329-
| `impl` | 实现特性（使用 kimi CLI）|
351+
| `list` | 列出所有任务和 issue |
352+
| `create` | 创建新 issue 文件（文件名空格自动转换为 `-`）|
353+
| `delete` | 删除 issue 文件 |
354+
| `impl` | 实现 issue（使用 kimi CLI）|
330355
| `dispatch` | 分发任务到新目录 |
331356
| `sync` | 同步任务回任务目录 |
332357

333-
**特性文件创建说明**:
358+
**Issue 文件创建说明**:
334359
- 文件名中的空格和下划线会自动转换为 `-`
335360
- `--content` 参数的内容会写入 `## 描述` section
336-
- 如果存在 `example-feature.md`，会将其作为模板
361+
- 如果存在 `example-issue.md`，会将其作为模板
337362

338363
**任务目录结构**:
339364
```
340365
tasks/
341-
├── example-feature.md # 示例特性模板
342-
├── features/ # 特性文件目录
366+
├── example-issue.md # 示例 issue 模板
367+
├── issues/ # issue 文件目录
343368
├── config/ # 配置任务目录
344369
├── analysis/ # 分析任务目录
345370
├── mindstorm/ # 头脑风暴目录

‎docs/README.md‎

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -87,20 +87,7 @@ go test ./internal/git/... -v -run TestFunctionName
8787

8888
### spark agent — AI Agent Configuration
8989

90-
| Command | Description |
91-
|---------|-------------|
92-
| `spark agent list` | List supported agents |
93-
| `spark agent view <agent>` | View agent config files |
94-
| `spark agent edit <agent> [index]` | Edit agent config in editor |
95-
| `spark agent reset <agent>` | Reset agent config |
96-
| `spark agent profile list` | List config profiles |
97-
| `spark agent profile add <name> -t <type>` | Add new profile |
98-
| `spark agent profile show <name>` | Show profile config |
99-
| `spark agent profile edit <name> [index]` | Edit profile config |
100-
| `spark agent use <profile> [-p <dir>]` | Apply profile to project |
101-
| `spark agent current [-p <dir>]` | Show active profile |
102-
103-
Supported agents: `claude-code`, `codex`, `kimi`, `glm`
90+
Currently disabled in command registration. The `spark agent` entry is not added to root command.
10491

10592
---
10693

‎docs/features/git.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ spark git update-org-status variableway --update-dot-github
6565
spark git issues -d ./docs -r variableway/spark-cli
6666

6767
# 任务模式
68-
spark git issues -f tasks/features/task-bug-fix.md -r variableway/spark-cli
68+
spark git issues -f tasks/issues/task-bug-fix.md -r variableway/spark-cli
6969

7070
# 自动识别当前仓库 + 预览
71-
spark git issues -f tasks/features/task-bug-fix.md --dry-run
71+
spark git issues -f tasks/issues/task-bug-fix.md --dry-run
7272
```
7373

7474
## 使用参数

‎docs/features/task.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 功能概述
44

5-
`spark task` 提供任务的全生命周期管理：创建、实现、分发、同步。支持通过 AI Agent（kimi CLI）自动实现特性，并将任务分发到独立工作目录进行开发。
5+
`spark task` 提供任务的全生命周期管理：创建、实现、分发、同步。支持通过 AI Agent（kimi CLI）自动实现 issue，并将任务分发到独立工作目录进行开发。
66

77
## 核心能力
88

@@ -14,7 +14,7 @@
1414
spark task init
1515
```
1616

17-
### 特性文件管理
17+
### Issue 文件管理
1818

1919
创建、列出、删除 issue 描述文件。issue 文件是 Markdown 格式的任务描述。
2020

‎docs/index.md‎

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -92,20 +92,7 @@ go test ./internal/git/... -v -run TestFunctionName
9292

9393
### spark agent — AI Agent Configuration
9494

95-
| Command | Description |
96-
|---------|-------------|
97-
| `spark agent list` | List supported agents |
98-
| `spark agent view <agent>` | View agent config files |
99-
| `spark agent edit <agent> [index]` | Edit agent config in editor |
100-
| `spark agent reset <agent>` | Reset agent config |
101-
| `spark agent profile list` | List config profiles |
102-
| `spark agent profile add <name> -t <type>` | Add new profile |
103-
| `spark agent profile show <name>` | Show profile config |
104-
| `spark agent profile edit <name> [index]` | Edit profile config |
105-
| `spark agent use <profile> [-p <dir>]` | Apply profile to project |
106-
| `spark agent current [-p <dir>]` | Show active profile |
107-
108-
Supported agents: `claude-code`, `codex`, `kimi`, `glm`
95+
Currently disabled in command registration. The `spark agent` entry is not added to root command.
10996

11097
---
11198

‎docs/quick-start/getting-started.md‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,7 @@ spark magic node use taobao # Node → 淘宝源
4343

4444
### AI Agent 配置
4545

46-
```bash
47-
spark agent list # 查看支持的 Agent
48-
spark agent view claude-code # 查看 Claude Code 配置
49-
spark agent profile add my-profile -t glm # 创建 Profile
50-
spark agent use my-profile # 应用到当前项目
51-
```
46+
当前版本已禁用 `spark agent` 命令入口，待后续重新设计后再启用。
5247

5348
### 任务管理
5449

‎docs/spec/task.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ spark task init
3131

3232
## spark task list
3333

34-
列出任务目录中的所有任务和特性文件。
34+
列出任务目录中的所有任务和 issue 文件。
3535

3636
```
3737
spark task list [--task-dir <dir>]

0 commit comments

Comments
 (0)