Skip to content

Commit 761bc93

Browse files
committed
update docs
1 parent 3969d57 commit 761bc93

File tree

9 files changed

+58
-68
lines changed

9 files changed

+58
-68
lines changed

AGENTS.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
**Spark** 是一个 CLI 工具,用于管理多个 Git 仓库。它提供以下核心功能:
88

99
1. **多仓库更新** - 批量更新多个 Git 仓库到最新版本
10-
2. **Mono-repo 创建** - 将多个仓库整合为一个带有子模块的 Mono 仓库
10+
2. **Mono-repo 管理** - 将多个仓库添加为子模块,统一管理
1111
3. **子模块同步** - 同步 Mono 仓库中的所有子模块
1212
4. **Git 用户配置** - 配置仓库的 Git 用户信息
1313
5. **任务管理** - 任务分发、同步和 GitHub 仓库创建
@@ -35,7 +35,8 @@ spark/
3535
│ ├── git.go # Git 父命令
3636
│ ├── config.go # Git 用户配置
3737
│ ├── update.go # 仓库更新命令
38-
│ ├── create.go # mono-repo 创建命令
38+
│ ├── mono.go # mono 子命令组
39+
│ ├── mono_add.go # mono add 命令
3940
│ ├── sync.go # 子模块同步命令
4041
│ └── gitcode.go # Gitcode 远程管理
4142
├── internal/ # 内部业务逻辑
@@ -90,12 +91,12 @@ spark/
9091
Git 仓库管理命令的父命令,包含以下子命令:
9192

9293
```bash
93-
spark git update # 更新多个仓库
94-
spark git create # 创建 Mono 仓库
95-
spark git sync # 同步子模块
96-
spark git gitcode # 添加 Gitcode 远程
97-
spark git config # 配置 Git 用户
98-
spark git url # 获取仓库 URL
94+
spark git update # 更新多个仓库
95+
spark git mono add # 添加现有仓库为子模块
96+
spark git mono sync # 同步子模块
97+
spark git gitcode # 添加 Gitcode 远程
98+
spark git config # 配置 Git 用户
99+
spark git url # 获取仓库 URL
99100
spark git batch-clone # 克隆用户/组织所有仓库
100101
```
101102

@@ -109,29 +110,25 @@ spark git update -p ~/workspace -p ~/projects
109110

110111
详细文档: [docs/usage/update.md](docs/usage/update.md)
111112

112-
#### `spark git create`
113-
创建一个 Mono 仓库,将所有找到的仓库作为子模块添加
113+
#### `spark git mono add`
114+
将当前目录下的 Git 仓库添加为子模块,无需重新克隆
114115

115116
```bash
116-
spark git create -p /path/to/repos -n my-mono-repo -o ./output
117+
spark git mono add # 添加当前目录下的仓库
118+
spark git mono add -p /path/to/repos # 添加指定目录下的仓库
117119
```
118120

119121
| 选项 | 说明 |
120122
|------|------|
121-
| `-n, --name` | Mono 仓库名称 (默认: `mono-repo`) |
122-
| `-o, --output` | 输出路径 (默认: 当前目录) |
123+
| `-p, --path` | 包含 Git 仓库的目录 (默认: 当前目录) |
123124

124-
详细文档: [docs/usage/create.md](docs/usage/create.md)
125-
126-
#### `spark git sync`
125+
#### `spark git mono sync`
127126
同步 Mono 仓库中的所有子模块到最新版本。
128127

129128
```bash
130-
spark git sync /path/to/mono-repo
129+
spark git mono sync /path/to/mono-repo
131130
```
132131

133-
详细文档: [docs/usage/sync.md](docs/usage/sync.md)
134-
135132
#### `spark git gitcode`
136133
为 GitHub 仓库添加 Gitcode 作为远程地址。
137134

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ go test ./internal/git/... -v -run TestFunctionName
7474
| Command | Description |
7575
|---------|-------------|
7676
| `spark git update` | Update all repos to latest version |
77-
| `spark git create -n <name> -o <path>` | Create mono-repo with submodules |
78-
| `spark git sync <mono-path>` | Sync all submodules to latest |
77+
| `spark git mono add [-p <path>]` | Add existing repos as submodules |
78+
| `spark git mono sync <mono-path>` | Sync all submodules to latest |
7979
| `spark git gitcode [-p <path>]` | Add Gitcode remote to repos |
8080
| `spark git config [--username --email]` | Configure git user for repo |
8181
| `spark git url [repo-path]` | Get remote URL of repository |

docs/Agents.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
**Spark** 是一个 CLI 工具,用于管理多个 Git 仓库。它提供以下核心功能:
88

