68 lines
1.6 KiB
Markdown
68 lines
1.6 KiB
Markdown
# Rune
|
||
|
||
基于 SDD（Spec-Driven Development）的命令行工具，通过向 AI 开发工具注入 command 和 skill，驱动结构化编码流程。
|
||
|
||
## 安装
|
||
|
||
```bash
|
||
bunx rune init opencode
|
||
```
|
||
|
||
## 使用
|
||
|
||
### 初始化
|
||
|
||
```bash
|
||
bunx rune init opencode
|
||
```
|
||
|
||
会在项目中创建：
|
||
- `.rune/` 目录（配置、变更文档、归档）
|
||
- `.opencode/commands/` 和 `.opencode/skills/`（注入的 AI 工具配置）
|
||
|
||
### SDD 流程
|
||
|
||
1. `/rune-discuss` — 自由讨论需求
|
||
2. `/rune-plan <变更名> <文档名>` — 生成指定规划文档（如 `design`、`task`），支持文档间依赖
|
||
3. `/rune-build <变更名>` — 按任务顺序编码实现
|
||
4. `/rune-archive <变更名>` — 归档并清理
|
||
|
||
### 状态查看
|
||
|
||
```bash
|
||
rune status # 查看所有变更
|
||
rune status <变更名> # 查看指定变更的详细状态（文档完成情况、依赖状态、下一步建议）
|
||
```
|
||
|
||
### 帮助与版本
|
||
|
||
```bash
|
||
rune help # 显示全局帮助
|
||
rune help <command> # 显示指定命令的详细帮助
|
||
rune version # 显示版本号
|
||
```
|
||
|
||
### 自定义配置
|
||
|
||
编辑 `.rune/config.yaml` 自定义提示词和文档模板。配置文件默认为空，使用内置默认策略；仅覆盖需要自定义的阶段，未配置的阶段使用内置默认配置。
|
||
|
||
规划阶段的文档支持 `depend` 字段声明前置依赖，如 `task` 依赖 `design`：
|
||
|
||
```yaml
|
||
stages:
|
||
plan:
|
||
documents:
|
||
- name: design
|
||
prompt: 生成设计文档
|
||
- name: task
|
||
prompt: 生成任务清单
|
||
depend: [design]
|
||
```
|
||
|
||
## 开发
|
||
|
||
```bash
|
||
bun test # 运行测试
|
||
bun src/cli.ts # 运行 CLI
|
||
```
|