input-kanban 0.0.16 → 0.0.18
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.en.md +115 -74
- package/README.md +113 -82
- package/RELEASE_NOTES.md +31 -0
- package/bin/input-kanban.js +188 -1
- package/docs/input-kanban-cli-README.md +41 -0
- package/docs/input-kanban-cli-skill.md +241 -0
- package/docs/input-kanban-prepare.md +93 -0
- package/package.json +3 -1
- package/skills/input-kanban-prepare/SKILL.md +97 -0
- package/src/orchestrator.js +4 -0
package/README.en.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
[中文](README.md) | English
|
|
4
4
|
|
|
5
|
-
Input Kanban
|
|
5
|
+
You can think of Input Kanban as a local Codex execution board: you create a task, and it helps you plan, dispatch, run, and judge it. This README focuses on **how to use it**.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Fast Start
|
|
8
8
|
|
|
9
9
|
### 1. Install
|
|
10
10
|
|
|
@@ -12,140 +12,169 @@ Input Kanban is a local Codex orchestration dashboard. The recommended path is t
|
|
|
12
12
|
npm install -g input-kanban
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Verify
|
|
15
|
+
Verify it works:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
input-kanban --help
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
### 2. Start
|
|
21
|
+
### 2. Start inside your target workspace
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
Run it in the directory you want Codex to modify or inspect:
|
|
24
24
|
|
|
25
25
|
```bash
|
|
26
26
|
cd /path/to/your/workspace
|
|
27
27
|
input-kanban
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
By default,
|
|
30
|
+
By default, it starts a local web server at:
|
|
31
31
|
|
|
32
32
|
```text
|
|
33
33
|
http://127.0.0.1:8787
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
Open that URL in your browser to
|
|
36
|
+
Open that URL in your browser to create runs, watch progress, and read results.
|
|
37
37
|
|
|
38
|
-
### 3. Start
|
|
38
|
+
### 3. Start without `cd`
|
|
39
39
|
|
|
40
|
-
If you do not want to
|
|
40
|
+
If you do not want to change directories first, pass the workspace explicitly:
|
|
41
41
|
|
|
42
42
|
```bash
|
|
43
43
|
input-kanban --workspace /path/to/your/workspace
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
`--repo`
|
|
46
|
+
`--repo` is still supported as a compatibility alias.
|
|
47
47
|
|
|
48
|
-
##
|
|
48
|
+
## The 6 Most Common Ways to Use It
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
### 1) Create and run a task in the Web UI
|
|
51
|
+
|
|
52
|
+
1. Click `New Run`
|
|
53
|
+
2. Enter the workspace, worker sandbox, and task description
|
|
54
|
+
3. Click `Create Run`
|
|
55
|
+
4. The dashboard automatically starts planning
|
|
56
|
+
5. After planning, it dispatches workers
|
|
57
|
+
6. After all batches finish, it starts the final judge
|
|
58
|
+
|
|
59
|
+
### 2) Submit a task from the terminal
|
|
51
60
|
|
|
52
61
|
```bash
|
|
53
|
-
input-kanban submit --task
|
|
54
|
-
input-kanban submit --task "Fix the login issue and add regression tests" --label "Fix login issue"
|
|
62
|
+
input-kanban submit --task "Fix the login issue and add regression tests" --label "fix-login"
|
|
55
63
|
```
|
|
56
64
|
|
|
57
|
-
|
|
65
|
+
To load task text from a file:
|
|
58
66
|
|
|
59
|
-
|
|
67
|
+
```bash
|
|
68
|
+
input-kanban submit --task-file task.md
|
|
69
|
+
```
|
|
60
70
|
|
|
61
|
-
|
|
71
|
+
### 3) Pause after planning for approval
|
|
62
72
|
|
|
63
73
|
```bash
|
|
64
|
-
input-kanban submit --task-file task.md -
|
|
74
|
+
input-kanban submit --task-file task.md --plan-approval
|
|
65
75
|
```
|
|
66
76
|
|
|
67
|
-
|
|
77
|
+
This pauses after planning and waits for you to confirm the plan in the Web UI before dispatching workers.
|
|
68
78
|
|
|
69
|
-
|
|
79
|
+
### 4) Create and plan only
|
|
70
80
|
|
|
71
81
|
```bash
|
|
72
|
-
input-kanban submit --task
|
|
73
|
-
input-kanban submit --task-file task.md --max-parallel 2 --worker-sandbox workspace-write
|
|
74
|
-
input-kanban submit --runs-dir ~/.input-kanban/runs --runner tmux -d
|
|
82
|
+
input-kanban submit --task-file task.md --no-auto
|
|
75
83
|
```
|
|
76
84
|
|
|
77
|
-
Check
|
|
85
|
+
### 5) Check progress, result, retry, or stop
|
|
78
86
|
|
|
79
87
|
```bash
|
|
80
|
-
input-kanban
|
|
81
|
-
input-kanban --json runs --active
|
|
82
|
-
input-kanban status
|
|
83
|
-
input-kanban status --watch
|
|
88
|
+
input-kanban status <runId>
|
|
84
89
|
input-kanban status <runId> --watch
|
|
85
|
-
input-kanban
|
|
86
|
-
input-kanban result
|
|
90
|
+
input-kanban result <runId>
|
|
87
91
|
input-kanban result <runId> --copy
|
|
88
|
-
input-kanban --json result <runId>
|
|
89
92
|
input-kanban retry <runId> [taskId]
|
|
90
|
-
input-kanban --json retry <runId> [taskId]
|
|
91
93
|
input-kanban stop <runId>
|
|
92
94
|
```
|
|
93
95
|
|
|
94
|
-
|
|
96
|
+
### 6) If you are an Agent and can only call the CLI
|
|
97
|
+
|
|
98
|
+
Run:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
input-kanban guide
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Or:
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
input-kanban --help
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
`guide` prints an agent-friendly control loop and ready-to-copy templates.
|
|
111
|
+
|
|
112
|
+
To install the bundled `input-kanban-prepare` skill for Codex:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
input-kanban install-skill codex
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
To specify the Codex skills root explicitly:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
input-kanban install-skill codex --target-dir ~/.codex/skills
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Hand Off from an External Agent Conversation
|
|
95
125
|
|
|
96
|
-
|
|
126
|
+
If the task was first discussed in Claude, Cursor, Codex, or another external Agent conversation, prepare a structured `task.md` before handing it to Input Kanban:
|
|
97
127
|
|
|
98
128
|
```bash
|
|
99
|
-
input-kanban --
|
|
100
|
-
input-kanban --host 127.0.0.1
|
|
101
|
-
input-kanban --runs-dir ~/.input-kanban/runs
|
|
102
|
-
input-kanban --codex-bin codex
|
|
103
|
-
input-kanban --runner headless
|
|
104
|
-
input-kanban --open
|
|
129
|
+
input-kanban submit --task-file task.md --plan-approval
|
|
105
130
|
```
|
|
106
131
|
|
|
107
|
-
|
|
132
|
+
A good `task.md` should include at least:
|
|
108
133
|
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
114
|
-
- runner: `headless`
|
|
134
|
+
- `Goal`: what should be completed
|
|
135
|
+
- `Acceptance Criteria`: how completion will be checked
|
|
136
|
+
- `Expected Artifacts`: expected outputs and verification methods
|
|
137
|
+
- `Context References`: relevant files, specs, or prior notes
|
|
138
|
+
- `Risks`: assumptions, risks, and unknowns
|
|
115
139
|
|
|
116
|
-
|
|
140
|
+
See `skills/input-kanban-prepare/SKILL.md` or `docs/input-kanban-prepare.md` for a reusable preparation flow. This gives the planner a stronger execution contract instead of asking it to infer everything from a vague request.
|
|
117
141
|
|
|
118
|
-
|
|
142
|
+
## Quick Command Cheat Sheet
|
|
143
|
+
|
|
144
|
+
```bash
|
|
145
|
+
input-kanban submit --task "..."
|
|
146
|
+
input-kanban submit --task-file task.md
|
|
147
|
+
input-kanban submit --task-file task.md --plan-approval
|
|
148
|
+
input-kanban submit --task-file task.md -d
|
|
149
|
+
input-kanban install-skill codex
|
|
150
|
+
input-kanban --json runs --active
|
|
151
|
+
input-kanban --json status <runId>
|
|
152
|
+
input-kanban --json result <runId>
|
|
153
|
+
input-kanban --json retry <runId> [taskId]
|
|
154
|
+
input-kanban --json stop <runId>
|
|
155
|
+
```
|
|
119
156
|
|
|
120
|
-
|
|
157
|
+
Use `--json` when another tool or script needs structured output.
|
|
121
158
|
|
|
122
|
-
tmux
|
|
159
|
+
## tmux Mode (Optional)
|
|
123
160
|
|
|
124
|
-
|
|
161
|
+
The default runner is `headless`. If you want live terminal visibility for each role, switch to `tmux`:
|
|
125
162
|
|
|
126
|
-
|
|
163
|
+
```bash
|
|
164
|
+
input-kanban submit --task-file task.md --runner tmux
|
|
165
|
+
```
|
|
127
166
|
|
|
128
|
-
|
|
129
|
-
2. Enter a label, workspace, worker sandbox, and task description.
|
|
130
|
-
3. Click `Create Run`.
|
|
131
|
-
4. The dashboard automatically starts `Plan` so the Codex planner can generate batches and workers.
|
|
132
|
-
5. After planning completes, Web auto mode dispatches workers by batch barrier and concurrency limits by default.
|
|
133
|
-
6. After all batches complete, Web auto mode starts the final judge by default.
|
|
134
|
-
7. Inspect execution logs, final messages, error logs, and artifacts.
|
|
135
|
-
8. Stop or archive a run when needed, or manually click buttons to retry/advance, or manually mark a confirmed failed/unknown worker as completed.
|
|
167
|
+
Use tmux mode when you want to:
|
|
136
168
|
|
|
137
|
-
|
|
169
|
+
- watch planner / worker / judge output live
|
|
170
|
+
- see the overview pane and worker panes in each batch window
|
|
171
|
+
- inspect the run process locally
|
|
138
172
|
|
|
139
|
-
|
|
140
|
-
- Control execution order with batch barriers.
|
|
141
|
-
- Observe each worker's local status, logs, and final response.
|
|
142
|
-
- In tmux runner mode, inspect an overview pane and worker panes inside each batch window.
|
|
143
|
-
- Run a final judge after all workers complete.
|
|
144
|
-
- Keep local run records for debugging and recovery.
|
|
173
|
+
If you do not need terminal visibility, keep using the default `headless` runner.
|
|
145
174
|
|
|
146
175
|
## Runtime Data Location
|
|
147
176
|
|
|
148
|
-
Runtime data is stored in the
|
|
177
|
+
Runtime data is stored in the default runs directory:
|
|
149
178
|
|
|
150
179
|
```text
|
|
151
180
|
~/.input-kanban/runs
|
|
@@ -167,16 +196,24 @@ runs/<runId>/
|
|
|
167
196
|
|
|
168
197
|
These files are local run records and do not need to be committed to your application workspace.
|
|
169
198
|
|
|
199
|
+
## What You Usually Do with It
|
|
200
|
+
|
|
201
|
+
- Split a larger Codex task into multiple execution steps
|
|
202
|
+
- Watch planning, execution, and results in the Web UI
|
|
203
|
+
- Automate submit / status / retry / result / stop flows from the terminal
|
|
204
|
+
- Add a human approval gate with `--plan-approval` when needed
|
|
205
|
+
- Use tmux only when you want live terminal inspection
|
|
206
|
+
|
|
170
207
|
## Requirements
|
|
171
208
|
|
|
172
|
-
- Node.js 20 or newer
|
|
173
|
-
- Codex CLI installed and
|
|
174
|
-
- `tmux` installed
|
|
175
|
-
- The `codex` command works in your terminal, or `--codex-bin` points to the
|
|
209
|
+
- Node.js 20 or newer
|
|
210
|
+
- Codex CLI installed and available
|
|
211
|
+
- `tmux` installed if you want `--runner tmux`
|
|
212
|
+
- The `codex` command works in your terminal, or `--codex-bin` points to the executable
|
|
176
213
|
|
|
177
214
|
## Maintainer Development
|
|
178
215
|
|
|
179
|
-
If you want to develop Input Kanban itself
|
|
216
|
+
If you want to develop Input Kanban itself:
|
|
180
217
|
|
|
181
218
|
```bash
|
|
182
219
|
git clone https://github.com/zhang3xing1/Input-Kanban.git
|
|
@@ -202,3 +239,7 @@ npm run check
|
|
|
202
239
|
|
|
203
240
|
- [Project guide](PROJECT_GUIDE.md)
|
|
204
241
|
- [Environment variables](ENVIRONMENT.md)
|
|
242
|
+
- [Agent CLI README](docs/input-kanban-cli-README.md)
|
|
243
|
+
- [Agent CLI Skill draft](docs/input-kanban-cli-skill.md)
|
|
244
|
+
- [Structured handoff guide](docs/input-kanban-prepare.md)
|
|
245
|
+
- [input-kanban-prepare Skill](skills/input-kanban-prepare/SKILL.md)
|
package/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
中文 | [English](README.en.md)
|
|
4
4
|
|
|
5
|
-
Input Kanban
|
|
5
|
+
你可以把 Input Kanban 当成一个本地 Codex 执行看板:先把任务放进来,再让它自动拆分、派发、执行和验收。下面重点讲**怎么用**,不是讲内部实现。
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## 最快开始
|
|
8
8
|
|
|
9
9
|
### 1. 安装
|
|
10
10
|
|
|
@@ -12,15 +12,15 @@ Input Kanban 是一个本地 Codex 编排看板。推荐通过 npm 安装,然
|
|
|
12
12
|
npm install -g input-kanban
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
确认可用:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
input-kanban --help
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
### 2.
|
|
21
|
+
### 2. 进入目标工作区
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
在你要让 Codex 修改或检查的目录里启动:
|
|
24
24
|
|
|
25
25
|
```bash
|
|
26
26
|
cd /path/to/your/workspace
|
|
@@ -33,133 +33,152 @@ input-kanban
|
|
|
33
33
|
http://127.0.0.1:8787
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
打开浏览器后,你就可以直接创建任务批次、看执行状态、看结果。
|
|
37
37
|
|
|
38
|
-
### 3.
|
|
39
|
-
|
|
40
|
-
如果不想先 `cd` 到目标工作区,也可以显式指定:
|
|
38
|
+
### 3. 不想先 `cd`?直接指定工作区
|
|
41
39
|
|
|
42
40
|
```bash
|
|
43
41
|
input-kanban --workspace /path/to/your/workspace
|
|
44
42
|
```
|
|
45
43
|
|
|
46
|
-
`--repo`
|
|
44
|
+
`--repo` 也可以继续用,作为兼容别名。
|
|
45
|
+
|
|
46
|
+
## 最常见的 6 个用法
|
|
47
|
+
|
|
48
|
+
### 1) 在网页里新建并自动执行
|
|
47
49
|
|
|
48
|
-
|
|
50
|
+
1. 点击 `新建任务批次`
|
|
51
|
+
2. 填好工作区、Worker 沙箱和任务说明
|
|
52
|
+
3. 点击 `创建批次`
|
|
53
|
+
4. 看板会自动发起 `拆分任务`
|
|
54
|
+
5. 拆分完成后自动派发 worker
|
|
55
|
+
6. 所有批次完成后自动发起最终验收
|
|
49
56
|
|
|
50
|
-
|
|
57
|
+
### 2) 从终端直接提交一个任务
|
|
51
58
|
|
|
52
59
|
```bash
|
|
53
|
-
input-kanban submit --task-file task.md --label "修复登录问题"
|
|
54
60
|
input-kanban submit --task "修复登录问题,并补充回归测试" --label "修复登录问题"
|
|
55
61
|
```
|
|
56
62
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
如果希望 Planner 拆分完成后先看一眼计划,再放行执行,可以加计划确认 Gate:
|
|
63
|
+
如果你想从文件读任务:
|
|
60
64
|
|
|
61
65
|
```bash
|
|
62
|
-
input-kanban submit --task-file task.md
|
|
66
|
+
input-kanban submit --task-file task.md
|
|
63
67
|
```
|
|
64
68
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
`input-kanban serve` 会启动一个轻量后台 scheduler,持续刷新并推进未完成的 run:plan ready 后派发 batch、串行 batch 完成后启动下一批、全部 batch 完成后启动 final judge。CLI `submit --auto` / `input-kanban auto <runId>` 与 Web server 共用同一套 orchestrator 自动推进逻辑,因此任务推进不再依赖浏览器页面是否打开或刷新。若 run 配置了计划确认 Gate,auto/scheduler 会停在该 Gate,不会越过未确认的计划。
|
|
68
|
-
|
|
69
|
-
如果希望提交后立即返回,让任务在后台自动执行,可以加 `-d` / `--detach`:
|
|
69
|
+
### 3) 先看计划,再决定是否执行
|
|
70
70
|
|
|
71
71
|
```bash
|
|
72
|
-
input-kanban submit --task-file task.md -
|
|
72
|
+
input-kanban submit --task-file task.md --plan-approval
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
这会在规划完成后停在“已拆分,待确认”,等你在 Web 上点 `开始执行` 再继续。
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
### 4) 只想创建并规划,不马上派发
|
|
78
78
|
|
|
79
79
|
```bash
|
|
80
|
-
input-kanban submit --task
|
|
81
|
-
input-kanban submit --task-file task.md --max-parallel 2 --worker-sandbox workspace-write
|
|
82
|
-
input-kanban submit --runs-dir ~/.input-kanban/runs --runner tmux -d
|
|
80
|
+
input-kanban submit --task-file task.md --no-auto
|
|
83
81
|
```
|
|
84
82
|
|
|
85
|
-
|
|
83
|
+
### 5) 查看进度 / 结果 / 重试 / 停止
|
|
86
84
|
|
|
87
85
|
```bash
|
|
88
|
-
input-kanban
|
|
89
|
-
input-kanban --json runs --active
|
|
90
|
-
input-kanban status
|
|
91
|
-
input-kanban status --watch
|
|
86
|
+
input-kanban status <runId>
|
|
92
87
|
input-kanban status <runId> --watch
|
|
93
|
-
input-kanban
|
|
94
|
-
input-kanban result
|
|
88
|
+
input-kanban result <runId>
|
|
95
89
|
input-kanban result <runId> --copy
|
|
96
|
-
input-kanban --json result <runId>
|
|
97
90
|
input-kanban retry <runId> [taskId]
|
|
98
|
-
input-kanban --json retry <runId> [taskId]
|
|
99
91
|
input-kanban stop <runId>
|
|
100
92
|
```
|
|
101
93
|
|
|
102
|
-
|
|
94
|
+
### 6) 如果你是 Agent,只会调用 CLI
|
|
95
|
+
|
|
96
|
+
直接运行:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
input-kanban guide
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
或者:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
input-kanban --help
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
`guide` 会输出一个更适合 Agent 的操作循环和可直接复制的示例模板。
|
|
103
109
|
|
|
104
|
-
|
|
110
|
+
如果你想把内置的 `input-kanban-prepare` skill 安装到 Codex:
|
|
105
111
|
|
|
106
112
|
```bash
|
|
107
|
-
input-kanban
|
|
108
|
-
input-kanban --host 127.0.0.1
|
|
109
|
-
input-kanban --runs-dir ~/.input-kanban/runs
|
|
110
|
-
input-kanban --codex-bin codex
|
|
111
|
-
input-kanban --runner headless
|
|
112
|
-
input-kanban --open
|
|
113
|
+
input-kanban install-skill codex
|
|
113
114
|
```
|
|
114
115
|
|
|
115
|
-
|
|
116
|
+
如需指定 Codex skills 根目录:
|
|
116
117
|
|
|
117
|
-
|
|
118
|
-
-
|
|
119
|
-
|
|
120
|
-
- runs 目录:`~/.input-kanban/runs`
|
|
121
|
-
- Codex 命令:`codex`
|
|
122
|
-
- runner:`headless`
|
|
118
|
+
```bash
|
|
119
|
+
input-kanban install-skill codex --target-dir ~/.codex/skills
|
|
120
|
+
```
|
|
123
121
|
|
|
124
|
-
|
|
122
|
+
## 从外部 Agent 对话交给看板执行
|
|
125
123
|
|
|
126
|
-
|
|
124
|
+
如果任务先在 Claude、Cursor、Codex 或其它外部 Agent 对话里讨论,建议先整理成结构化 `task.md`,再交给 Input Kanban:
|
|
127
125
|
|
|
128
|
-
|
|
126
|
+
```bash
|
|
127
|
+
input-kanban submit --task-file task.md --plan-approval
|
|
128
|
+
```
|
|
129
129
|
|
|
130
|
-
|
|
130
|
+
推荐 `task.md` 至少包含:
|
|
131
131
|
|
|
132
|
-
|
|
132
|
+
- `Goal`:这次要完成什么
|
|
133
|
+
- `Acceptance Criteria`:怎么判断完成
|
|
134
|
+
- `Expected Artifacts`:期望产物和验证方式
|
|
135
|
+
- `Context References`:相关文件、spec、历史记录
|
|
136
|
+
- `Risks`:风险、假设和不确定点
|
|
133
137
|
|
|
134
|
-
|
|
138
|
+
可以参考 `skills/input-kanban-prepare/SKILL.md` 或 `docs/input-kanban-prepare.md`。这样 planner 会拿到更稳定的执行契约,而不是从一段模糊需求里从零猜。
|
|
135
139
|
|
|
136
|
-
|
|
137
|
-
2. 输入批次名称、工作区、Worker 沙箱和任务说明。
|
|
138
|
-
3. 点击 `创建批次`。
|
|
139
|
-
4. 看板会自动发起 `拆分任务`,让 Codex planner 生成 batches 和 workers。
|
|
140
|
-
5. 拆分完成后,Web 默认自动派发执行,按 batch barrier 和并发限制运行 workers。
|
|
141
|
-
6. 所有 batch 完成后,Web 默认自动发起 `汇总验收`。
|
|
142
|
-
7. 查看执行日志、最终回复、错误日志和产物。
|
|
143
|
-
8. 必要时可以停止或归档 run,也可以手动点击按钮重试、推进,或手动标记已确认完成的失败/未知 worker。
|
|
140
|
+
## 常用命令速查
|
|
144
141
|
|
|
145
|
-
|
|
142
|
+
```bash
|
|
143
|
+
input-kanban submit --task "..."
|
|
144
|
+
input-kanban submit --task-file task.md
|
|
145
|
+
input-kanban submit --task-file task.md --plan-approval
|
|
146
|
+
input-kanban submit --task-file task.md -d
|
|
147
|
+
input-kanban install-skill codex
|
|
148
|
+
input-kanban --json runs --active
|
|
149
|
+
input-kanban --json status <runId>
|
|
150
|
+
input-kanban --json result <runId>
|
|
151
|
+
input-kanban --json retry <runId> [taskId]
|
|
152
|
+
input-kanban --json stop <runId>
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
如果你需要让脚本或其它工具接管,`--json` 会给出结构化输出。
|
|
156
|
+
|
|
157
|
+
## tmux 模式(可选)
|
|
146
158
|
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
-
|
|
151
|
-
|
|
152
|
-
- 保留本地运行记录,便于排查和恢复。
|
|
159
|
+
默认 runner 是 `headless`。如果你想在终端里实时看每个角色怎么跑,可以切到 `tmux`:
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
input-kanban submit --task-file task.md --runner tmux
|
|
163
|
+
```
|
|
153
164
|
|
|
154
|
-
|
|
165
|
+
tmux 模式适合:
|
|
155
166
|
|
|
156
|
-
|
|
167
|
+
- 想看 planner / worker / judge 的实时终端输出
|
|
168
|
+
- 想在 batch window 里同时看 overview pane 和 worker panes
|
|
169
|
+
- 想在本地排查执行过程
|
|
170
|
+
|
|
171
|
+
如果你不需要终端可视化,就继续用默认的 `headless`。
|
|
172
|
+
|
|
173
|
+
## 数据会存到哪里
|
|
174
|
+
|
|
175
|
+
默认运行数据目录是:
|
|
157
176
|
|
|
158
177
|
```text
|
|
159
178
|
~/.input-kanban/runs
|
|
160
179
|
```
|
|
161
180
|
|
|
162
|
-
每个 run
|
|
181
|
+
每个 run 大致会长这样:
|
|
163
182
|
|
|
164
183
|
```text
|
|
165
184
|
runs/<runId>/
|
|
@@ -173,18 +192,26 @@ runs/<runId>/
|
|
|
173
192
|
└── verdict.json
|
|
174
193
|
```
|
|
175
194
|
|
|
176
|
-
|
|
195
|
+
这些都是本地运行记录,不需要提交到你的业务仓库。
|
|
196
|
+
|
|
197
|
+
## 你通常会怎么用它
|
|
198
|
+
|
|
199
|
+
- 把一个较大的 Codex 编程任务拆成多个执行步骤
|
|
200
|
+
- 在 Web 里看计划、执行、结果
|
|
201
|
+
- 在终端里自动提交、查看、重试、停止
|
|
202
|
+
- 在需要时用 `plan-approval` 增加一个人工确认关口
|
|
203
|
+
- 在需要终端细节时用 `tmux` 看实时过程
|
|
177
204
|
|
|
178
205
|
## 使用前提
|
|
179
206
|
|
|
180
|
-
-
|
|
181
|
-
-
|
|
182
|
-
-
|
|
183
|
-
- `codex`
|
|
207
|
+
- Node.js 20 或更高版本
|
|
208
|
+
- 已安装并可用的 Codex CLI
|
|
209
|
+
- 如果要用 `--runner tmux`,本机需要安装 `tmux`
|
|
210
|
+
- `codex` 命令在终端可用,或通过 `--codex-bin` 指定可执行文件
|
|
184
211
|
|
|
185
212
|
## 维护者开发
|
|
186
213
|
|
|
187
|
-
如果你要开发 Input Kanban
|
|
214
|
+
如果你要开发 Input Kanban 本身:
|
|
188
215
|
|
|
189
216
|
```bash
|
|
190
217
|
git clone https://github.com/zhang3xing1/Input-Kanban.git
|
|
@@ -210,3 +237,7 @@ npm run check
|
|
|
210
237
|
|
|
211
238
|
- [项目实现说明](PROJECT_GUIDE.md)
|
|
212
239
|
- [环境变量](ENVIRONMENT.md)
|
|
240
|
+
- [Agent CLI 说明](docs/input-kanban-cli-README.md)
|
|
241
|
+
- [Agent CLI Skill 草稿](docs/input-kanban-cli-skill.md)
|
|
242
|
+
- [结构化手交说明](docs/input-kanban-prepare.md)
|
|
243
|
+
- [input-kanban-prepare Skill](skills/input-kanban-prepare/SKILL.md)
|
package/RELEASE_NOTES.md
CHANGED
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# Release Notes
|
|
2
2
|
|
|
3
|
+
## v0.0.18
|
|
4
|
+
|
|
5
|
+
### Highlights
|
|
6
|
+
|
|
7
|
+
- Rework the main README files to focus on how to use Input Kanban instead of only describing what it is.
|
|
8
|
+
- Add `skills/input-kanban-prepare/SKILL.md` and `docs/input-kanban-prepare.md` for structured task handoff from external Agent conversations.
|
|
9
|
+
- Add `input-kanban install-skill codex` to install the bundled `input-kanban-prepare` skill into a Codex skills directory.
|
|
10
|
+
- Extend `input-kanban guide` and `input-kanban --help` with a handoff-aware preparation flow and execution template.
|
|
11
|
+
- Teach the planner prompt to treat structured handoff sections such as Goal, Acceptance Criteria, and Expected Artifacts as the execution contract.
|
|
12
|
+
|
|
13
|
+
### Verification
|
|
14
|
+
|
|
15
|
+
- `node --test test/cli-submit.test.js` passed locally.
|
|
16
|
+
- `git diff --check` passed locally.
|
|
17
|
+
- `node --check bin/input-kanban.js && node --check src/orchestrator.js` passed locally.
|
|
18
|
+
- Windows-native validation passed on `zhangxing_win` with `npm run check` in the Windows release-candidate working tree.
|
|
19
|
+
|
|
20
|
+
## v0.0.17
|
|
21
|
+
|
|
22
|
+
### Highlights
|
|
23
|
+
|
|
24
|
+
- Add a friendly `input-kanban guide` CLI entry that prints an agent-oriented control loop, decision rules, and ready-to-copy execution templates.
|
|
25
|
+
- Extend `input-kanban --help` with a visible agent guide entry point so CLI-only agents can discover the execution flow without reading repository docs.
|
|
26
|
+
- Add a small `docs/input-kanban-cli-README.md` entry page and a reusable `docs/input-kanban-cli-skill.md` execution guide for external-project reuse.
|
|
27
|
+
|
|
28
|
+
### Verification
|
|
29
|
+
|
|
30
|
+
- `node --test test/cli-submit.test.js` passed locally.
|
|
31
|
+
- `git diff --check` passed locally.
|
|
32
|
+
- Windows-native validation passed on `zhangxing_win` with `npm run check` in the Windows release-candidate working tree.
|
|
33
|
+
|
|
3
34
|
## v0.0.16
|
|
4
35
|
|
|
5
36
|
### Highlights
|