99
1. **多仓库更新** - 批量更新多个 Git 仓库到最新版本
10-
2. **Mono-repo 创建** - 将多个仓库整合为一个带有子模块的 Mono 仓库
10+
2. **Mono-repo 管理** - 将多个仓库添加为子模块,统一管理
1111
3. **子模块同步** - 同步 Mono 仓库中的所有子模块
1212
4. **Git 用户配置** - 配置仓库的 Git 用户信息
1313
5. **AI Agent 配置管理** - 管理多种 AI Agent(Claude Code、Codex、Kimi、GLM)的配置文件
@@ -35,7 +35,8 @@ spark/
3535
│ ├── git.go # Git 父命令
3636
│ ├── config.go # Git 用户配置
3737
│ ├── update.go # 仓库更新命令
38-
│ ├── create.go # mono-repo 创建命令
38+
│ ├── mono.go # mono 子命令组
39+
│ ├── mono_add.go # mono add 命令
3940
│ ├── sync.go # 子模块同步命令
4041
│ └── gitcode.go # Gitcode 远程管理
4142
├── internal/ # 内部业务逻辑
@@ -90,12 +91,12 @@ spark/
9091
Git 仓库管理命令的父命令,包含以下子命令:
9192

9293
```bash
93-
spark git update # 更新多个仓库
94-
spark git create # 创建 Mono 仓库
95-
spark git sync # 同步子模块
96-
spark git gitcode # 添加 Gitcode 远程
97-
spark git config # 配置 Git 用户
98-
spark git url # 获取仓库 URL
94+
spark git update # 更新多个仓库
95+
spark git mono add # 添加现有仓库为子模块
96+
spark git mono sync # 同步子模块
97+
spark git gitcode # 添加 Gitcode 远程
98+
spark git config # 配置 Git 用户
99+
spark git url # 获取仓库 URL
99100
spark git batch-clone # 克隆用户/组织所有仓库
100101
```
101102

@@ -109,29 +110,25 @@ spark git update -p ~/workspace -p ~/projects
109110

110111
详细文档: [docs/usage/update.md](docs/usage/update.md)
111112

112-
#### `spark git create`
113-
创建一个 Mono 仓库,将所有找到的仓库作为子模块添加
113+
#### `spark git mono add`
114+
将当前目录下的 Git 仓库添加为子模块,无需重新克隆
114115

115116
```bash
116-
spark git create -p /path/to/repos -n my-mono-repo -o ./output
117+
spark git mono add # 添加当前目录下的仓库
118+
spark git mono add -p /path/to/repos # 添加指定目录下的仓库
117119
```
118120

119121
| 选项 | 说明 |
120122
|------|------|
121-
| `-n, --name` | Mono 仓库名称 (默认: `mono-repo`) |
122-
| `-o, --output` | 输出路径 (默认: 当前目录) |
123+
| `-p, --path` | 包含 Git 仓库的目录 (默认: 当前目录) |
123124

124-
详细文档: [docs/usage/create.md](docs/usage/create.md)
125-
126-
#### `spark git sync`
125+
#### `spark git mono sync`
127126
同步 Mono 仓库中的所有子模块到最新版本。
128127

129128
```bash
130-
spark git sync /path/to/mono-repo
129+
spark git mono sync /path/to/mono-repo
131130
```
132131

133-
详细文档: [docs/usage/sync.md](docs/usage/sync.md)
134-
135132
#### `spark git gitcode`
136133
为 GitHub 仓库添加 Gitcode 作为远程地址。
137134

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ go test ./internal/git/... -v -run TestFunctionName
7474
| Command | Description |
7575
|---------|-------------|
7676
| `spark git update` | Update all repos to latest version |
77-
| `spark git create -n <name> -o <path>` | Create mono-repo with submodules |
78-
| `spark git sync <mono-path>` | Sync all submodules to latest |
77+
| `spark git mono add [-p <path>]` | Add existing repos as submodules |
78+
| `spark git mono sync <mono-path>` | Sync all submodules to latest |
7979
| `spark git gitcode [-p <path>]` | Add Gitcode remote to repos |
8080
| `spark git config [--username --email]` | Configure git user for repo |
8181
| `spark git url [repo-path]` | Get remote URL of repository |

docs/features/git.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ spark git update -p ~/workspace
1919
将多个独立仓库作为 Submodule 合并为一个 Mono-repo,方便统一管理和版本控制。
2020

2121
```bash
22-
# 创建 Mono-repo
23-
spark git create -n my-mono -o ./output
22+
# 添加现有仓库为子模块
23+
spark git mono add -p /path/to/repos
2424

2525
# 同步所有 Submodule 到最新
26-
spark git sync ./my-mono
26+
spark git mono sync ./my-mono
2727
```
2828

