ai-dev-requirements 0.1.8 → 0.1.10
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/README.md +68 -14
- package/README.zh-CN.md +68 -14
- package/dist/index.cjs +457 -16
- package/dist/index.mjs +457 -16
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/skills/dev-workflow/SKILL.md +186 -123
- package/skills/dev-workflow/references/task-types.md +148 -97
- package/skills/dev-workflow/references/templates/code-dev-task.md +34 -21
- package/skills/dev-workflow/references/templates/code-fix-task.md +34 -20
- package/skills/dev-workflow/references/templates/code-refactor-task.md +34 -22
- package/skills/dev-workflow/references/templates/doc-write-task.md +33 -21
- package/skills/dev-workflow/references/templates/research-task.md +34 -22
- package/skills/dev-workflow/references/templates/test-task.md +33 -22
- package/skills/dev-workflow/references/workflow.md +290 -118
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[中文](./README.zh-CN.md)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
An agent harness workflow for AI coding tools, enabling controlled requirement intake, planning, gated execution, verification, review, and handoff.
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -11,13 +11,13 @@ A parallel-task development framework for AI coding tools, enabling end-to-end d
|
|
|
11
11
|
| Deliverable | Description |
|
|
12
12
|
|-------------|-------------|
|
|
13
13
|
| **Requirements MCP Server** (`src/`) | MCP server for fetching requirements, with built-in ONES adapter. Installable via npm. |
|
|
14
|
-
| **
|
|
14
|
+
| **Agent Harness Workflow Skill** (`skills/dev-workflow/`) | Self-contained agent harness skill. Install it to run requirement intake, planning, gated execution, verification, review, and handoff. |
|
|
15
15
|
|
|
16
16
|
---
|
|
17
17
|
|
|
18
18
|
## Quick Start
|
|
19
19
|
|
|
20
|
-
### 1. Install
|
|
20
|
+
### 1. Install Agent Harness Workflow Skill
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
npx skills add daguanren21/ai-dev-workflow
|
|
@@ -29,9 +29,61 @@ Install to a specific agent with `-a`:
|
|
|
29
29
|
npx skills add daguanren21/ai-dev-workflow -a claude-code
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Once installed, AI coding tools will automatically use the dev-workflow
|
|
32
|
+
Once installed, AI coding tools will automatically use the dev-workflow harness to govern the full development process.
|
|
33
33
|
|
|
34
|
-
### 2. Install
|
|
34
|
+
### 2. Install For Codex
|
|
35
|
+
|
|
36
|
+
Codex loads skills from `$CODEX_HOME/skills`. If `CODEX_HOME` is not set, the default is `~/.codex`.
|
|
37
|
+
|
|
38
|
+
From this repository:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills/dev-workflow"
|
|
42
|
+
cp -R skills/dev-workflow/* "${CODEX_HOME:-$HOME/.codex}/skills/dev-workflow/"
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
For local development, use a symlink instead so Codex picks up edits from this checkout after restart:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills"
|
|
49
|
+
ln -s "$(pwd)/skills/dev-workflow" "${CODEX_HOME:-$HOME/.codex}/skills/dev-workflow"
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Restart Codex after installing or updating the skill.
|
|
53
|
+
|
|
54
|
+
### 3. Trigger The Harness
|
|
55
|
+
|
|
56
|
+
The skill can be triggered automatically when the task looks like AI-assisted development work: requirement intake, issue implementation, task planning, gated execution, verification, review, or handoff.
|
|
57
|
+
|
|
58
|
+
You can also trigger it explicitly:
|
|
59
|
+
|
|
60
|
+
```text
|
|
61
|
+
Use the dev-workflow harness to implement this requirement: <requirement text or ticket id>
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
```text
|
|
65
|
+
Use the dev-workflow harness. Read ONES-123, write the plan first, then wait for confirmation before implementation.
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
```text
|
|
69
|
+
Use the dev-workflow harness for this GitHub issue: <issue url>
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
When the harness is active, the agent should announce:
|
|
73
|
+
|
|
74
|
+
```text
|
|
75
|
+
I'm using the dev-workflow harness to drive this development task.
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
By default, the harness generates user stories and an implementation plan before writing code, then pauses for confirmation. You do not need to repeat "write the plan first" in every prompt. Say so only when you want to bypass that gate.
|
|
79
|
+
|
|
80
|
+
Expected flow:
|
|
81
|
+
|
|
82
|
+
```text
|
|
83
|
+
Intake -> Context Load -> Normalize -> Harness Plan -> Coverage Validation -> Gated Execution -> Verification -> Review -> Handoff
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### 4. Install MCP Server (Optional)
|
|
35
87
|
|
|
36
88
|
If you use ONES for requirement management:
|
|
37
89
|
|
|
@@ -75,7 +127,7 @@ Add to your `.mcp.json`:
|
|
|
75
127
|
}
|
|
76
128
|
```
|
|
77
129
|
|
|
78
|
-
###
|
|
130
|
+
### 5. Add Companion MCP Servers (Optional)
|
|
79
131
|
|
|
80
132
|
Requirements are not limited to ONES. Pair with official MCP servers for GitHub / Jira / Figma:
|
|
81
133
|
|
|
@@ -108,22 +160,24 @@ Requirements are not limited to ONES. Pair with official MCP servers for GitHub
|
|
|
108
160
|
|
|
109
161
|
---
|
|
110
162
|
|
|
111
|
-
##
|
|
163
|
+
## Agent Harness Workflow Skill
|
|
112
164
|
|
|
113
|
-
A self-contained AI-assisted
|
|
165
|
+
A self-contained AI-assisted agent harness skill that governs the full development lifecycle:
|
|
114
166
|
|
|
115
167
|
```
|
|
116
|
-
|
|
168
|
+
Intake -> Context Load -> Normalize -> Harness Plan -> Coverage Validation -> Gated Execution -> Verification -> Review -> Handoff
|
|
117
169
|
```
|
|
118
170
|
|
|
171
|
+
The harness follows a feedforward + feedback model: it guides the agent with plans, artifacts, and task boundaries, then uses deterministic gates such as lint, typecheck, build, tests, and review as backpressure before handoff.
|
|
172
|
+
|
|
119
173
|
Skill directory structure:
|
|
120
174
|
|
|
121
175
|
```
|
|
122
176
|
skills/dev-workflow/
|
|
123
|
-
├── SKILL.md # Skill entry (YAML frontmatter +
|
|
177
|
+
├── SKILL.md # Skill entry (YAML frontmatter + harness definition)
|
|
124
178
|
└── references/
|
|
125
|
-
├── workflow.md #
|
|
126
|
-
├── task-types.md #
|
|
179
|
+
├── workflow.md # Agent harness lifecycle
|
|
180
|
+
├── task-types.md # Harness task types, scheduler modes, declaration syntax
|
|
127
181
|
├── service-transform.md # Service-layer transform pattern for Mock/API adaptation
|
|
128
182
|
└── templates/ # Task declaration templates
|
|
129
183
|
├── code-dev-task.md
|
|
@@ -140,10 +194,10 @@ skills/dev-workflow/
|
|
|
140
194
|
|
|
141
195
|
```
|
|
142
196
|
ai-dev-workflow/
|
|
143
|
-
├── skills/dev-workflow/ #
|
|
197
|
+
├── skills/dev-workflow/ # Agent Harness Workflow Skill (self-contained)
|
|
144
198
|
│ ├── SKILL.md
|
|
145
199
|
│ └── references/
|
|
146
|
-
│ ├── workflow.md
|
|
200
|
+
│ ├── workflow.md # Agent harness lifecycle
|
|
147
201
|
│ ├── task-types.md
|
|
148
202
|
│ ├── service-transform.md
|
|
149
203
|
│ └── templates/
|
package/README.zh-CN.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[English](./README.md)
|
|
4
4
|
|
|
5
|
-
一套面向 AI
|
|
5
|
+
一套面向 AI 编码工具的 agent harness 工作流,用于管控需求接入、计划、门禁执行、验证、审查和交付。
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -11,13 +11,13 @@
|
|
|
11
11
|
| 交付物 | 说明 |
|
|
12
12
|
|-------|------|
|
|
13
13
|
| **Requirements MCP Server** (`src/`) | 需求获取 MCP 服务,内置 ONES 适配器,可通过 npm 安装 |
|
|
14
|
-
| **
|
|
14
|
+
| **Agent Harness Workflow Skill** (`skills/dev-workflow/`) | 自包含的 AI agent harness 工作流 Skill,安装后即可跑通需求接入、计划、门禁执行、验证、审查和交付。 |
|
|
15
15
|
|
|
16
16
|
---
|
|
17
17
|
|
|
18
18
|
## 快速开始
|
|
19
19
|
|
|
20
|
-
### 1. 安装
|
|
20
|
+
### 1. 安装 Agent Harness Workflow Skill
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
npx skills add daguanren21/ai-dev-workflow
|
|
@@ -29,9 +29,61 @@ npx skills add daguanren21/ai-dev-workflow
|
|
|
29
29
|
npx skills add daguanren21/ai-dev-workflow -a claude-code
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
安装后,AI 编码工具会自动识别并使用 dev-workflow
|
|
32
|
+
安装后,AI 编码工具会自动识别并使用 dev-workflow harness 管控完整开发流程。
|
|
33
33
|
|
|
34
|
-
### 2.
|
|
34
|
+
### 2. 安装到 Codex
|
|
35
|
+
|
|
36
|
+
Codex 从 `$CODEX_HOME/skills` 加载 skills。未设置 `CODEX_HOME` 时,默认目录是 `~/.codex`。
|
|
37
|
+
|
|
38
|
+
从当前仓库安装:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills/dev-workflow"
|
|
42
|
+
cp -R skills/dev-workflow/* "${CODEX_HOME:-$HOME/.codex}/skills/dev-workflow/"
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
如果是在本地开发这个 skill,建议使用软链接,这样更新当前仓库后重启 Codex 即可生效:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills"
|
|
49
|
+
ln -s "$(pwd)/skills/dev-workflow" "${CODEX_HOME:-$HOME/.codex}/skills/dev-workflow"
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
安装或更新后需要重启 Codex。
|
|
53
|
+
|
|
54
|
+
### 3. 触发 Harness
|
|
55
|
+
|
|
56
|
+
当任务看起来是 AI 辅助开发工作时,skill 可以自动触发,例如:需求接入、issue 实现、任务规划、门禁执行、验证、审查或交付。
|
|
57
|
+
|
|
58
|
+
也可以显式触发:
|
|
59
|
+
|
|
60
|
+
```text
|
|
61
|
+
使用 dev-workflow harness 实现这个需求:<需求文本或工单号>
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
```text
|
|
65
|
+
使用 dev-workflow harness。读取 ONES-123,先写计划,确认后再实现。
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
```text
|
|
69
|
+
使用 dev-workflow harness 处理这个 GitHub issue:<issue url>
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Harness 生效时,agent 应该先声明:
|
|
73
|
+
|
|
74
|
+
```text
|
|
75
|
+
I'm using the dev-workflow harness to drive this development task.
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
默认情况下,harness 会先生成 user stories 和 implementation plan,然后暂停等待确认,再开始写代码。你不需要每次重复“先写计划再实现”。只有想跳过这个门禁时,才需要明确说明。
|
|
79
|
+
|
|
80
|
+
预期流程:
|
|
81
|
+
|
|
82
|
+
```text
|
|
83
|
+
需求接入 → 上下文加载 → 需求规范化 → Harness 计划 → 覆盖校验 → 门禁执行 → 验证 → 审查 → 交付
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### 4. 安装 MCP Server(可选)
|
|
35
87
|
|
|
36
88
|
如果使用 ONES 进行需求管理:
|
|
37
89
|
|
|
@@ -75,7 +127,7 @@ npm install -g ai-dev-requirements
|
|
|
75
127
|
}
|
|
76
128
|
```
|
|
77
129
|
|
|
78
|
-
###
|
|
130
|
+
### 5. 搭配其他 MCP Server(可选)
|
|
79
131
|
|
|
80
132
|
需求不限于 ONES,可搭配官方 MCP Server 获取 GitHub / Jira / Figma 资源:
|
|
81
133
|
|
|
@@ -108,22 +160,24 @@ npm install -g ai-dev-requirements
|
|
|
108
160
|
|
|
109
161
|
---
|
|
110
162
|
|
|
111
|
-
##
|
|
163
|
+
## Agent Harness Workflow Skill
|
|
112
164
|
|
|
113
|
-
自包含的 AI
|
|
165
|
+
自包含的 AI 辅助 agent harness 工作流 Skill,安装后自动管控完整开发生命周期:
|
|
114
166
|
|
|
115
167
|
```
|
|
116
|
-
|
|
168
|
+
需求接入 → 上下文加载 → 需求规范化 → Harness 计划 → 覆盖校验 → 门禁执行 → 验证 → 审查 → 交付
|
|
117
169
|
```
|
|
118
170
|
|
|
171
|
+
这个 harness 遵循“前馈 + 反馈”模型:先用计划、产物和任务边界引导 agent,再用 lint、typecheck、build、tests、review 等确定性门禁形成反压,合格后再交付。
|
|
172
|
+
|
|
119
173
|
Skill 目录结构:
|
|
120
174
|
|
|
121
175
|
```
|
|
122
176
|
skills/dev-workflow/
|
|
123
|
-
├── SKILL.md # Skill 入口(YAML frontmatter +
|
|
177
|
+
├── SKILL.md # Skill 入口(YAML frontmatter + harness 定义)
|
|
124
178
|
└── references/
|
|
125
|
-
├── workflow.md #
|
|
126
|
-
├── task-types.md #
|
|
179
|
+
├── workflow.md # Agent harness 生命周期
|
|
180
|
+
├── task-types.md # Harness 任务类型、调度模式、声明语法
|
|
127
181
|
├── service-transform.md # Service 层 Transform 适配模式
|
|
128
182
|
└── templates/ # 任务声明模板
|
|
129
183
|
├── code-dev-task.md
|
|
@@ -140,10 +194,10 @@ skills/dev-workflow/
|
|
|
140
194
|
|
|
141
195
|
```
|
|
142
196
|
ai-dev-workflow/
|
|
143
|
-
├── skills/dev-workflow/ #
|
|
197
|
+
├── skills/dev-workflow/ # Agent Harness Workflow Skill(自包含工作流)
|
|
144
198
|
│ ├── SKILL.md
|
|
145
199
|
│ └── references/
|
|
146
|
-
│ ├── workflow.md
|
|
200
|
+
│ ├── workflow.md # Agent harness 生命周期
|
|
147
201
|
│ ├── task-types.md
|
|
148
202
|
│ ├── service-transform.md
|
|
149
203
|
│ └── templates/
|