✨ feat: 完成部分文档更新
This commit is contained in:
@@ -47,9 +47,11 @@ aide-program 是 Aide 工作流体系的命令行工具,为 aide-plugin 提供
|
||||
| `aide env list` | [commands/env.md](commands/env.md) | ✅ 已实现 | 列出可用模块 |
|
||||
| `aide env set` | [commands/env.md](commands/env.md) | ✅ 已实现 | 设置环境配置(带验证) |
|
||||
| `aide config` | [formats/config.md](formats/config.md) | ✅ 已实现 | 配置读写 |
|
||||
| `aide flow` | [commands/flow.md](commands/flow.md) | ⏳ 待实现 | 进度追踪与 git 集成 |
|
||||
| `aide flow` | [commands/flow.md](commands/flow.md) | ✅ 已实现 | 进度追踪与 git 集成 |
|
||||
| `aide decide` | [commands/decide.md](commands/decide.md) | ⏳ 待实现 | 待定项 Web 确认 |
|
||||
|
||||
补充:flow 的实现细节与验证清单见 `commands/flow/README.md`。
|
||||
|
||||
### 2.1 环境检测模块
|
||||
|
||||
| 模块 | 类型 | 说明 |
|
||||
@@ -72,13 +74,16 @@ aide-program 是 Aide 工作流体系的命令行工具,为 aide-plugin 提供
|
||||
|
||||
```
|
||||
aide-program/
|
||||
├── aide.sh # Linux/Mac 入口脚本
|
||||
├── aide.bat # Windows 入口脚本
|
||||
├── bin/ # 入口脚本
|
||||
│ ├── aide.sh # Linux/Mac
|
||||
│ ├── aide.bat # Windows
|
||||
│ └── aide # 软链接(指向 aide.sh)
|
||||
├── docs/ # 设计文档(本目录)
|
||||
│ ├── README.md # 导览(本文件)
|
||||
│ ├── commands/ # 子命令设计文档
|
||||
│ │ ├── env.md
|
||||
│ │ ├── flow.md
|
||||
│ │ ├── flow/ # flow 详细设计(交接包)
|
||||
│ │ ├── decide.md
|
||||
│ │ └── init.md
|
||||
│ └── formats/ # 数据格式文档
|
||||
@@ -100,7 +105,13 @@ aide-program/
|
||||
│ ├── node.py, flutter.py, android.py
|
||||
│ ├── venv.py, requirements.py
|
||||
│ └── node_deps.py
|
||||
├── flow/ # 待实现
|
||||
├── flow/ # 进度追踪(已实现)
|
||||
│ ├── tracker.py
|
||||
│ ├── validator.py
|
||||
│ ├── storage.py
|
||||
│ ├── git.py
|
||||
│ ├── hooks.py
|
||||
│ ├── types.py
|
||||
│ └── ...
|
||||
└── decide/ # 待实现
|
||||
└── ...
|
||||
@@ -173,17 +184,18 @@ aide-program/
|
||||
|
||||
```bash
|
||||
# Linux/Mac
|
||||
./aide-program/aide.sh <command> [args]
|
||||
./aide-program/bin/aide.sh <command> [args]
|
||||
|
||||
# Windows
|
||||
aide-program\aide.bat <command> [args]
|
||||
aide-program\bin\aide.bat <command> [args]
|
||||
```
|
||||
|
||||
### 6.2 通过 Python 模块
|
||||
|
||||
```bash
|
||||
# 需要先激活虚拟环境或设置 PYTHONPATH
|
||||
python -m aide <command> [args]
|
||||
# 需要先使用 uv 创建并安装依赖,或直接使用入口脚本 ./aide-program/bin/aide.sh
|
||||
# 这里展示“直接使用虚拟环境的 python”运行模块:
|
||||
aide-program/.venv/bin/python -m aide <command> [args]
|
||||
```
|
||||
|
||||
### 6.3 依赖要求
|
||||
|
||||
@@ -2,6 +2,10 @@
|
||||
|
||||
本目录为 `aide flow` 子命令的**详细设计**。目标是让接手开发者在不阅读额外上下文的情况下,能够依据本文档集完成实现、联调与验证。
|
||||
|
||||
实现位置:
|
||||
- 核心实现:`aide-program/aide/flow/`
|
||||
- CLI 入口:`aide-program/aide/main.py` 的 `aide flow ...` 子命令树
|
||||
|
||||
上游/关联文档:
|
||||
- 概览设计:[`aide-program/docs/commands/flow.md`](../flow.md)
|
||||
- 数据格式规范(状态文件、提交信息):[`aide-program/docs/formats/data.md`](../../formats/data.md)
|
||||
@@ -42,7 +46,7 @@
|
||||
|
||||
## 四、推荐实现模块划分(仅文件/职责约定)
|
||||
|
||||
建议在 `aide-program/aide/flow/` 下按职责拆分:
|
||||
实现位于 `aide-program/aide/flow/`,按职责拆分为:
|
||||
|
||||
- `tracker`:编排一次 flow 操作(校验 → hooks → git → 落盘 → 输出)
|
||||
- `validator`:环节/动作校验(基于 phases 列表)
|
||||
|
||||
Reference in New Issue
Block a user