2929
### Gitcode 远程集成
@@ -54,7 +54,7 @@ spark git update-org-status variableway --update-dot-github
5454
| 参数 | 说明 |
5555
|------|------|
5656
| `-p, --path` | 指定扫描目录(支持多个),默认 `["."]` |
57-
| `-n, --name` | Mono-repo 名称,默认 `mono-repo` |
57+
| `-p, --path` | 包含 Git 仓库的目录,默认 `.` |
5858
| `-o, --output` | 输出路径 |
5959
| `--ssh` | 使用 SSH 克隆(batch-clone) |
6060
| `--include` / `--exclude` | 包含/排除匹配模式(batch-clone) |

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ go test ./internal/git/... -v -run TestFunctionName
7979
| Command | Description |
8080
|---------|-------------|
8181
| `spark git update` | Update all repos to latest version |
82-
| `spark git create -n <name> -o <path>` | Create mono-repo with submodules |
83-
| `spark git sync <mono-path>` | Sync all submodules to latest |
82+
| `spark git mono add [-p <path>]` | Add existing repos as submodules |
83+
| `spark git mono sync <mono-path>` | Sync all submodules to latest |
8484
| `spark git gitcode [-p <path>]` | Add Gitcode remote to repos |
8585
| `spark git config [--username --email]` | Configure git user for repo |
8686
| `spark git url [repo-path]` | Get remote URL of repository |

docs/quick-start/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ github_owner: your-username
2929
3030
```bash
3131
spark git update -p ~/workspace # 更新所有仓库
32-
spark git create -n my-mono -o ./output # 创建 Mono-repo
32+
spark git mono add -p /path/to/repos # 添加仓库为子模块
3333
spark git batch-clone variableway -o ./repos # 克隆组织仓库
3434
```
3535

docs/spec/git.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,30 +28,28 @@ spark git update [-p <path>]
2828

2929
---
3030

31-
## spark git create
31+
## spark git mono add
3232

33-
创建 Mono-repo,将指定目录下的所有仓库作为 Git Submodule 添加
33+
将目录下已有的 Git 仓库添加为子模块,无需重新克隆
3434

3535
```
36-
spark git create -n <name> -o <path> [-p <path>]
36+
spark git mono add [-p <path>]
3737
```
3838

3939
| 标志 | 类型 | 默认值 | 必填 | 说明 |
4040
|------|------|--------|------|------|
41-
| `-n, --name` | string | `mono-repo` || Mono-repo 目录名 |
42-
| `-o, --output` | string | 同源路径 || 输出路径 |
43-
| `-p, --path` | stringSlice | `["."]` || 包含 Git 仓库的目录路径 |
41+
| `-p, --path` | string | `.` || 包含 Git 仓库的目录路径 |
4442

4543
无参数。
4644

4745
---
4846

49-
## spark git sync
47+
## spark git mono sync
5048

5149
同步 Mono-repo 中所有 Submodule 到最新版本。
5250

5351
```
54-
spark git sync <mono-repo-path>
52+
spark git mono sync <mono-repo-path>
5553
```
5654

5755
| 参数 | 类型 | 必填 | 说明 |

docs/usage/git.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
```bash
88
spark git update # 更新所有仓库
9-
spark git create -n <name> -o <path> # 创建 Mono-repo
10-
spark git sync <mono-path> # 同步子模块
9+
spark git mono add [-p <path>] # 添加现有仓库为子模块
10+
spark git mono sync <mono-path> # 同步子模块
1111
spark git gitcode # 添加 Gitcode 远程
1212
spark git config [--username --email] # 配置 Git 用户
1313
spark git url [repo-path] # 查看远程 URL
@@ -31,29 +31,27 @@ spark git update -p ~/ws -p ~/projects # 多个目录
3131

3232
---
3333

34-
## spark git create
34+
## spark git mono add
3535

36-
将多个仓库整合为一个带有子模块的 Mono 仓库。
36+
将当前目录下已有的 Git 仓库添加为子模块,无需重新克隆。适用于研究场景:先将多个仓库克隆到同一目录,再统一转为 Mono 仓库。
3737

3838
| 标志 | 简写 | 默认值 | 说明 |
3939
|------|------|--------|------|
40-
| `--name` | `-n` | `mono-repo` | Mono 仓库名称 |
41-
| `--output` | `-o` | 源路径 | 输出路径 |
40+
| `--path` | `-p` | `.` | 包含 Git 仓库的目录 |
4241

4342
```bash
44-
spark git create # 默认创建 mono-repo
45-
spark git create -n my-mono -o ./output # 指定名称和输出路径
46-
spark git create -p ~/workspace -n projects # 从指定目录创建
43+
spark git mono add # 添加当前目录下的仓库
44+
spark git mono add -p /path/to/repos # 添加指定目录下的仓库
4745
```
4846

4947
---
5048

51-
## spark git sync
49+
## spark git mono sync
5250

5351
同步 Mono 仓库中所有子模块到最新版本。
5452

5553
```bash
56-
spark git sync ./my-mono-repo # 同步指定 Mono 仓库
54+
spark git mono sync ./my-mono-repo # 同步指定 Mono 仓库
5755
```
5856

5957
---

0 commit comments

Comments
 (0)