Skip to content

Commit 4eeca13

Browse files
committed
feat(full): unify .agents canonical layout with compatibility projections
1 parent 0f4a858 commit 4eeca13

21 files changed

Lines changed: 896 additions & 598 deletions

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Repository Guidelines
22

33
## 项目结构与模块组织
4-
- `bin/`:CLI 主入口与核心逻辑。`bin/ag-kit.js` 负责命令分发,`bin/core/` 处理构建/转换,`bin/adapters/` 处理 `gemini`/`codex` 目标差异`bin/utils/` 放通用工具。
4+
- `bin/`:CLI 主入口与核心逻辑。`bin/ag-kit.js` 负责命令分发,`bin/core/` 处理构建/转换,`bin/adapters/` 实现 full 安装与兼容投影(`.agent/.gemini``bin/utils/` 放通用工具。
55
- `scripts/`:维护脚本(如 `clean.js``health-check.sh``postinstall-check.js`)。
66
- `tests/`:Node 内置测试(`*.test.js`),覆盖 CLI、适配器、生成器、清理与健康检查。
77
- `docs/``reference/`:规范文档与参考资料。
88
- `web/`:Next.js 文档站(`web/src` 源码,`web/public` 静态资源)。
9-
- `.agent/`模板资源源文件,供 CLI 安装到目标项目
9+
- `.agent/`上游模板源;CLI 安装时统一收敛到目标项目 `.agents/`(Canonical)
1010

1111
## 构建、测试与开发命令
1212
- 根项目依赖安装:`bun install`(如需兼容可用 `npm install`)。
1313
- 运行测试:`bun run test`(等价 `node --test tests`)。
1414
- 健康复检:`bun run health-check`(测试 + CLI 核心链路 + 清理预检)。
1515
- 清理产物:`bun run clean`,预览清理:`bun run clean:dry-run`
16-
- 本地调试 CLI:`node bin/ag-kit.js --version``node bin/ag-kit.js init --target codex --path ./tmp-workspace`
16+
- 本地调试 CLI:`node bin/ag-kit.js --version``node bin/ag-kit.js init --path ./tmp-workspace`
1717
- `web/` 子项目:`cd web && bun install && bun run dev`,发布构建 `bun run build`,代码检查 `bun run lint`
1818

1919
## 代码风格与命名约定

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,25 @@
77

88
## [Unreleased]
99

10+
## [3.0.0-beta.0] - 2026-03-04
11+
12+
### 新增
13+
14+
- 统一 full 目录体系:`ag-kit init/update` 默认安装 `.agents`(Canonical),并自动生成 `.agent` / `.gemini` 兼容投影。
15+
- Context7 MCP 双通道:默认同步 `context7`(官方)与 `context7_backup`(备用)配置。
16+
- 冲突交互:检测到已有 `.agent``.gemini/agents` 时,支持交互式处理策略选择。
17+
18+
### 变更
19+
20+
- `--target gemini|codex` 保持兼容,但内部归一为 full 安装流程。
21+
- `doctor/status/update-all` 统一按 full 模式工作,索引目标收敛为 `full`
22+
- `.codex` 迁移策略更新:仅清理可识别为本工具托管的 legacy 目录;非托管目录保留。
23+
24+
### 修复
25+
26+
- 修复升级场景对非托管 `.codex` 目录的误删除风险。
27+
- 修复 `.gemini/settings.json` 合并行为,保留用户非托管字段。
28+
1029

1130
## [2.0.2] - 2026-02-04
1231

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,17 @@ npm install -g @mison/ag-kit-cn
1919

2020
```bash
2121
cd /path/to/your-project
22-
ag-kit init --target gemini # 安装 Gemini 结构(.agent)
23-
ag-kit init --target codex # 安装 Codex 结构(.agents + 托管规则注入)
24-
# 或者直接 ag-kit init,在交互中选择目标
22+
ag-kit init # 统一 full 安装(.agents 为主目录)
23+
# 兼容参数仍可用,但会归一为 full
24+
ag-kit init --target codex
25+
ag-kit init --target gemini
2526
```
2627

2728
可选:不做全局安装,直接在仓库目录执行:
2829

2930
```bash
3031
cd /path/to/antigravity-kit-cn
31-
node bin/ag-kit.js init --target codex --path /path/to/your-project
32+
node bin/ag-kit.js init --path /path/to/your-project
3233
```
3334

3435
如需源码开发安装:
@@ -39,7 +40,7 @@ cd antigravity-kit-cn
3940
npm install -g .
4041
```
4142

42-
这会把所选目标结构安装到你的项目中(`gemini -> .agent``codex -> .agents`),并把 Codex 托管内容注入工作区 `AGENTS.md``antigravity.rules`(说明性托管区块,不是 Codex 官方 `.rules` 审批策略文件)。
43+
安装会统一写入 `.agents`,并自动生成兼容投影(`.agent``.gemini`),同时把托管内容注入工作区 `AGENTS.md``antigravity.rules`(说明性托管区块,不是 Codex 官方 `.rules` 审批策略文件)。
4344

4445
### Codex 规则边界说明
4546

@@ -50,10 +51,10 @@ npm install -g .
5051

5152
### ⚠️ 关于 `.gitignore` 的重要说明
5253

53-
如果你正在使用 **Cursor****Windsurf** 等 AI 编辑器,将 `.agent/``.agents/` 添加到 `.gitignore` 可能会阻止 IDE 索引工作流,导致斜杠命令(如 `/plan``/debug`)无法出现在对话建议中。
54+
如果你正在使用 **Cursor****Windsurf** 等 AI 编辑器,将 `.agent/``.agents/``.gemini/` 添加到 `.gitignore` 可能会阻止 IDE 索引工作流,导致斜杠命令(如 `/plan``/debug`)无法出现在对话建议中。
5455

5556
**推荐方案:**
56-
1. 确保 `.agent/``.agents/` **不要** 出现在项目的 `.gitignore` 中。
57+
1. 确保 `.agent/``.agents/``.gemini/` **不要** 出现在项目的 `.gitignore` 中。
5758
2. 作为替代方案,将其加入本地排除文件:`.git/info/exclude`
5859

5960
## 包含内容
@@ -133,8 +134,8 @@ CLI(命令行界面)工具:
133134

134135
| 命令 | 描述 |
135136
| --- | --- |
136-
| `ag-kit init` | 安装指定目标:gemini/codex |
137-
| `ag-kit update` | 更新当前项目已安装目标 |
137+
| `ag-kit init` | 安装统一 full 结构(`.agents` + 兼容投影) |
138+
| `ag-kit update` | 更新当前项目(自动收敛 legacy 目录) |
138139
| `ag-kit update-all` | 批量更新所有已登记工作区 |
139140
| `ag-kit doctor` | 诊断安装完整性(可 `--fix` 自愈) |
140141
| `ag-kit exclude` | 管理全局索引排除清单 |
@@ -143,17 +144,18 @@ CLI(命令行界面)工具:
143144
### 常用选项
144145

145146
```bash
146-
ag-kit init --target gemini --path ./myapp # 安装 Gemini 到指定目录
147-
ag-kit init --target codex --path ./myapp # 安装 Codex 到指定目录
148-
ag-kit init --targets gemini,codex --path ./myapp # 一次安装多个目标
149-
ag-kit init --non-interactive --target codex # 非交互模式必须显式指定目标
150-
ag-kit init --target codex --no-index --path ./tmp-workspace # 安装但不写入全局索引
147+
ag-kit init --path ./myapp # full 安装(.agents 主目录)
148+
ag-kit init --target codex --path ./myapp # 兼容写法,仍归一为 full
149+
ag-kit init --target gemini --path ./myapp # 兼容写法,仍归一为 full
150+
ag-kit init --non-interactive --path ./myapp # 非交互默认 full
151+
ag-kit init --no-index --path ./tmp-workspace # 安装但不写入全局索引
151152
ag-kit init --branch dev --force # 覆盖安装并指定分支
152153
ag-kit init --quiet --dry-run # 预览操作而不执行
153-
ag-kit update --target codex --path ./myapp # 更新指定目标(默认会刷新索引)
154-
ag-kit update --target codex --no-index --path ./myapp # 更新但不刷新索引
155-
ag-kit doctor --target codex --fix --path ./myapp # 检查并自动修复
156-
ag-kit update-all --targets codex # 批量更新所有登记工作区里的 codex 目标
154+
ag-kit update --path ./myapp # 更新并收敛 legacy
155+
ag-kit update --target codex --path ./myapp # 兼容写法,仍归一为 full
156+
ag-kit update --no-index --path ./myapp # 更新但不刷新索引
157+
ag-kit doctor --fix --path ./myapp # 检查并自动修复
158+
ag-kit update-all --targets full # 批量更新登记工作区
157159
ag-kit update-all --prune-missing # 清理索引中已失效的路径
158160
ag-kit exclude list # 查看排除清单
159161
ag-kit exclude add --path /path/to/dir # 新增排除路径
@@ -210,14 +212,17 @@ macOS / Linux / WSL:
210212

211213
```bash
212214
cd /path/to/your-project
213-
rm -rf .agent .agents .agents-backup .codex
215+
rm -rf .agent .agents .agents-backup .gemini antigravity.rules
216+
# 若确认 .codex 是本工具托管 legacy(含 manifest.json 且 target=codex/full),可再删除:
217+
# rm -rf .codex
214218
```
215219

216220
Windows PowerShell:
217221

218222
```powershell
219223
Set-Location C:\path\to\your-project
220-
Remove-Item .agent,.agents,.agents-backup,.codex -Recurse -Force -ErrorAction SilentlyContinue
224+
Remove-Item .agent,.agents,.agents-backup,.gemini,antigravity.rules -Recurse -Force -ErrorAction SilentlyContinue
225+
# 若确认 .codex 为本工具托管 legacy,再手动删除 .codex
221226
```
222227

223228
Windows CMD:
@@ -227,7 +232,9 @@ cd /d C:\path\to\your-project
227232
rmdir /s /q .agent
228233
rmdir /s /q .agents
229234
rmdir /s /q .agents-backup
230-
rmdir /s /q .codex
235+
rmdir /s /q .gemini
236+
del /f /q antigravity.rules
237+
REM 若确认 .codex 为本工具托管 legacy,再手动删除 .codex
231238
```
232239

233240
### 清理批量更新索引(可选)

0 commit comments

Comments
 (0)