@h-rig/contracts 0.0.6-alpha.10 → 0.0.6-alpha.100
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/dist/index.cjs +5903 -0
- package/dist/index.mjs +5862 -0
- package/dist/src/artifact.d.ts +13 -0
- package/dist/src/artifact.js +3 -0
- package/dist/src/baseSchemas.d.ts +63 -0
- package/dist/src/baseSchemas.js +6 -0
- package/dist/src/cli-output.d.ts +324 -0
- package/dist/src/cli-output.js +190 -0
- package/dist/src/config.d.ts +371 -0
- package/dist/src/config.js +26 -3
- package/dist/src/conversation.d.ts +50 -0
- package/dist/src/conversation.js +3 -0
- package/dist/src/editor.d.ts +25 -0
- package/dist/src/editor.js +3 -0
- package/dist/src/engine.d.ts +2789 -0
- package/dist/src/engine.js +7 -2
- package/dist/src/git.d.ts +144 -0
- package/dist/src/git.js +3 -0
- package/dist/src/graph.d.ts +39 -0
- package/dist/src/graph.js +3 -0
- package/dist/src/help-catalog.d.ts +34 -0
- package/dist/src/help-catalog.js +405 -0
- package/dist/src/index.d.ts +37 -0
- package/dist/src/index.js +2534 -1219
- package/dist/src/ipc.d.ts +248 -0
- package/dist/src/keybindings.d.ts +71 -0
- package/dist/src/keybindings.js +3 -0
- package/dist/src/model.d.ts +77 -0
- package/dist/src/orchestration.d.ts +3695 -0
- package/dist/src/orchestration.js +3 -0
- package/dist/src/pi-session.d.ts +113 -0
- package/dist/src/pi-session.js +1 -0
- package/dist/src/plugin-hooks.d.ts +51 -0
- package/dist/src/plugin-hooks.js +112 -0
- package/dist/src/plugin.d.ts +230 -0
- package/dist/src/policy.d.ts +16 -0
- package/dist/src/policy.js +3 -0
- package/dist/src/project.d.ts +71 -0
- package/dist/src/project.js +3 -0
- package/dist/src/protocol-version.d.ts +21 -0
- package/dist/src/protocol-version.js +6 -0
- package/dist/src/provider.d.ts +105 -0
- package/dist/src/provider.js +3 -0
- package/dist/src/providerRuntime.d.ts +3949 -0
- package/dist/src/providerRuntime.js +3 -0
- package/dist/src/remote.d.ts +326 -0
- package/dist/src/remote.js +7 -2
- package/dist/src/review.d.ts +18 -0
- package/dist/src/review.js +3 -0
- package/dist/src/rig.d.ts +783 -0
- package/dist/src/rig.js +58 -4
- package/dist/src/run-journal.d.ts +763 -0
- package/dist/src/run-journal.js +1509 -0
- package/dist/src/run-session-journal.d.ts +53 -0
- package/dist/src/run-session-journal.js +1582 -0
- package/dist/src/run-status.d.ts +12 -0
- package/dist/src/run-status.js +38 -0
- package/dist/src/runtime.d.ts +103 -0
- package/dist/src/runtime.js +7 -2
- package/dist/src/server.d.ts +106 -0
- package/dist/src/server.js +3 -0
- package/dist/src/serviceFabric.d.ts +62 -0
- package/dist/src/serviceFabric.js +3 -0
- package/dist/src/task-source.d.ts +28 -0
- package/dist/src/terminal.d.ts +130 -0
- package/dist/src/terminal.js +3 -0
- package/dist/src/validation.d.ts +14 -0
- package/dist/src/validation.js +3 -0
- package/dist/src/workspace.d.ts +204 -0
- package/dist/src/workspace.js +3 -0
- package/dist/src/ws.d.ts +747 -0
- package/dist/src/ws.js +52 -3
- package/package.json +6 -3
|
@@ -0,0 +1,405 @@
|
|
|
1
|
+
// @bun
|
|
2
|
+
// packages/contracts/src/help-catalog.ts
|
|
3
|
+
function helpCatalog() {
|
|
4
|
+
return { sections: TOP_LEVEL_SECTIONS, groups: ALL_GROUPS };
|
|
5
|
+
}
|
|
6
|
+
var TOP_LEVEL_SECTIONS = [
|
|
7
|
+
{
|
|
8
|
+
title: "Open Rig",
|
|
9
|
+
subtitle: "the cockpit \u2014 bare rig opens the Rig Cockpit inside an OMP collab session",
|
|
10
|
+
commands: [
|
|
11
|
+
{ command: "rig", description: "Open the Rig Cockpit (OMP collaboration substrate) for the current workspace." },
|
|
12
|
+
{ command: "rig --workspace <path>", description: "Open the cockpit for another workspace instead of the current dir." },
|
|
13
|
+
{ command: "rig join <link>", description: "Join an encrypted OMP collaborative session from another operator." },
|
|
14
|
+
{ command: "/rig", description: "From inside an OMP session, (re)open the Rig Cockpit screen." },
|
|
15
|
+
{ command: "rig --version", description: "Print the installed Rig CLI version." }
|
|
16
|
+
]
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
title: "Runs \u2014 dispatch & control task runs",
|
|
20
|
+
subtitle: "every run is an isolated, collaborative OMP session on the selected target",
|
|
21
|
+
commands: [
|
|
22
|
+
{ command: "rig run start <task|#issue|--next>", description: "Dispatch a run for a task (refuses if one is already active; --force overrides)." },
|
|
23
|
+
{ command: "rig run start-parallel [--limit n]", description: "Dispatch all ready tasks concurrently up to the limit." },
|
|
24
|
+
{ command: "rig run start-serial", description: "Dispatch the next ready task; re-run to continue the serial queue." },
|
|
25
|
+
{ command: "rig run list", description: "List every discoverable run (live registry + local) with status and links." },
|
|
26
|
+
{ command: "rig run status", description: "Active vs recent runs at a glance." },
|
|
27
|
+
{ command: "rig run show <id>", description: "Run card: status, task, PR, join link, pending approvals/inputs, error summary." },
|
|
28
|
+
{ command: "rig run attach <id>", description: "Attach to a run's live OMP collab session (write access)." },
|
|
29
|
+
{ command: "rig run steer <id> --message <text>", description: "Send a steering message into a running session (remote routes to its host)." },
|
|
30
|
+
{ command: "rig run stop <id> [--reason <text>]", description: "Request a graceful stop of a run." },
|
|
31
|
+
{ command: "rig run resume|restart <id>", description: "Re-dispatch a task (detached runs start fresh)." },
|
|
32
|
+
{ command: "rig run timeline|replay <id>", description: "Inspect a run's folded timeline / replay its journal." },
|
|
33
|
+
{ command: "rig run cleanup", description: "Prune dead/stale run state." }
|
|
34
|
+
]
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
title: "Tasks \u2014 the configured task source",
|
|
38
|
+
subtitle: "github-issues / files task sources feed dispatch",
|
|
39
|
+
commands: [
|
|
40
|
+
{ command: "rig task list [--search <t>] [--status <s>]", description: "List tasks from the configured source, with filters." },
|
|
41
|
+
{ command: "rig task next", description: "Show the next ready task by dependency/priority." },
|
|
42
|
+
{ command: "rig task show|info <id>", description: "Task detail: title, body, status, labels, scope, deps, URL." },
|
|
43
|
+
{ command: "rig task scope|deps|status <id>", description: "Inspect a task's scope globs, dependencies, or lifecycle status." },
|
|
44
|
+
{ command: "rig task lookup <term>", description: "Find a task by id/title substring." },
|
|
45
|
+
{ command: "rig task record \u2026", description: "Write task state/metadata back to the source." },
|
|
46
|
+
{ command: "rig task artifacts <id>", description: "List/inspect a task's run artifacts." },
|
|
47
|
+
{ command: "rig triage", description: "Run the configured issueAnalysis pass once (schedule via cron/CI for continuous)." }
|
|
48
|
+
]
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
title: "Config \u2014 everything through rig.config.ts",
|
|
52
|
+
subtitle: "resolution: ambient env \u2192 rig.config.ts \u2192 computed default",
|
|
53
|
+
commands: [
|
|
54
|
+
{ command: "rig config get [<key>]", description: "Effective value(s) + which layer won (env / rig.config.ts / default)." },
|
|
55
|
+
{ command: "rig config set <key> <value>", description: "Write an override (relayUrl/registryUrl/registrySecret/sshTarget or any RIG_*) into rig.config.ts." },
|
|
56
|
+
{ command: "rig init", description: "Create rig.config.ts (project, task source, placement/sshTarget) interactively." },
|
|
57
|
+
{ command: "runtime.server in rig.config.ts", description: "Backbone (relay/registry/secret) + remote placement (sshTarget); defaults under the hood." }
|
|
58
|
+
]
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
title: "Placement & target \u2014 local vs remote execution",
|
|
62
|
+
subtitle: "where runs execute; the backbone relay/registry is shared",
|
|
63
|
+
commands: [
|
|
64
|
+
{ command: "rig server status", description: "Show the selected placement (local/remote) and project-root link." },
|
|
65
|
+
{ command: "rig server list", description: "List configured server targets." },
|
|
66
|
+
{ command: "rig server use <alias>", description: "Select a server target (execution placement)." },
|
|
67
|
+
{ command: "rig server add|remove <alias>", description: "Configure or remove a remote server target." },
|
|
68
|
+
{ command: "rig server repair-link", description: "Repair the project-root link for the selected target." },
|
|
69
|
+
{ command: "rig remote <list|add|test|status|\u2026>", description: "Lower-level remote endpoint management + run control over a remote." }
|
|
70
|
+
]
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
title: "Inbox & Doctor \u2014 approvals and health",
|
|
74
|
+
subtitle: "answer pending workflow entries; probe setup",
|
|
75
|
+
commands: [
|
|
76
|
+
{ command: "rig inbox approvals|inputs", description: "List pending approval / user-input workflow entries." },
|
|
77
|
+
{ command: "rig inbox approve <id> | respond <id> <text>", description: "Approve an entry or answer a user-input prompt." },
|
|
78
|
+
{ command: "rig inbox watch", description: "Stream inbox changes live." },
|
|
79
|
+
{ command: "rig doctor", description: "Cheap health checks: session discovery, registry, selected target, workflow entries." }
|
|
80
|
+
]
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
title: "Inspect & stats \u2014 observability",
|
|
84
|
+
subtitle: "logs, artifacts, diffs, failure analysis",
|
|
85
|
+
commands: [
|
|
86
|
+
{ command: "rig inspect run-logs|logs --run <id>", description: "Tail a run's process / session logs." },
|
|
87
|
+
{ command: "rig inspect runs", description: "List runs from on-disk runtime state." },
|
|
88
|
+
{ command: "rig inspect artifact(s) --task <id>", description: "Inspect a task/run's artifacts." },
|
|
89
|
+
{ command: "rig inspect diff|graph", description: "Run diff / task dependency graph." },
|
|
90
|
+
{ command: "rig inspect failures --task <id>", description: "Classified failure diagnostics for a task's runs." },
|
|
91
|
+
{ command: "rig stats", description: "Aggregate run stats over a window." }
|
|
92
|
+
]
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
title: "Setup & integrations",
|
|
96
|
+
subtitle: "initialize, authenticate, and wire the project",
|
|
97
|
+
commands: [
|
|
98
|
+
{ command: "rig init", description: "Set up a new repo: rig.config.ts, task source, placement, state." },
|
|
99
|
+
{ command: "rig setup", description: "Run/repair the full setup wizard (repo, placement, GitHub auth, labels, verify)." },
|
|
100
|
+
{ command: "rig github status|token|import-gh", description: "GitHub auth status, token management, issue import." },
|
|
101
|
+
{ command: "rig repo|git \u2026", description: "Repo/source helpers (clone, credentials, git ops)." },
|
|
102
|
+
{ command: "rig review", description: "Inspect or change the completion-review (Greptile) gate policy." }
|
|
103
|
+
]
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
title: "Extend & build",
|
|
107
|
+
subtitle: "plugins, OMP/Pi packages, binaries, workspaces",
|
|
108
|
+
commands: [
|
|
109
|
+
{ command: "rig plugin list|validate|run", description: "Inspect and exercise plugin-contributed channels." },
|
|
110
|
+
{ command: "rig pi list|add|remove|search", description: "Manage OMP/Pi extension packages for sessions/workers." },
|
|
111
|
+
{ command: "rig dist build|install", description: "Build/install the self-contained rig binary distribution." },
|
|
112
|
+
{ command: "rig workspace summary|topology", description: "Multi-root workspace inspection." },
|
|
113
|
+
{ command: "rig.config.ts plugins / runtime.pi.packages", description: "Declare task sources, validators, hooks, skills, roles + team OMP/Pi packages." }
|
|
114
|
+
]
|
|
115
|
+
}
|
|
116
|
+
];
|
|
117
|
+
var PRIMARY_GROUPS = [
|
|
118
|
+
{
|
|
119
|
+
name: "server",
|
|
120
|
+
summary: "Compatibility server selector; the product Server target screen lives in Rig Cockpit.",
|
|
121
|
+
usage: ["rig server <status|list|add|use|repair-link|start> [options]"],
|
|
122
|
+
commands: [
|
|
123
|
+
{ command: "status", description: "Legacy automation-only: show the selected server and project-root link.", primary: true },
|
|
124
|
+
{ command: "use local", description: "Legacy automation-only: switch this repo to local execution placement.", primary: true },
|
|
125
|
+
{ command: "add <alias> <url>", description: "Legacy automation-only: save a remote server URL.", primary: true },
|
|
126
|
+
{ command: "use <alias>", description: "Legacy automation-only: select a remote execution target alias.", primary: true },
|
|
127
|
+
{ command: "repair-link [--prepare|--backfill-only] [--repo owner/repo]", description: "Legacy automation-only: repair a server-host checkout link.", primary: true },
|
|
128
|
+
{ command: "list", description: "Legacy automation-only: list saved local/remote server aliases.", primary: true },
|
|
129
|
+
{ command: "start [--host <host>] [--port <n>]", description: "Legacy diagnostic-only: start a local rig-server process." }
|
|
130
|
+
],
|
|
131
|
+
examples: [
|
|
132
|
+
"rig server status # legacy automation only",
|
|
133
|
+
"rig server use local # legacy automation only"
|
|
134
|
+
],
|
|
135
|
+
next: ["For normal UX, run bare `rig`, open Cockpit Server, then continue to Tasks."]
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
name: "task",
|
|
139
|
+
summary: "Legacy automation-only task-source inspection and dispatch helpers.",
|
|
140
|
+
usage: ["rig task <list|next|show|run> [options]"],
|
|
141
|
+
commands: [
|
|
142
|
+
{ command: "list [--assignee <login|me|@me>] [--state open|closed]", description: "Legacy automation-only: list tasks from the configured source.", primary: true },
|
|
143
|
+
{ command: "next [filters]", description: "Legacy automation-only: render the next matching task card.", primary: true },
|
|
144
|
+
{ command: "show <id>|--task <id> [--raw]", description: "Legacy automation-only: show a task payload for scripts.", primary: true },
|
|
145
|
+
{ command: "run [#<issue>|<task-id>|--task <id>]", description: "Legacy/fenced: dispatch through the old task-run CLI path; not the task-detail dispatch path.", primary: true },
|
|
146
|
+
{ command: "ready", description: "Legacy automation-only: list task IDs that old dispatch can run now." },
|
|
147
|
+
{ command: "validate|verify [--task <id>]", description: "Legacy automation-only: run configured task checks/review gates." },
|
|
148
|
+
{ command: "details --task <id>", description: "Legacy automation-only: show full task info from the configured source." },
|
|
149
|
+
{ command: "reopen [--task <id> | --all] [--reason <text>]", description: "Legacy automation-only: reopen closed task(s) in the configured source." },
|
|
150
|
+
{ command: "artifacts|artifact-dir|artifact-write", description: "Legacy automation-only: inspect or write task artifacts." }
|
|
151
|
+
],
|
|
152
|
+
examples: [
|
|
153
|
+
"rig task list --assignee @me --limit 20 # legacy automation only",
|
|
154
|
+
"rig task show 123 --raw # legacy automation only",
|
|
155
|
+
"rig task run #123 --runtime-adapter pi # explicit legacy dispatch only"
|
|
156
|
+
],
|
|
157
|
+
next: ["For normal UX, run bare `rig`, use Cockpit Server/Tasks, then dispatch from Task detail."]
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
name: "run",
|
|
161
|
+
summary: "Legacy automation-only run-record inspection; OMP Runs/collab is the live surface.",
|
|
162
|
+
usage: ["rig run <list|status|show|steer|stop|resume|restart> [options]"],
|
|
163
|
+
commands: [
|
|
164
|
+
{ command: "list", description: "Legacy automation-only: list old run records from selected server/local state.", primary: true },
|
|
165
|
+
{ command: "status", description: "Legacy automation-only: render old active/recent run-record groups; not live OMP status.", primary: true },
|
|
166
|
+
{ command: "show <id>|--run <id> [--raw]", description: "Legacy automation-only: show an old run-record payload for scripts.", primary: true },
|
|
167
|
+
{ command: "attach <run-id>|--run <id>", description: "Legacy/fenced: not the Rig Cockpit attach path; use OMP Runs or `rig join <link>`.", primary: true },
|
|
168
|
+
{ command: "steer <run-id> --message <text>", description: "Legacy automation-only: queue steering into an old live worker.", primary: true },
|
|
169
|
+
{ command: "stop [<run-id>|--run <id>]", description: "Legacy automation-only: request stop for old run records.", primary: true },
|
|
170
|
+
{ command: "resume [<run-id>]", description: "Legacy automation-only: resume an interrupted old run record." },
|
|
171
|
+
{ command: "restart [<run-id>]", description: "Legacy automation-only: re-dispatch an old run from a clean runtime." },
|
|
172
|
+
{ command: "timeline --run <id> [--follow]", description: "Legacy automation-only: stream raw old timeline events." },
|
|
173
|
+
{ command: "replay <run-id>|--run <id> [--with-session]", description: "Legacy automation-only: print an old consolidated run timeline." },
|
|
174
|
+
{ command: "delete|cleanup", description: "Legacy automation-only: remove completed old run records/artifacts." }
|
|
175
|
+
],
|
|
176
|
+
examples: [
|
|
177
|
+
"rig run list # legacy automation only",
|
|
178
|
+
"rig run show <run-id> # legacy automation only",
|
|
179
|
+
"rig run stop <run-id> # legacy automation only"
|
|
180
|
+
],
|
|
181
|
+
next: [
|
|
182
|
+
"For live sessions, use bare `rig`, the OMP Runs screen, or `rig join <collab-link>`.",
|
|
183
|
+
"Use `--json` only for scripts that still consume legacy compatibility records."
|
|
184
|
+
]
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
name: "inbox",
|
|
188
|
+
summary: "Legacy automation-only request view; normal UX is the OMP Inbox screen.",
|
|
189
|
+
usage: ["rig inbox <approvals|approve|inputs|respond> [options]"],
|
|
190
|
+
commands: [
|
|
191
|
+
{ command: "approvals [--run <id>] [--task <id>]", description: "Legacy automation-only: list pending approval records.", primary: true },
|
|
192
|
+
{ command: "inputs [--run <id>] [--task <id>]", description: "Legacy automation-only: list pending user-input records.", primary: true },
|
|
193
|
+
{ command: "approve --run <id> --request <id> --decision approve|reject", description: "Legacy automation-only: resolve an approval record." },
|
|
194
|
+
{ command: "respond --run <id> --request <id> --answer key=value", description: "Legacy automation-only: answer a user-input record." }
|
|
195
|
+
],
|
|
196
|
+
examples: [
|
|
197
|
+
"rig inbox approvals # legacy automation only"
|
|
198
|
+
],
|
|
199
|
+
next: ["For normal UX, use bare `rig`, then the OMP Inbox screen."]
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
name: "stats",
|
|
203
|
+
summary: "Legacy automation-only metrics over old run records; not the OMP live UX.",
|
|
204
|
+
usage: ["rig stats [show] [--since <7d|30d|ISO date>]"],
|
|
205
|
+
commands: [
|
|
206
|
+
{ command: "show [--since <window>]", description: "Legacy automation-only: totals, completion/failure rates, run time, steering, stalls, approvals.", primary: true }
|
|
207
|
+
],
|
|
208
|
+
examples: [
|
|
209
|
+
"rig stats --json # legacy automation only"
|
|
210
|
+
],
|
|
211
|
+
next: ["For normal UX, use the OMP Runs screen."]
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
name: "inspect",
|
|
215
|
+
summary: "Legacy automation-only artifact/log inspection; normal UX is OMP session history.",
|
|
216
|
+
usage: ["rig inspect <logs|artifacts|failures|graph|audit> --task <id>"],
|
|
217
|
+
commands: [
|
|
218
|
+
{ command: "logs --task <id>", description: "Legacy automation-only: latest old run log for a task.", primary: true },
|
|
219
|
+
{ command: "artifacts --task <id>", description: "Legacy automation-only: list completion artifacts.", primary: true },
|
|
220
|
+
{ command: "failures --task <id>", description: "Legacy automation-only: recorded failures for a task.", primary: true },
|
|
221
|
+
{ command: "graph", description: "Legacy automation-only: task dependency graph." },
|
|
222
|
+
{ command: "audit", description: "Legacy automation-only: controlled-command audit trail." }
|
|
223
|
+
],
|
|
224
|
+
examples: ["rig inspect logs --task <id> # legacy automation only"],
|
|
225
|
+
next: ["For normal UX, use the OMP Runs screen and OMP session history."]
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
name: "repo",
|
|
229
|
+
summary: "Repository sync/baseline helpers for the Rig-managed checkout.",
|
|
230
|
+
usage: ["rig repo <sync|reset-baseline>"],
|
|
231
|
+
commands: [
|
|
232
|
+
{ command: "sync", description: "Sync project repository state.", primary: true },
|
|
233
|
+
{ command: "reset-baseline", description: "Reset the managed baseline for the repo." }
|
|
234
|
+
],
|
|
235
|
+
examples: ["rig repo sync"]
|
|
236
|
+
},
|
|
237
|
+
{
|
|
238
|
+
name: "plugin",
|
|
239
|
+
summary: "Plugin listing, validation, and plugin-contributed commands.",
|
|
240
|
+
usage: ["rig plugin <list|validate|run> [options]"],
|
|
241
|
+
commands: [
|
|
242
|
+
{ command: "list", description: "List plugins declared in rig.config.ts and their contributions.", primary: true },
|
|
243
|
+
{ command: "validate --task <id>", description: "Run plugin-contributed validators for a task.", primary: true },
|
|
244
|
+
{ command: "run <command-id> [args...]", description: "Execute a plugin-contributed CLI command (also callable as `rig <command-id>`)." }
|
|
245
|
+
],
|
|
246
|
+
examples: ["rig plugin list", "rig plugin run <command-id>"]
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
name: "init",
|
|
250
|
+
summary: "Legacy automation-only config bootstrap/repair helper; not root onboarding.",
|
|
251
|
+
usage: ["rig init [--yes] [--server local|remote] [--repo owner/repo] [--remote-url <url>]"],
|
|
252
|
+
commands: [
|
|
253
|
+
{ command: "init", description: "Legacy/fenced setup wizard for compatibility projects; not onboarding.", primary: true },
|
|
254
|
+
{ command: "init --demo", description: "Legacy/fenced offline demo project for compatibility tests.", primary: true },
|
|
255
|
+
{ command: "init --yes", description: "Legacy/fenced non-interactive setup for old automation.", primary: true },
|
|
256
|
+
{ command: "init --server remote --remote-url <url>", description: "Legacy/fenced remote server link setup.", primary: true },
|
|
257
|
+
{ command: "init --repair", description: "Legacy/fenced repair of missing private compatibility state." }
|
|
258
|
+
],
|
|
259
|
+
examples: [
|
|
260
|
+
"rig init --demo # legacy compatibility only",
|
|
261
|
+
"rig init --repair # legacy compatibility only"
|
|
262
|
+
],
|
|
263
|
+
next: ["For onboarding and normal UX, run bare `rig`, then use Cockpit Server/Tasks and dispatch from Task detail."]
|
|
264
|
+
},
|
|
265
|
+
{
|
|
266
|
+
name: "doctor",
|
|
267
|
+
summary: "Diagnostic-only compatibility checks; normal health lives in the OMP Doctor screen.",
|
|
268
|
+
usage: ["rig doctor"],
|
|
269
|
+
commands: [
|
|
270
|
+
{ command: "doctor", description: "Diagnostic/legacy-only: check compatibility setup/runtime state; not onboarding.", primary: true },
|
|
271
|
+
{ command: "check", description: "Diagnostic/legacy-only spelling for compatibility checks." }
|
|
272
|
+
],
|
|
273
|
+
examples: ["rig doctor --json # legacy diagnostic automation only"],
|
|
274
|
+
next: ["For normal UX, use the OMP Doctor screen."]
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
name: "github",
|
|
278
|
+
summary: "Legacy automation-only GitHub auth helpers for selected compatibility servers.",
|
|
279
|
+
usage: ["rig github auth <status|import-gh|token>"],
|
|
280
|
+
commands: [
|
|
281
|
+
{ command: "auth status", description: "Legacy automation-only: show GitHub auth state.", primary: true },
|
|
282
|
+
{ command: "auth import-gh", description: "Legacy automation-only: import the current `gh` token into the selected server." },
|
|
283
|
+
{ command: "auth token --token <token>", description: "Legacy automation-only: store a token on the selected server." }
|
|
284
|
+
],
|
|
285
|
+
examples: ["rig github auth status # legacy automation only"],
|
|
286
|
+
next: ["For normal UX, use bare `rig` and the OMP extension cockpit."]
|
|
287
|
+
}
|
|
288
|
+
];
|
|
289
|
+
var ADVANCED_GROUPS = [
|
|
290
|
+
{
|
|
291
|
+
name: "setup",
|
|
292
|
+
summary: "Legacy automation-only setup bootstrap/check helpers.",
|
|
293
|
+
usage: ["rig setup <bootstrap|check|preflight>"],
|
|
294
|
+
commands: [
|
|
295
|
+
{ command: "bootstrap", description: "Legacy automation-only: bootstrap local setup dependencies.", primary: true },
|
|
296
|
+
{ command: "check", description: "Legacy automation-only: check local setup state (toolchain, deps, config).", primary: true },
|
|
297
|
+
{ command: "preflight", description: "Legacy automation-only: run preflight checks before an old run.", primary: true }
|
|
298
|
+
]
|
|
299
|
+
},
|
|
300
|
+
{
|
|
301
|
+
name: "profile",
|
|
302
|
+
summary: "Runtime profile/model defaults.",
|
|
303
|
+
usage: ["rig profile <show|set>"],
|
|
304
|
+
commands: [
|
|
305
|
+
{ command: "show", description: "Show the active execution profile.", primary: true },
|
|
306
|
+
{ command: "set [--model <model>] [--runtime <runtime>] [--plugin <plugin>]", description: "Set model/runtime/plugin profile defaults.", primary: true }
|
|
307
|
+
]
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
name: "review",
|
|
311
|
+
summary: "Inspect or change completion review gate policy.",
|
|
312
|
+
usage: ["rig review <show|set>"],
|
|
313
|
+
commands: [
|
|
314
|
+
{ command: "show", description: "Show current review gate settings." },
|
|
315
|
+
{ command: "set <off|advisory|required> [--provider <provider>]", description: "Change review strictness/provider (e.g. --provider greptile)." }
|
|
316
|
+
],
|
|
317
|
+
examples: ["rig review show", "rig review set required --provider greptile"],
|
|
318
|
+
next: ["For normal workflow handoffs, use the OMP Inbox screen."]
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
name: "pi",
|
|
322
|
+
summary: "Manage Pi extension packages for this project (community extensions from npm/git).",
|
|
323
|
+
usage: ["rig pi <list|add|remove|search> [args]"],
|
|
324
|
+
commands: [
|
|
325
|
+
{ command: "list", description: "Show project and user Pi extension packages." },
|
|
326
|
+
{ command: "add <source>", description: "Add an npm/git Pi extension to .pi/settings.json (auto-installs at next session)." },
|
|
327
|
+
{ command: "remove <source>", description: "Remove an operator-added Pi extension." },
|
|
328
|
+
{ command: "search [term]", description: "Discover Pi extension packages on the npm registry." }
|
|
329
|
+
],
|
|
330
|
+
examples: ["rig pi search subagents", "rig pi add pi-subagents", "rig pi list"],
|
|
331
|
+
next: ["Config-managed extensions: declare `runtime: { pi: { packages: [...] } }` in rig.config.ts \u2014 workers pick them up automatically."]
|
|
332
|
+
},
|
|
333
|
+
{
|
|
334
|
+
name: "queue",
|
|
335
|
+
summary: "Run task queues locally.",
|
|
336
|
+
usage: ["rig queue run [--workers <n>] [--max-tasks <n>] [--action validate|verify|pipeline] [--isolation off|worktree] [--no-runtime-reuse] [--fail-fast] [--skip-project-sync]"],
|
|
337
|
+
commands: [
|
|
338
|
+
{ command: "run [--workers <n>] [--max-tasks <n>] [--action validate|verify|pipeline] [--isolation off|worktree] [--no-runtime-reuse] [--fail-fast] [--skip-project-sync]", description: "Process queue work: drain matching tasks with N workers, optional per-task action and isolation.", primary: true }
|
|
339
|
+
]
|
|
340
|
+
},
|
|
341
|
+
{
|
|
342
|
+
name: "agent",
|
|
343
|
+
summary: "Runtime agent workspace helpers.",
|
|
344
|
+
usage: ["rig agent <list|prepare|run|cleanup>"],
|
|
345
|
+
commands: [
|
|
346
|
+
{ command: "list", description: "List prepared agent runtimes.", primary: true },
|
|
347
|
+
{ command: "prepare [--id <id>] [--mode <mode>] [--task <task>]", description: "Prepare an isolated agent runtime workspace.", primary: true },
|
|
348
|
+
{ command: "run [--id <id>] [--mode <mode>] [--task <task>] [--skip-project-sync]", description: "Prepare (if needed) and run an agent in its workspace.", primary: true },
|
|
349
|
+
{ command: "cleanup [--all] [--id <id>]", description: "Remove prepared agent workspaces.", primary: true }
|
|
350
|
+
]
|
|
351
|
+
},
|
|
352
|
+
{ name: "inspector", summary: "Event stream and drift scanners.", usage: ["rig inspector <stream|scan-upstream-drift>"], commands: [{ command: "stream", description: "Stream events." }] },
|
|
353
|
+
{
|
|
354
|
+
name: "dist",
|
|
355
|
+
summary: "Build/install packaged Rig CLI.",
|
|
356
|
+
usage: ["rig dist <build|install|doctor|rebuild-agent>"],
|
|
357
|
+
commands: [
|
|
358
|
+
{ command: "build [--output-dir <dir>]", description: "Build the distributable Rig CLI.", primary: true },
|
|
359
|
+
{ command: "install [--scope <scope>] [--path <path>]", description: "Install the built CLI to a scope/path.", primary: true },
|
|
360
|
+
{ command: "doctor", description: "Diagnose the dist toolchain and install state.", primary: true },
|
|
361
|
+
{ command: "rebuild-agent", description: "Rebuild the agent runtime image, pruning stale images.", primary: true }
|
|
362
|
+
]
|
|
363
|
+
},
|
|
364
|
+
{ name: "workspace", summary: "Workspace topology/service helpers.", usage: ["rig workspace <summary|topology|remote-hosts>"], commands: [{ command: "summary", description: "Show workspace summary." }] },
|
|
365
|
+
{
|
|
366
|
+
name: "remote",
|
|
367
|
+
summary: "Legacy automation-only remote orchestration controls.",
|
|
368
|
+
usage: ["rig remote <status|tasks|watch|pause|resume|continue|stop|refresh|add-iterations|remove-iterations|endpoint ...>"],
|
|
369
|
+
commands: [
|
|
370
|
+
{ command: "status [--remote <alias>]", description: "Legacy automation-only: show old remote orchestration state.", primary: true },
|
|
371
|
+
{ command: "tasks [--remote <alias>]", description: "Legacy automation-only: list the old remote's tracked tasks.", primary: true },
|
|
372
|
+
{ command: "watch [--remote <alias>] [--seconds <n>] [--event <type>]", description: "Legacy automation-only: stream old remote orchestration events.", primary: true },
|
|
373
|
+
{ command: "pause [--remote <alias>]", description: "Legacy automation-only: pause old remote orchestration.", primary: true },
|
|
374
|
+
{ command: "resume [--remote <alias>] [--max-workers <n>] [--max-iterations <n>] [--direct-merge]", description: "Legacy automation-only: resume old remote orchestration with optional tuning.", primary: true },
|
|
375
|
+
{ command: "continue [--remote <alias>]", description: "Legacy automation-only: continue a paused old remote.", primary: true },
|
|
376
|
+
{ command: "stop [--remote <alias>]", description: "Legacy automation-only: stop old remote orchestration.", primary: true },
|
|
377
|
+
{ command: "refresh [--remote <alias>]", description: "Legacy automation-only: refresh old remote state.", primary: true },
|
|
378
|
+
{ command: "add-iterations [--count <n>] [--remote <alias>]", description: "Legacy automation-only: grant an old remote more iterations.", primary: true },
|
|
379
|
+
{ command: "remove-iterations [--count <n>] [--remote <alias>]", description: "Legacy automation-only: reduce an old remote's iteration budget.", primary: true },
|
|
380
|
+
{ command: "endpoint list", description: "Legacy automation-only: list configured remote endpoints.", primary: true },
|
|
381
|
+
{ command: "endpoint add --alias <alias> --host <host> --port <n> [--token <token>]", description: "Legacy automation-only: register a remote endpoint.", primary: true },
|
|
382
|
+
{ command: "endpoint remove --alias <alias>", description: "Legacy automation-only: remove a remote endpoint.", primary: true },
|
|
383
|
+
{ command: "endpoint test [--alias <alias>]", description: "Legacy diagnostic-only: test connectivity to a remote endpoint.", primary: true },
|
|
384
|
+
{ command: "endpoint doctor", description: "Legacy diagnostic-only: diagnose remote endpoint configuration.", primary: true }
|
|
385
|
+
]
|
|
386
|
+
},
|
|
387
|
+
{ name: "git", summary: "Pass through to Rig git-flow helper.", usage: ["rig git <args...>"], commands: [{ command: "<args...>", description: "Advanced git flow operations." }] },
|
|
388
|
+
{ name: "harness", summary: "Pass through to runtime harness CLI.", usage: ["rig harness <args...>"], commands: [{ command: "<args...>", description: "Advanced harness operations." }] },
|
|
389
|
+
{ name: "test", summary: "Project test wrappers.", usage: ["rig test <unit|e2e|all>"], commands: [{ command: "all", description: "Run configured project tests." }] }
|
|
390
|
+
];
|
|
391
|
+
var ADVANCED_COMMANDS = [
|
|
392
|
+
{ command: "rig server task-run ...", description: "Internal legacy server-owned task execution entry point." },
|
|
393
|
+
{ command: "rig server notify-test [--event <type>]", description: "Internal diagnostic event notification smoke command." },
|
|
394
|
+
{ command: "rig run start|start-serial|start-parallel", description: "Legacy/internal queue starters; not the Rig Cockpit task-detail dispatch path." },
|
|
395
|
+
{ command: "rig remote orchestrate-*", description: "Legacy automation-only remote orchestration commands." }
|
|
396
|
+
];
|
|
397
|
+
var ALL_GROUPS = [...PRIMARY_GROUPS, ...ADVANCED_GROUPS];
|
|
398
|
+
export {
|
|
399
|
+
helpCatalog,
|
|
400
|
+
TOP_LEVEL_SECTIONS,
|
|
401
|
+
PRIMARY_GROUPS,
|
|
402
|
+
ALL_GROUPS,
|
|
403
|
+
ADVANCED_GROUPS,
|
|
404
|
+
ADVANCED_COMMANDS
|
|
405
|
+
};
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
export { Schema } from "effect";
|
|
2
|
+
export * from "./baseSchemas";
|
|
3
|
+
export * from "./workspace";
|
|
4
|
+
export * from "./graph";
|
|
5
|
+
export * from "./runtime";
|
|
6
|
+
export * from "./run-journal";
|
|
7
|
+
export * from "./run-session-journal";
|
|
8
|
+
export * from "./run-status";
|
|
9
|
+
export * from "./conversation";
|
|
10
|
+
export * from "./plugin";
|
|
11
|
+
export * from "./plugin-hooks";
|
|
12
|
+
export * from "./config";
|
|
13
|
+
export * from "./policy";
|
|
14
|
+
export * from "./validation";
|
|
15
|
+
export * from "./review";
|
|
16
|
+
export * from "./artifact";
|
|
17
|
+
export * from "./engine";
|
|
18
|
+
export * from "./rig";
|
|
19
|
+
export * from "./remote";
|
|
20
|
+
export * from "./ipc";
|
|
21
|
+
export * from "./terminal";
|
|
22
|
+
export * from "./provider";
|
|
23
|
+
export * from "./providerRuntime";
|
|
24
|
+
export * from "./model";
|
|
25
|
+
export * from "./ws";
|
|
26
|
+
export * from "./keybindings";
|
|
27
|
+
export * from "./server";
|
|
28
|
+
export * from "./serviceFabric";
|
|
29
|
+
export * from "./git";
|
|
30
|
+
export * from "./orchestration";
|
|
31
|
+
export * from "./editor";
|
|
32
|
+
export * from "./project";
|
|
33
|
+
export * from "./task-source";
|
|
34
|
+
export * from "./cli-output";
|
|
35
|
+
export * from "./pi-session";
|
|
36
|
+
export * from "./protocol-version";
|
|
37
|
+
export * from "./help-catalog";
|