relay-kit 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.en.md +247 -0
- package/README.md +202 -190
- package/dist/cli.js +18 -15
- package/dist/cli.js.map +1 -1
- package/docs/CLI_SPEC.md +108 -53
- package/docs/FINAL_DESIGN.md +18 -16
- package/docs/OPENSPEC_INTEGRATION.md +60 -30
- package/docs/SKILLS_INSTALLATION.md +46 -4
- package/docs/USAGE_FLOW.md +47 -58
- package/package.json +3 -2
package/docs/CLI_SPEC.md
CHANGED
|
@@ -1,94 +1,164 @@
|
|
|
1
1
|
# CLI 规格
|
|
2
2
|
|
|
3
|
-
## 1.
|
|
3
|
+
## 1. 全部命令
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
6
|
relay init
|
|
7
|
+
relay openspec <action>
|
|
7
8
|
relay start
|
|
8
9
|
relay ask
|
|
9
10
|
relay resume
|
|
10
11
|
relay review
|
|
11
12
|
relay doctor
|
|
13
|
+
relay sync
|
|
12
14
|
```
|
|
13
15
|
|
|
14
16
|
## 2. relay init
|
|
15
17
|
|
|
16
|
-
|
|
18
|
+
初始化当前项目,交互式选择 simple / openspec 模式。
|
|
17
19
|
|
|
18
20
|
```bash
|
|
19
21
|
relay init
|
|
20
22
|
relay init --mode simple
|
|
21
23
|
relay init --mode openspec
|
|
24
|
+
relay init --mode openspec --openspec-sync use_relay
|
|
22
25
|
relay init --with-openspec
|
|
23
26
|
relay init --yes
|
|
24
27
|
relay init --force
|
|
25
|
-
relay init --skills claude,codex
|
|
26
|
-
relay init --skills-manager-only
|
|
27
28
|
```
|
|
28
29
|
|
|
29
|
-
|
|
30
|
+
行为:
|
|
31
|
+
- 无 `openspec/` 时弹出菜单选择模式
|
|
32
|
+
- OpenSpec 模式自动创建 `openspec/` 目录结构
|
|
33
|
+
- 检测到外部 `openspec` CLI 时提供选项
|
|
34
|
+
- 生成配置、状态、handoff 目录、AGENTS.md 注入、安装 Skills/OpenSpec 文件
|
|
30
35
|
|
|
31
|
-
## 3. relay
|
|
36
|
+
## 3. relay openspec(内置 OpenSpec CLI)
|
|
32
37
|
|
|
33
|
-
|
|
38
|
+
### relay openspec new-change
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
relay openspec new-change <name>
|
|
42
|
+
relay openspec new-change <name> --schema spec-driven
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
创建 `openspec/changes/<name>/` 目录和 `.openspec.yaml`。
|
|
46
|
+
|
|
47
|
+
### relay openspec status
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
relay openspec status --change <name>
|
|
51
|
+
relay openspec status --change <name> --json
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
输出 artifact 完成状态(proposal / specs / design / tasks 各自 done/ready/blocked)。
|
|
55
|
+
|
|
56
|
+
### relay openspec list
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
relay openspec list
|
|
60
|
+
relay openspec list --json
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
列出所有活跃 changes(排除 archive/)。
|
|
64
|
+
|
|
65
|
+
### relay openspec instructions
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
relay openspec instructions <artifactId> --change <name>
|
|
69
|
+
relay openspec instructions <artifactId> --change <name> --json
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
输出指定 artifact 的创建指引,包含 context、rules、template、instruction、outputPath、dependencies。
|
|
73
|
+
|
|
74
|
+
### relay openspec apply-instructions
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
relay openspec apply-instructions --change <name>
|
|
78
|
+
relay openspec apply-instructions --change <name> --json
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
输出 apply 执行上下文:contextFiles 映射、任务进度(total/complete/remaining)、state(ready/blocked/all_done)。
|
|
82
|
+
|
|
83
|
+
### relay openspec archive
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
relay openspec archive <name>
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
归档 change 到 `openspec/changes/archive/YYYY-MM-DD-<name>/`。
|
|
90
|
+
|
|
91
|
+
### relay openspec schemas
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
relay openspec schemas
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
列出可用 workflow schema 及其 artifact 列表。
|
|
98
|
+
|
|
99
|
+
## 4. relay start
|
|
100
|
+
|
|
101
|
+
开始一次 handoff run,生成 `EXECUTOR_TASK.md`。
|
|
34
102
|
|
|
35
103
|
```bash
|
|
36
104
|
relay start
|
|
37
|
-
relay start --change add-local-project-storage --
|
|
38
|
-
relay start --title "
|
|
39
|
-
relay start --
|
|
105
|
+
relay start --change add-local-project-storage --title "实现本地存储"
|
|
106
|
+
relay start --title "优化 UI" --scope "src/pages/**" --blocked-scope "不要改 API"
|
|
107
|
+
relay start --copy
|
|
40
108
|
```
|
|
41
109
|
|
|
42
|
-
|
|
110
|
+
OpenSpec 模式下自动读取 change 的 proposal/design/tasks 并注入到 handoff 文件。
|
|
43
111
|
|
|
44
|
-
##
|
|
112
|
+
## 5. relay ask
|
|
45
113
|
|
|
46
|
-
卡住时生成 `ASK_ADVISOR.md`。
|
|
114
|
+
Executor 卡住时生成 `ASK_ADVISOR.md`。
|
|
47
115
|
|
|
48
116
|
```bash
|
|
49
117
|
relay ask
|
|
50
118
|
relay ask --run build
|
|
51
|
-
relay ask --
|
|
52
|
-
relay ask --
|
|
119
|
+
relay ask --run test
|
|
120
|
+
relay ask --copy
|
|
53
121
|
```
|
|
54
122
|
|
|
55
|
-
收集:git status
|
|
123
|
+
收集:git status / diff、OpenSpec 上下文、构建/测试错误、当前 task。默认只收集现有上下文,传递 `--run` 才会执行命令。
|
|
56
124
|
|
|
57
|
-
##
|
|
125
|
+
## 6. relay resume
|
|
58
126
|
|
|
59
|
-
|
|
127
|
+
读取 Advisor 决策并生成 `RESUME_PROMPT.md`。
|
|
60
128
|
|
|
61
129
|
```bash
|
|
62
130
|
relay resume
|
|
63
|
-
relay resume --from
|
|
64
|
-
relay resume --
|
|
131
|
+
relay resume --from ./ADVISOR_DECISION.md
|
|
132
|
+
relay resume --copy
|
|
65
133
|
```
|
|
66
134
|
|
|
67
|
-
|
|
135
|
+
## 7. relay review
|
|
68
136
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
生成 Review 请求。
|
|
137
|
+
生成 `REVIEW_REQUEST.md`。
|
|
72
138
|
|
|
73
139
|
```bash
|
|
74
140
|
relay review
|
|
75
|
-
relay review --
|
|
76
|
-
relay review --run current --copy
|
|
141
|
+
relay review --copy
|
|
77
142
|
```
|
|
78
143
|
|
|
79
|
-
|
|
144
|
+
收集当前任务、OpenSpec 上下文、受限 git diff。
|
|
80
145
|
|
|
81
|
-
##
|
|
146
|
+
## 8. relay doctor
|
|
82
147
|
|
|
83
|
-
|
|
148
|
+
诊断项目接入状态:配置、AGENTS.md 注入块、Skills 目录、handoff 目录、OpenSpec 状态、package scripts、当前 run/lane。
|
|
84
149
|
|
|
150
|
+
```bash
|
|
151
|
+
relay doctor
|
|
152
|
+
```
|
|
85
153
|
|
|
86
|
-
## 9. relay sync
|
|
154
|
+
## 9. relay sync
|
|
87
155
|
|
|
88
|
-
同步 relay
|
|
156
|
+
同步 relay-kit 管理的资源。
|
|
89
157
|
|
|
90
158
|
```bash
|
|
91
|
-
relay sync --skills
|
|
159
|
+
relay sync --skills # 同步 relay Skills
|
|
160
|
+
relay sync --openspec # 同步 OpenSpec 命令/Skill 文件
|
|
161
|
+
relay sync --all # 全量同步
|
|
92
162
|
relay sync --skills --target claude
|
|
93
163
|
relay sync --skills --target codex
|
|
94
164
|
relay sync --skills --target all --scope project
|
|
@@ -97,25 +167,10 @@ relay sync --skills --dry-run
|
|
|
97
167
|
relay sync --skills --force
|
|
98
168
|
```
|
|
99
169
|
|
|
100
|
-
默认从:
|
|
101
|
-
|
|
102
|
-
```text
|
|
103
|
-
.relay/skills/
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
同步到项目级目标:
|
|
107
|
-
|
|
108
|
-
```text
|
|
109
|
-
.claude/skills/
|
|
110
|
-
.agents/skills/
|
|
111
|
-
```
|
|
112
|
-
|
|
113
170
|
规则:
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
6. `--dry-run` 只输出同步计划,不写入文件或同步状态;
|
|
121
|
-
7. 命令输出同步报告,包含目标、文件动作和汇总结果。
|
|
171
|
+
1. 默认只同步当前项目配置启用的项目级目标
|
|
172
|
+
2. 用户级目录只在显式传入 `--scope user` 时写入
|
|
173
|
+
3. Codex 目标使用 `.agents/skills`,不使用 `.codex/skills`
|
|
174
|
+
4. 默认不覆盖疑似被用户修改过的目标 Skill
|
|
175
|
+
5. `--force` 允许覆盖冲突文件
|
|
176
|
+
6. `--dry-run` 只输出同步计划,不写入文件
|
package/docs/FINAL_DESIGN.md
CHANGED
|
@@ -73,12 +73,14 @@ Relay Review
|
|
|
73
73
|
CLI 是底层能力,不要求用户记复杂参数。
|
|
74
74
|
|
|
75
75
|
```bash
|
|
76
|
-
relay init
|
|
77
|
-
relay
|
|
78
|
-
relay
|
|
79
|
-
relay
|
|
80
|
-
relay
|
|
81
|
-
relay
|
|
76
|
+
relay init # 初始化项目(交互式选择 simple/openspec 模式)
|
|
77
|
+
relay openspec # 内置 OpenSpec CLI(new-change / status / list / instructions / archive)
|
|
78
|
+
relay start # 开始任务,生成 EXECUTOR_TASK.md
|
|
79
|
+
relay ask # 卡住时生成 ASK_ADVISOR.md
|
|
80
|
+
relay resume # 顾问回复后生成继续执行提示
|
|
81
|
+
relay review # 完成后生成 REVIEW_REQUEST.md
|
|
82
|
+
relay doctor # 检查接入状态
|
|
83
|
+
relay sync # 同步 Skills 和 OpenSpec 文件
|
|
82
84
|
```
|
|
83
85
|
|
|
84
86
|
### 4.4 Handoff 文件层
|
|
@@ -94,12 +96,13 @@ REVIEW_REQUEST.md
|
|
|
94
96
|
REVIEW_REPORT.md
|
|
95
97
|
```
|
|
96
98
|
|
|
97
|
-
### 4.5 OpenSpec
|
|
99
|
+
### 4.5 OpenSpec 层(v0.3.0 起内置)
|
|
98
100
|
|
|
99
|
-
-
|
|
100
|
-
-
|
|
101
|
-
-
|
|
102
|
-
-
|
|
101
|
+
- relay-kit v0.3.0 起**内置 OpenSpec 实现**,零外部依赖;
|
|
102
|
+
- `relay openspec` 子命令组提供完整 CLI:new-change / status / list / instructions / apply-instructions / archive / schemas;
|
|
103
|
+
- `relay init --mode openspec` 自动创建 `openspec/` 目录结构;
|
|
104
|
+
- 检测到外部 `openspec` CLI 时提供共存选项;
|
|
105
|
+
- relay-kit 作为独立分叉维护,可按需合并上游优化或自主微调。
|
|
103
106
|
|
|
104
107
|
## 5. 最重要的边界
|
|
105
108
|
|
|
@@ -109,12 +112,11 @@ REVIEW_REPORT.md
|
|
|
109
112
|
2. 不自动写业务代码;
|
|
110
113
|
3. 不自动提交 git;
|
|
111
114
|
4. 不替代 OpenCode / Claude Code;
|
|
112
|
-
5.
|
|
113
|
-
6.
|
|
114
|
-
7. MVP
|
|
115
|
-
8. MVP 不做真正自动多 Agent 调度。
|
|
115
|
+
5. 不强制安装外部 OpenSpec(已内置);
|
|
116
|
+
6. MVP 不做 GUI;
|
|
117
|
+
7. MVP 不做真正自动多 Agent 调度。
|
|
116
118
|
|
|
117
|
-
|
|
119
|
+
它做的是:初始化规则、管理 OpenSpec change 生命周期、生成任务交接材料、收集求助上下文、规范 Relay 输出、生成 Review 请求、让流程跨项目复用。
|
|
118
120
|
|
|
119
121
|
## 6. Skills 安装策略
|
|
120
122
|
|
|
@@ -1,52 +1,82 @@
|
|
|
1
|
-
# OpenSpec
|
|
1
|
+
# OpenSpec 集成架构
|
|
2
2
|
|
|
3
|
-
## 1.
|
|
3
|
+
## 1. v0.3.0 起:内置实现
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
relay-kit v0.3.0 起**不再依赖外部 `openspec` CLI**。所有 OpenSpec 功能由 relay-kit 内置实现:
|
|
6
6
|
|
|
7
7
|
```text
|
|
8
|
-
|
|
9
|
-
relay
|
|
8
|
+
relay-kit CLI
|
|
9
|
+
├── relay init → 一键创建 openspec/ + .relay/
|
|
10
|
+
├── relay openspec * → 内置 OpenSpec CLI(零外部依赖)
|
|
11
|
+
├── relay start --change → 读取 OpenSpec change 生成 EXECUTOR_TASK
|
|
12
|
+
├── relay sync --openspec → 同步 OpenSpec 命令/Skill 文件
|
|
13
|
+
└── relay sync --all → 全量同步(Skills + OpenSpec)
|
|
10
14
|
```
|
|
11
15
|
|
|
12
|
-
## 2.
|
|
16
|
+
## 2. 架构角色
|
|
13
17
|
|
|
14
|
-
|
|
18
|
+
```text
|
|
19
|
+
OpenSpec 的工作由 relay-kit 接管:
|
|
20
|
+
- 定义「做什么」→ schema + artifacts(proposal / specs / design / tasks)
|
|
21
|
+
- 跟踪「做了多少」→ status / task progress
|
|
22
|
+
- 归档「做完了」→ archive + spec merge
|
|
23
|
+
|
|
24
|
+
relay-kit 的工作流层:
|
|
25
|
+
- 规划 → /relay:plan → 输出 PLAN_REPORT
|
|
26
|
+
- 交付 → relay start → EXECUTOR_TASK.md
|
|
27
|
+
- 执行 → /relay:run → 小步实现,卡住升级
|
|
28
|
+
- 求助 → relay ask → ASK_ADVISOR.md
|
|
29
|
+
- 审查 → relay review → REVIEW_REQUEST.md
|
|
30
|
+
```
|
|
15
31
|
|
|
16
|
-
|
|
32
|
+
## 3. 内置 Schema
|
|
17
33
|
|
|
18
|
-
|
|
34
|
+
relay-kit 内置 `spec-driven` schema(唯一实际使用的 schema),artifact 流:
|
|
19
35
|
|
|
20
|
-
|
|
36
|
+
```
|
|
37
|
+
proposal ──→ specs ──→ tasks
|
|
38
|
+
│ ↑
|
|
39
|
+
└──────→ design ───────┘
|
|
21
40
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
project.md
|
|
25
|
-
changes/
|
|
41
|
+
apply.requires: [tasks]
|
|
42
|
+
apply.tracks: tasks.md
|
|
26
43
|
```
|
|
27
44
|
|
|
28
|
-
|
|
45
|
+
Schema 定义在 `src/core/schema.ts`,支持轻量扩展框架。
|
|
29
46
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
"includeOpenSpec": true
|
|
34
|
-
}
|
|
35
|
-
```
|
|
47
|
+
## 4. 与外部 openspec CLI 共存
|
|
48
|
+
|
|
49
|
+
如果系统已有外部 `openspec` CLI(如 `@fission-ai/openspec`):
|
|
36
50
|
|
|
37
|
-
`relay
|
|
51
|
+
- `relay init` 检测到后提供选项:使用内置 / 使用外部 / 跳过
|
|
52
|
+
- `--openspec-sync use_relay` 强制使用内置
|
|
53
|
+
- 内置实现完全兼容 OpenSpec 文件格式(proposal.md / design.md / tasks.md / delta spec)
|
|
38
54
|
|
|
39
|
-
##
|
|
55
|
+
## 5. 用户项目中的文件
|
|
40
56
|
|
|
41
|
-
|
|
57
|
+
relay-kit 分发的 OpenSpec 文件(`relay sync --openspec` 安装):
|
|
42
58
|
|
|
43
59
|
```text
|
|
44
|
-
/opsx
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
60
|
+
.opencode/commands/opsx-*.md # OpenCode 命令
|
|
61
|
+
.opencode/skills/openspec-*/ # OpenCode Skills
|
|
62
|
+
.claude/commands/opsx/*.md # Claude Code 命令
|
|
63
|
+
.claude/skills/openspec-*/ # Claude Code Skills
|
|
64
|
+
.codex/skills/openspec-*/ # Codex Skills
|
|
48
65
|
```
|
|
49
66
|
|
|
50
|
-
|
|
67
|
+
这些文件内部调用 `relay openspec` 而非外部 `openspec` CLI。
|
|
68
|
+
|
|
69
|
+
## 6. 更新机制
|
|
70
|
+
|
|
71
|
+
用户更新 relay-kit 后:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npm update -g relay-kit
|
|
75
|
+
relay sync --all # 全量更新 Skills + OpenSpec 文件
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
relay-kit 作为 OpenSpec 实现的**独立分叉**维护,可按需从上游合并指令优化,也可自主微调。
|
|
79
|
+
|
|
80
|
+
## 7. 与 /opsx:* 命令的关系
|
|
51
81
|
|
|
52
|
-
|
|
82
|
+
`/opsx:propose`、`/opsx:apply`、`/opsx:archive`、`/opsx:explore` 命令由 relay-kit 分发,内部调用 `relay openspec` 子命令,完全自包含。
|
|
@@ -10,7 +10,9 @@
|
|
|
10
10
|
2. 不污染用户所有项目;
|
|
11
11
|
3. 不同项目可以有不同的 relay 工作流;
|
|
12
12
|
4. 适合团队协作和作品集展示;
|
|
13
|
-
5. 后续可通过 `relay sync
|
|
13
|
+
5. 后续可通过 `relay sync` 更新。
|
|
14
|
+
|
|
15
|
+
`relay init` 在 OpenSpec 模式下还会额外安装 **OpenSpec 命令/Skill 文件**(`.opencode/`、`.claude/commands/opsx/`、`.codex/skills/openspec-*/`),与 relay Skills 一起管理。
|
|
14
16
|
|
|
15
17
|
## 2. 不同工具的 Skills 目录
|
|
16
18
|
|
|
@@ -18,12 +20,21 @@
|
|
|
18
20
|
|
|
19
21
|
### Claude Code
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
项目级 Skills:
|
|
22
24
|
|
|
23
25
|
```text
|
|
24
26
|
.claude/skills/<skill-name>/SKILL.md
|
|
25
27
|
```
|
|
26
28
|
|
|
29
|
+
OpenSpec 命令:
|
|
30
|
+
|
|
31
|
+
```text
|
|
32
|
+
.claude/commands/opsx/propose.md
|
|
33
|
+
.claude/commands/opsx/apply.md
|
|
34
|
+
.claude/commands/opsx/archive.md
|
|
35
|
+
.claude/commands/opsx/explore.md
|
|
36
|
+
```
|
|
37
|
+
|
|
27
38
|
用户级:
|
|
28
39
|
|
|
29
40
|
```text
|
|
@@ -32,18 +43,33 @@
|
|
|
32
43
|
|
|
33
44
|
### Codex
|
|
34
45
|
|
|
35
|
-
|
|
46
|
+
项目级 Skills:
|
|
36
47
|
|
|
37
48
|
```text
|
|
38
49
|
.agents/skills/<skill-name>/SKILL.md
|
|
39
50
|
```
|
|
40
51
|
|
|
52
|
+
OpenSpec Skills:
|
|
53
|
+
|
|
54
|
+
```text
|
|
55
|
+
.codex/skills/openspec-*/SKILL.md
|
|
56
|
+
```
|
|
57
|
+
|
|
41
58
|
用户级:
|
|
42
59
|
|
|
43
60
|
```text
|
|
44
61
|
~/.agents/skills/<skill-name>/SKILL.md
|
|
45
62
|
```
|
|
46
63
|
|
|
64
|
+
### OpenCode
|
|
65
|
+
|
|
66
|
+
项目级:
|
|
67
|
+
|
|
68
|
+
```text
|
|
69
|
+
.opencode/commands/opsx-*.md
|
|
70
|
+
.opencode/skills/openspec-*/SKILL.md
|
|
71
|
+
```
|
|
72
|
+
|
|
47
73
|
## 3. relay-kit 管理副本
|
|
48
74
|
|
|
49
75
|
无论用户选择哪些工具,`relay init` 都应该生成 relay-kit 自己的管理副本:
|
|
@@ -150,6 +176,22 @@ your-project/
|
|
|
150
176
|
relay sync --skills
|
|
151
177
|
```
|
|
152
178
|
|
|
179
|
+
### 同步 OpenSpec 文件
|
|
180
|
+
|
|
181
|
+
```bash
|
|
182
|
+
relay sync --openspec
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
同步 `.opencode/`、`.claude/commands/opsx/`、`.codex/skills/openspec-*/` 到项目。
|
|
186
|
+
|
|
187
|
+
### 全量同步
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
relay sync --all
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
等于 `--skills` + `--openspec`。
|
|
194
|
+
|
|
153
195
|
默认从:
|
|
154
196
|
|
|
155
197
|
```text
|
|
@@ -227,7 +269,7 @@ relay sync --skills --target all --scope user
|
|
|
227
269
|
然后让每个成员本地运行:
|
|
228
270
|
|
|
229
271
|
```bash
|
|
230
|
-
relay sync --
|
|
272
|
+
relay sync --all
|
|
231
273
|
```
|
|
232
274
|
|
|
233
275
|
## 11. 最终规则
|
package/docs/USAGE_FLOW.md
CHANGED
|
@@ -6,82 +6,63 @@
|
|
|
6
6
|
relay init
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
```text
|
|
12
|
-
1. Simple 模式:不使用 OpenSpec
|
|
13
|
-
2. OpenSpec 模式:已有 OpenSpec,接入即可
|
|
14
|
-
3. 引导初始化 OpenSpec:只提示/确认,不静默安装
|
|
15
|
-
```
|
|
9
|
+
无 `openspec/` 时弹出交互菜单选择模式。选择 OpenSpec 后自动创建目录结构并安装全套文件。
|
|
16
10
|
|
|
17
11
|
初始化后生成:
|
|
18
12
|
|
|
19
|
-
```
|
|
20
|
-
.relay/
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
AGENTS.md
|
|
13
|
+
```
|
|
14
|
+
.relay/ # 配置 + 状态 + Skills
|
|
15
|
+
. relayignore # 上下文忽略规则
|
|
16
|
+
.opencode/ # OpenCode 的 OpenSpec 命令/Skill
|
|
17
|
+
.claude/ # Claude Code 的 OpenSpec 命令 + Skills
|
|
18
|
+
.codex/ # Codex 的 OpenSpec Skills
|
|
19
|
+
.agents/ # Codex 的 relay Skills
|
|
20
|
+
openspec/ # OpenSpec 规范目录
|
|
21
|
+
AGENTS.md # relay-kit 执行规则注入
|
|
30
22
|
```
|
|
31
23
|
|
|
32
24
|
## 2. 规划功能
|
|
33
25
|
|
|
34
|
-
|
|
26
|
+
对 Advisor(聪明模型)说:
|
|
35
27
|
|
|
36
|
-
```
|
|
28
|
+
```
|
|
37
29
|
用 relay-planner 帮我规划「本地项目存储」功能。
|
|
38
|
-
|
|
30
|
+
判断是否需要 OpenSpec,明确目标、范围、非目标,并拆成 tasks。
|
|
39
31
|
```
|
|
40
32
|
|
|
41
|
-
|
|
33
|
+
得到 `PLAN_REPORT` 后,如果推荐 OpenSpec 模式:
|
|
42
34
|
|
|
43
|
-
```
|
|
44
|
-
openspec
|
|
45
|
-
proposal.md
|
|
46
|
-
design.md
|
|
47
|
-
tasks.md
|
|
35
|
+
```bash
|
|
36
|
+
relay openspec new-change add-local-storage
|
|
48
37
|
```
|
|
49
38
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
对聪明模型说:
|
|
53
|
-
|
|
54
|
-
```text
|
|
55
|
-
用 relay-delegator 把当前 OpenSpec change 的第 1-2 项交给 OpenCode。
|
|
56
|
-
```
|
|
39
|
+
然后在 AI 工具中运行 `/opsx:propose add-local-storage` 生成完整制品。
|
|
57
40
|
|
|
58
|
-
|
|
41
|
+
## 3. 委派给 Executor
|
|
59
42
|
|
|
60
43
|
```bash
|
|
61
|
-
relay start
|
|
44
|
+
relay start --change add-local-storage --title "实现本地项目存储"
|
|
62
45
|
```
|
|
63
46
|
|
|
64
|
-
|
|
47
|
+
生成 `EXECUTOR_TASK.md`,交给 Executor:
|
|
65
48
|
|
|
66
|
-
```
|
|
67
|
-
|
|
49
|
+
```
|
|
50
|
+
用 /relay:run 执行当前任务。
|
|
68
51
|
```
|
|
69
52
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
## 4. 小模型卡住
|
|
53
|
+
## 4. Executor 卡住
|
|
73
54
|
|
|
74
55
|
```bash
|
|
75
56
|
relay ask
|
|
76
57
|
```
|
|
77
58
|
|
|
78
|
-
生成 `ASK_ADVISOR.md
|
|
59
|
+
生成 `ASK_ADVISOR.md`,交给 Advisor:
|
|
79
60
|
|
|
80
|
-
```
|
|
61
|
+
```
|
|
81
62
|
用 relay-escalation 分析这个 ASK_ADVISOR,输出 ADVISOR_DECISION。
|
|
82
63
|
```
|
|
83
64
|
|
|
84
|
-
## 5.
|
|
65
|
+
## 5. Advisor 决策后继续
|
|
85
66
|
|
|
86
67
|
保存顾问回复为 `ADVISOR_DECISION.md`,运行:
|
|
87
68
|
|
|
@@ -89,7 +70,7 @@ relay ask
|
|
|
89
70
|
relay resume
|
|
90
71
|
```
|
|
91
72
|
|
|
92
|
-
生成 `RESUME_PROMPT.md`,交给
|
|
73
|
+
生成 `RESUME_PROMPT.md`,交给 Executor 继续。
|
|
93
74
|
|
|
94
75
|
## 6. 完成后 Review
|
|
95
76
|
|
|
@@ -97,20 +78,28 @@ relay resume
|
|
|
97
78
|
relay review
|
|
98
79
|
```
|
|
99
80
|
|
|
100
|
-
生成 `REVIEW_REQUEST.md
|
|
81
|
+
生成 `REVIEW_REQUEST.md`,交给 Advisor:
|
|
101
82
|
|
|
102
|
-
```
|
|
103
|
-
用 relay-reviewer review
|
|
104
|
-
不要直接改代码,先输出 REVIEW_REPORT。
|
|
83
|
+
```
|
|
84
|
+
用 relay-reviewer review 当前实现。先输出 REVIEW_REPORT。
|
|
105
85
|
```
|
|
106
86
|
|
|
107
|
-
## 7.
|
|
87
|
+
## 7. 更新 relay-kit
|
|
108
88
|
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
89
|
+
```bash
|
|
90
|
+
npm update -g relay-kit
|
|
91
|
+
cd your-project
|
|
92
|
+
relay sync --all # 全量更新 Skills + OpenSpec 文件
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## 8. 最简心智模型
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
planner → 规划
|
|
99
|
+
delegator → 委派成 EXECUTOR_TASK
|
|
100
|
+
executor → 小步执行,卡住求助
|
|
101
|
+
escalation → Advisor 决策
|
|
102
|
+
resume → 拿决策继续
|
|
103
|
+
reviewer → 审查 + 裁决
|
|
104
|
+
openspec → 管理 change 生命周期
|
|
116
105
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "relay-kit",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "Skills-first, CLI-assisted AI programming relay workflow toolkit.",
|
|
5
5
|
"types": "./dist/cli.d.ts",
|
|
6
6
|
"repository": {
|
|
@@ -27,7 +27,8 @@
|
|
|
27
27
|
".opencode",
|
|
28
28
|
".claude",
|
|
29
29
|
".codex",
|
|
30
|
-
"README.md"
|
|
30
|
+
"README.md",
|
|
31
|
+
"README.en.md"
|
|
31
32
|
],
|
|
32
33
|
"scripts": {
|
|
33
34
|
"dev": "tsx src/cli.ts",
|