@akagilnc/pi-workflow-roles 0.1.2033 → 0.1.2041

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.
Files changed (7) hide show
  1. package/README.md +88 -1
  2. package/README.zh-CN.md +88 -1
  3. package/dist/public-cli/main.js +1051 -443
  4. package/package.json +1 -1
  5. package/src/public-cli/cli.ts +95 -53
  6. package/src/public-cli/invocation.ts +295 -404
  7. package/src/public-cli/option-definitions.ts +1173 -0
package/README.md CHANGED
@@ -37,7 +37,7 @@ Receipts are typed, so callers compose roles without parsing prose; ordering and
37
37
 
38
38
  ## Call the roles
39
39
 
40
- Most roles accept `--attach <file>` (repeatable, frozen at admission), but Reviewer does not. Reviewer requires `--base <revision>` to select the fixed point, and its review materials are acquired through the package-owned bundle mechanism rather than caller attachments. All roles accept `--project <path>`. An instruction is optional for judge, collector, and doctor, and required nonblank for coder, fixer, reviewer, and merger.
40
+ Public option identity, aliases, requiredness, and mode faces live in the generated [Public CLI options](#public-cli-options-generated) table and in `ak-role help <command>` — both project the same typed source. The examples below are usage sketches, not a second flag contract. An instruction is optional for judge, collector, and doctor, and required nonblank for coder, fixer, reviewer, and merger.
41
41
 
42
42
  ```bash
43
43
  # judge — adjudicate the supplied materials; infers its burden, no burden flag
@@ -102,3 +102,90 @@ Discipline:
102
102
  - keep `stderr.log` and `invocation.json` in the same `runs/` directory, as in the example above.
103
103
 
104
104
  Codex fast tier: enable fast tier with `echo "fast_mode = on" > ~/.pi-codex-fast`; disable it with `echo "fast_mode = off" > ~/.pi-codex-fast` (or delete the file). The change takes effect on the next request without a restart. Fast tier costs more than the default tier.
105
+
106
+ <!-- BEGIN GENERATED: public-cli-options -->
107
+ ## Public CLI options (generated)
108
+
109
+ Generated from `src/public-cli/option-definitions.ts`. Prefer `ak-role help <command>`. Do not hand-edit this section.
110
+
111
+ ### `global`
112
+
113
+ | Spelling | Aliases | Value | Required | Repeatable | Form | Modes/Phases | Description |
114
+ | --- | --- | --- | --- | --- | --- | --- | --- |
115
+ | `--model` | — | `provider/model` | no | no | option | — | Override the effective seat model for this invocation (before or after the command). |
116
+ | `--thinking` | — | `level` | no | no | option | — | Override thinking level: off\|minimal\|low\|medium\|high\|xhigh\|max. |
117
+ | `--help` | `-h` | — | no | no | option | — | Show public CLI help and exit. |
118
+
119
+ ### `judge`
120
+
121
+ | Spelling | Aliases | Value | Required | Repeatable | Form | Modes/Phases | Description |
122
+ | --- | --- | --- | --- | --- | --- | --- | --- |
123
+ | `--project` | — | `path` | no | no | option | — | Project root for ledger identity (defaults to process cwd). |
124
+ | `--attach` | — | `path` | no | yes | option | — | Attach a regular file; frozen at admission (repeatable). |
125
+
126
+ ### `coder`
127
+
128
+ | Spelling | Aliases | Value | Required | Repeatable | Form | Modes/Phases | Description |
129
+ | --- | --- | --- | --- | --- | --- | --- | --- |
130
+ | `plan\|apply` | `plan`, `apply` | — | no | no | positional | phases=plan\|apply; default=apply | Optional phase token before the instruction; defaults to apply. |
131
+ | `--project` | — | `path` | no | no | option | — | Project root for ledger identity (defaults to process cwd). |
132
+ | `--attach` | — | `path` | no | yes | option | — | Attach a regular file; frozen at admission (repeatable). |
133
+
134
+ ### `fixer`
135
+
136
+ | Spelling | Aliases | Value | Required | Repeatable | Form | Modes/Phases | Description |
137
+ | --- | --- | --- | --- | --- | --- | --- | --- |
138
+ | `plan\|apply` | `plan`, `apply` | — | no | no | positional | phases=plan\|apply; default=apply | Optional phase token before the instruction; defaults to apply. |
139
+ | `--project` | — | `path` | no | no | option | — | Project root for ledger identity (defaults to process cwd). |
140
+ | `--attach` | — | `path` | no | yes | option | — | Attach a regular file; frozen at admission (repeatable). |
141
+ | `--prerequisites` | — | `path` | no | no | option | — | JSON array of {id, requirement} prerequisite objects. |
142
+
143
+ ### `reviewer`
144
+
145
+ | Spelling | Aliases | Value | Required | Repeatable | Form | Modes/Phases | Description |
146
+ | --- | --- | --- | --- | --- | --- | --- | --- |
147
+ | `--project` | — | `path` | no | no | option | — | Project root for ledger identity (defaults to process cwd). |
148
+ | `--base` | — | `revision` | yes | no | option | — | Required fixed-point revision for the pinned review target. |
149
+ | `--authority-ref` | — | `ref` | no | yes | option | — | Durable authority reference/URL (repeatable; refs only, not inline prose). |
150
+
151
+ ### `collector`
152
+
153
+ | Spelling | Aliases | Value | Required | Repeatable | Form | Modes/Phases | Description |
154
+ | --- | --- | --- | --- | --- | --- | --- | --- |
155
+ | `--project` | — | `path` | no | no | option | — | Project root for ledger identity (defaults to process cwd). |
156
+ | `--attach` | — | `path` | no | yes | option | — | Attach a regular file; frozen at admission (repeatable). |
157
+ | `--pr` | — | `number` | yes | no | option | — | Required positive GitHub pull request number. |
158
+ | `--repo` | — | `owner/repo` | no | no | option | — | GitHub owner/repo override (defaults from origin when github.com). |
159
+ | `--request-manifest` | — | `path` | no | no | option | — | Optional request manifest JSON path ({requests:[{id,body}]}). |
160
+
161
+ ### `doctor`
162
+
163
+ | Spelling | Aliases | Value | Required | Repeatable | Form | Modes/Phases | Description |
164
+ | --- | --- | --- | --- | --- | --- | --- | --- |
165
+ | `--project` | — | `path` | no | no | option | — | Project root for ledger identity (defaults to process cwd). |
166
+ | `--attach` | — | `path` | no | yes | option | — | Attach a regular file; frozen at admission (repeatable). |
167
+ | `--issue` | — | `number` | yes | no | option | — | Required positive issue number for the retained case. |
168
+ | `--runs` | — | `path` | no | no | option | — | Optional project-relative .ak-roles/books/<book>/issues/<n>/runs override matching --issue. |
169
+
170
+ ### `merger`
171
+
172
+ | Spelling | Aliases | Value | Required | Repeatable | Form | Modes/Phases | Description |
173
+ | --- | --- | --- | --- | --- | --- | --- | --- |
174
+ | `--project` | — | `path` | no | no | option | — | Project root with one ordinary in-progress merge (defaults to cwd). |
175
+ | `--attach` | — | `path` | no | yes | option | — | Attach a regular file; frozen at admission (repeatable). |
176
+
177
+ ### `taishi`
178
+
179
+ | Spelling | Aliases | Value | Required | Repeatable | Form | Modes/Phases | Description |
180
+ | --- | --- | --- | --- | --- | --- | --- | --- |
181
+ | `sweep` | — | — | no | no | positional | modes=sweep | Optional sweep mode token (at most once; no other positionals). |
182
+ | `--project-root` | — | `path` | when:model-groups | yes | option | modes=issue\|model-groups; max=issue:1 | Project-root scope key. Issue: at most one (with --ticket at least one of the two). Model-groups: one or more required. |
183
+ | `--ticket` | — | `number` | no | no | option | modes=issue | Ticket/issue number for issue mode (with --project-root at least one of the two). |
184
+ | `--attach` | — | `path` | when:sweep | yes | option | modes=sweep; max=sweep:1 | Sweep-mode attachment path; required exactly once in sweep; payload is the attachment body. |
185
+ | `--cohort` | — | — | no | no | option | modes=cohort; xor=model-groups | Select cohort mode (mutually exclusive with --model-groups). |
186
+ | `--model-groups` | — | — | no | no | option | modes=model-groups; xor=cohort | Select model-groups mode (mutually exclusive with --cohort). |
187
+ | `--group-a-label` | — | `label` | when:cohort | no | option | modes=cohort | Cohort group A label (required in cohort mode). |
188
+ | `--group-a-issues` | — | `N[,N...]` | when:cohort | no | option | modes=cohort | Cohort group A comma-separated positive issue numbers (required in cohort mode). |
189
+ | `--group-b-label` | — | `label` | when:cohort | no | option | modes=cohort | Cohort group B label (required in cohort mode). |
190
+ | `--group-b-issues` | — | `N[,N...]` | when:cohort | no | option | modes=cohort | Cohort group B comma-separated positive issue numbers (required in cohort mode). |
191
+ <!-- END GENERATED: public-cli-options -->
package/README.zh-CN.md CHANGED
@@ -37,7 +37,7 @@ ak-role config set navigator openai-codex/gpt-5.6-luna:medium
37
37
 
38
38
  ## 调用百官
39
39
 
40
- 多数角色支持 `--attach <文件>`（可重复，受理即冻结），但御史台不接受该旗标。御史台必须用 `--base <revision>` 选定 fixed point，审查材料由包内 bundle 机制取得，而非由调用者附加。所有角色都支持 `--project <路径>`。指令对大理寺、门下省、太医署可省略，对将作监、修内司、御史台、校书郎必须非空。
40
+ 公开 option 身份、别名、必填性与 mode 面以生成区 [公开 CLI 选项（生成）](#公开-cli-选项生成) 与 `ak-role help <command>` 为准——二者同源。下例只是用法速写，不是第二份旗标合同。指令对大理寺、门下省、太医署可省略，对将作监、修内司、御史台、校书郎必须非空。
41
41
 
42
42
  ```bash
43
43
  # 大理寺——审断所供材料；自行推断举证责任，无 burden 旗标
@@ -131,3 +131,90 @@ pi --no-extensions \
131
131
  - `stderr.log` 与 `invocation.json` 落在同次 `runs/` 目录，如上例。
132
132
 
133
133
  Codex fast 档：开启：`echo "fast_mode = on" > ~/.pi-codex-fast`；关闭：`echo "fast_mode = off" > ~/.pi-codex-fast`（或删文件）。修改后无需重启，下一个请求即生效。Fast 档价格高于默认档。
134
+
135
+ <!-- BEGIN GENERATED: public-cli-options -->
136
+ ## 公开 CLI 选项（生成）
137
+
138
+ 本表由 `src/public-cli/option-definitions.ts` 生成；以 `ak-role help <command>` 为准。勿手改本区。
139
+
140
+ ### `global`
141
+
142
+ | 拼写 | 别名 | 值 | 必填 | 可重复 | 形式 | 模式/阶段 | 说明 |
143
+ | --- | --- | --- | --- | --- | --- | --- | --- |
144
+ | `--model` | — | `provider/model` | 否 | 否 | option | — | 覆盖本调用有效席位模型（可置于子命令前或后）。 |
145
+ | `--thinking` | — | `level` | 否 | 否 | option | — | 覆盖 thinking 档位：off\|minimal\|low\|medium\|high\|xhigh\|max。 |
146
+ | `--help` | `-h` | — | 否 | 否 | option | — | 显示公开 CLI 帮助并退出。 |
147
+
148
+ ### `judge`
149
+
150
+ | 拼写 | 别名 | 值 | 必填 | 可重复 | 形式 | 模式/阶段 | 说明 |
151
+ | --- | --- | --- | --- | --- | --- | --- | --- |
152
+ | `--project` | — | `path` | 否 | 否 | option | — | 卷宗身份用的项目根（默认进程 cwd）。 |
153
+ | `--attach` | — | `path` | 否 | 是 | option | — | 附加普通文件；受理即冻结（可重复）。 |
154
+
155
+ ### `coder`
156
+
157
+ | 拼写 | 别名 | 值 | 必填 | 可重复 | 形式 | 模式/阶段 | 说明 |
158
+ | --- | --- | --- | --- | --- | --- | --- | --- |
159
+ | `plan\|apply` | `plan`, `apply` | — | 否 | 否 | positional | phases=plan\|apply; default=apply | 指令前可选 phase 词元；默认 apply。 |
160
+ | `--project` | — | `path` | 否 | 否 | option | — | 卷宗身份用的项目根（默认进程 cwd）。 |
161
+ | `--attach` | — | `path` | 否 | 是 | option | — | 附加普通文件；受理即冻结（可重复）。 |
162
+
163
+ ### `fixer`
164
+
165
+ | 拼写 | 别名 | 值 | 必填 | 可重复 | 形式 | 模式/阶段 | 说明 |
166
+ | --- | --- | --- | --- | --- | --- | --- | --- |
167
+ | `plan\|apply` | `plan`, `apply` | — | 否 | 否 | positional | phases=plan\|apply; default=apply | 指令前可选 phase 词元；默认 apply。 |
168
+ | `--project` | — | `path` | 否 | 否 | option | — | 卷宗身份用的项目根（默认进程 cwd）。 |
169
+ | `--attach` | — | `path` | 否 | 是 | option | — | 附加普通文件；受理即冻结（可重复）。 |
170
+ | `--prerequisites` | — | `path` | 否 | 否 | option | — | {id, requirement} 前置条件 JSON 数组路径。 |
171
+
172
+ ### `reviewer`
173
+
174
+ | 拼写 | 别名 | 值 | 必填 | 可重复 | 形式 | 模式/阶段 | 说明 |
175
+ | --- | --- | --- | --- | --- | --- | --- | --- |
176
+ | `--project` | — | `path` | 否 | 否 | option | — | 卷宗身份用的项目根（默认进程 cwd）。 |
177
+ | `--base` | — | `revision` | 是 | 否 | option | — | 必填；钉住审查目标的 fixed-point revision。 |
178
+ | `--authority-ref` | — | `ref` | 否 | 是 | option | — | 持久 authority 引用/URL（可重复；仅 ref，非内联散文）。 |
179
+
180
+ ### `collector`
181
+
182
+ | 拼写 | 别名 | 值 | 必填 | 可重复 | 形式 | 模式/阶段 | 说明 |
183
+ | --- | --- | --- | --- | --- | --- | --- | --- |
184
+ | `--project` | — | `path` | 否 | 否 | option | — | 卷宗身份用的项目根（默认进程 cwd）。 |
185
+ | `--attach` | — | `path` | 否 | 是 | option | — | 附加普通文件；受理即冻结（可重复）。 |
186
+ | `--pr` | — | `number` | 是 | 否 | option | — | 必填；正整数 GitHub PR 号。 |
187
+ | `--repo` | — | `owner/repo` | 否 | 否 | option | — | GitHub owner/repo 覆盖（默认取 github.com origin）。 |
188
+ | `--request-manifest` | — | `path` | 否 | 否 | option | — | 可选 request manifest JSON 路径（{requests:[{id,body}]}）。 |
189
+
190
+ ### `doctor`
191
+
192
+ | 拼写 | 别名 | 值 | 必填 | 可重复 | 形式 | 模式/阶段 | 说明 |
193
+ | --- | --- | --- | --- | --- | --- | --- | --- |
194
+ | `--project` | — | `path` | 否 | 否 | option | — | 卷宗身份用的项目根（默认进程 cwd）。 |
195
+ | `--attach` | — | `path` | 否 | 是 | option | — | 附加普通文件；受理即冻结（可重复）。 |
196
+ | `--issue` | — | `number` | 是 | 否 | option | — | 必填；留存病例的正整数 issue 号。 |
197
+ | `--runs` | — | `path` | 否 | 否 | option | — | 可选项目相对 .ak-roles/books/<book>/issues/<n>/runs 覆盖，且须匹配 --issue。 |
198
+
199
+ ### `merger`
200
+
201
+ | 拼写 | 别名 | 值 | 必填 | 可重复 | 形式 | 模式/阶段 | 说明 |
202
+ | --- | --- | --- | --- | --- | --- | --- | --- |
203
+ | `--project` | — | `path` | 否 | 否 | option | — | 已有进行中 ordinary merge 的项目根（默认 cwd）。 |
204
+ | `--attach` | — | `path` | 否 | 是 | option | — | 附加普通文件；受理即冻结（可重复）。 |
205
+
206
+ ### `taishi`
207
+
208
+ | 拼写 | 别名 | 值 | 必填 | 可重复 | 形式 | 模式/阶段 | 说明 |
209
+ | --- | --- | --- | --- | --- | --- | --- | --- |
210
+ | `sweep` | — | — | 否 | 否 | positional | modes=sweep | 可选 sweep 模式词元（至多一次；不得夹带其他 positional）。 |
211
+ | `--project-root` | — | `path` | 条件:model-groups | 是 | option | modes=issue\|model-groups; max=issue:1 | projectRoot 范围键。issue：至多一个（与 --ticket 至少居其一）。model-groups：一个或多个且必填。 |
212
+ | `--ticket` | — | `number` | 否 | 否 | option | modes=issue | issue 模式的票号（与 --project-root 至少居其一）。 |
213
+ | `--attach` | — | `path` | 条件:sweep | 是 | option | modes=sweep; max=sweep:1 | sweep 模式附件路径；sweep 必填且恰一次；载荷为附件正文。 |
214
+ | `--cohort` | — | — | 否 | 否 | option | modes=cohort; xor=model-groups | 选择 cohort 模式（与 --model-groups 互斥）。 |
215
+ | `--model-groups` | — | — | 否 | 否 | option | modes=model-groups; xor=cohort | 选择 model-groups 模式（与 --cohort 互斥）。 |
216
+ | `--group-a-label` | — | `label` | 条件:cohort | 否 | option | modes=cohort | cohort A 组标签（cohort 模式必填）。 |
217
+ | `--group-a-issues` | — | `N[,N...]` | 条件:cohort | 否 | option | modes=cohort | cohort A 组逗号分隔正整数 issue 列表（cohort 模式必填）。 |
218
+ | `--group-b-label` | — | `label` | 条件:cohort | 否 | option | modes=cohort | cohort B 组标签（cohort 模式必填）。 |
219
+ | `--group-b-issues` | — | `N[,N...]` | 条件:cohort | 否 | option | modes=cohort | cohort B 组逗号分隔正整数 issue 列表（cohort 模式必填）。 |
220
+ <!-- END GENERATED: public-cli-options -->