@h-rig/contracts 0.0.6-alpha.90 → 0.0.6-alpha.91

package/dist/src/help-catalog.js

@@ -0,0 +1,351 @@
+// @bun
+// packages/contracts/src/help-catalog.ts
+function helpCatalog() {
+  return { sections: TOP_LEVEL_SECTIONS, groups: ALL_GROUPS };
+}
+var TOP_LEVEL_SECTIONS = [
+  {
+    title: "Open Rig",
+    subtitle: "normal UX \u2014 bare rig opens the bundled Rig Cockpit inside OMP",
+    commands: [
+      { command: "rig", description: "Open Rig Cockpit with OMP collaboration substrate for the current workspace." },
+      { command: "rig --workspace <path>", description: "Open Rig Cockpit for another workspace." },
+      { command: "/rig", description: "Inside OMP, reopen the Rig Cockpit." },
+      { command: "rig join <link>", description: "Join an encrypted OMP collaborative session from another operator." }
+    ]
+  },
+  {
+    title: "Server",
+    subtitle: "select execution placement before reading or dispatching work",
+    commands: [
+      { command: "Cockpit Server", description: "Show the selected local or remote server target and project-root link." },
+      { command: "Server target \u2192 Local", description: "Use local execution placement for the selected project." },
+      { command: "Server target \u2192 Remote", description: "Use remote execution placement with the server-host project root preserved." }
+    ]
+  },
+  {
+    title: "Tasks",
+    subtitle: "configured task source on the selected target feeds task detail",
+    commands: [
+      { command: "Cockpit Tasks", description: "List tasks from the selected server target's configured task source." },
+      { command: "Task detail", description: "Review task id, title, body, source status, labels, and issue URL before dispatch." },
+      { command: "Task detail \u2192 Dispatch", description: "Submit the selected task run through the selected target, then attach the collaborative OMP session." },
+      { command: "rig triage", description: "Run the configured issueAnalysis pass once; use cron/launchd/CI to schedule continuous triage." }
+    ]
+  },
+  {
+    title: "Runs",
+    subtitle: "dispatched Rig runs attach through collaborative OMP sessions",
+    commands: [
+      { command: "OMP Runs screen", description: "Open dispatched runs, collaboration links, cwd, identity, status, and inbox counts." },
+      { command: "rig join <link>", description: "Join a shared OMP session without changing execution placement." },
+      { command: "OMP collab guest view", description: "Watch the shared transcript live; write links can prompt the originating session." }
+    ]
+  },
+  {
+    title: "Inbox + Doctor",
+    subtitle: "approvals, user prompts, and health checks live inside Rig/OMP",
+    commands: [
+      { command: "OMP Inbox screen", description: "Review and answer pending approval/user-input workflow entries." },
+      { command: "/rig inbox", description: "Open the inbox screen from inside OMP." },
+      { command: "OMP Doctor screen", description: "Probe session discovery, collaboration registry, selected target, and workflow-entry health." }
+    ]
+  },
+  {
+    title: "Extend",
+    subtitle: "plugins and OMP extensions shape the worker environment",
+    commands: [
+      { command: "rig.config.ts plugins", description: "Register task sources, validators, hooks, skills, roles, and workflow metadata." },
+      { command: "runtime.pi.packages", description: "Declare team-wide OMP/Pi extension packages for sessions and workers." }
+    ]
+  }
+];
+var PRIMARY_GROUPS = [
+  {
+    name: "server",
+    summary: "Compatibility server selector; the product Server target screen lives in Rig Cockpit.",
+    usage: ["rig server <status|list|add|use|repair-link|start> [options]"],
+    commands: [
+      { command: "status", description: "Legacy automation-only: show the selected server and project-root link.", primary: true },
+      { command: "use local", description: "Legacy automation-only: switch this repo to local execution placement.", primary: true },
+      { command: "add <alias> <url>", description: "Legacy automation-only: save a remote server URL.", primary: true },
+      { command: "use <alias>", description: "Legacy automation-only: select a remote execution target alias.", primary: true },
+      { command: "repair-link [--prepare|--backfill-only] [--repo owner/repo]", description: "Legacy automation-only: repair a server-host checkout link.", primary: true },
+      { command: "list", description: "Legacy automation-only: list saved local/remote server aliases.", primary: true },
+      { command: "start [--host <host>] [--port <n>]", description: "Legacy diagnostic-only: start a local rig-server process." }
+    ],
+    examples: [
+      "rig server status        # legacy automation only",
+      "rig server use local     # legacy automation only"
+    ],
+    next: ["For normal UX, run bare `rig`, open Cockpit Server, then continue to Tasks."]
+  },
+  {
+    name: "task",
+    summary: "Legacy automation-only task-source inspection and dispatch helpers.",
+    usage: ["rig task <list|next|show|run> [options]"],
+    commands: [
+      { command: "list [--assignee <login|me|@me>] [--state open|closed]", description: "Legacy automation-only: list tasks from the configured source.", primary: true },
+      { command: "next [filters]", description: "Legacy automation-only: render the next matching task card.", primary: true },
+      { command: "show <id>|--task <id> [--raw]", description: "Legacy automation-only: show a task payload for scripts.", primary: true },
+      { 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 },
+      { command: "ready", description: "Legacy automation-only: list task IDs that old dispatch can run now." },
+      { command: "validate|verify [--task <id>]", description: "Legacy automation-only: run configured task checks/review gates." },
+      { command: "details --task <id>", description: "Legacy automation-only: show full task info from the configured source." },
+      { command: "reopen [--task <id> | --all] [--reason <text>]", description: "Legacy automation-only: reopen closed task(s) in the configured source." },
+      { command: "artifacts|artifact-dir|artifact-write", description: "Legacy automation-only: inspect or write task artifacts." }
+    ],
+    examples: [
+      "rig task list --assignee @me --limit 20   # legacy automation only",
+      "rig task show 123 --raw                   # legacy automation only",
+      "rig task run #123 --runtime-adapter pi    # explicit legacy dispatch only"
+    ],
+    next: ["For normal UX, run bare `rig`, use Cockpit Server/Tasks, then dispatch from Task detail."]
+  },
+  {
+    name: "run",
+    summary: "Legacy automation-only run-record inspection; OMP Runs/collab is the live surface.",
+    usage: ["rig run <list|status|show|steer|stop|resume|restart> [options]"],
+    commands: [
+      { command: "list", description: "Legacy automation-only: list old run records from selected server/local state.", primary: true },
+      { command: "status", description: "Legacy automation-only: render old active/recent run-record groups; not live OMP status.", primary: true },
+      { command: "show <id>|--run <id> [--raw]", description: "Legacy automation-only: show an old run-record payload for scripts.", primary: true },
+      { command: "attach <run-id>|--run <id>", description: "Legacy/fenced: not the Rig Cockpit attach path; use OMP Runs or `rig join <link>`.", primary: true },
+      { command: "steer <run-id> --message <text>", description: "Legacy automation-only: queue steering into an old live worker.", primary: true },
+      { command: "stop [<run-id>|--run <id>]", description: "Legacy automation-only: request stop for old run records.", primary: true },
+      { command: "resume [<run-id>]", description: "Legacy automation-only: resume an interrupted old run record." },
+      { command: "restart [<run-id>]", description: "Legacy automation-only: re-dispatch an old run from a clean runtime." },
+      { command: "timeline --run <id> [--follow]", description: "Legacy automation-only: stream raw old timeline events." },
+      { command: "replay <run-id>|--run <id> [--with-session]", description: "Legacy automation-only: print an old consolidated run timeline." },
+      { command: "delete|cleanup", description: "Legacy automation-only: remove completed old run records/artifacts." }
+    ],
+    examples: [
+      "rig run list          # legacy automation only",
+      "rig run show <run-id> # legacy automation only",
+      "rig run stop <run-id> # legacy automation only"
+    ],
+    next: [
+      "For live sessions, use bare `rig`, the OMP Runs screen, or `rig join <collab-link>`.",
+      "Use `--json` only for scripts that still consume legacy compatibility records."
+    ]
+  },
+  {
+    name: "inbox",
+    summary: "Legacy automation-only request view; normal UX is the OMP Inbox screen.",
+    usage: ["rig inbox <approvals|approve|inputs|respond> [options]"],
+    commands: [
+      { command: "approvals [--run <id>] [--task <id>]", description: "Legacy automation-only: list pending approval records.", primary: true },
+      { command: "inputs [--run <id>] [--task <id>]", description: "Legacy automation-only: list pending user-input records.", primary: true },
+      { command: "approve --run <id> --request <id> --decision approve|reject", description: "Legacy automation-only: resolve an approval record." },
+      { command: "respond --run <id> --request <id> --answer key=value", description: "Legacy automation-only: answer a user-input record." }
+    ],
+    examples: [
+      "rig inbox approvals # legacy automation only"
+    ],
+    next: ["For normal UX, use bare `rig`, then the OMP Inbox screen."]
+  },
+  {
+    name: "stats",
+    summary: "Legacy automation-only metrics over old run records; not the OMP live UX.",
+    usage: ["rig stats [show] [--since <7d|30d|ISO date>]"],
+    commands: [
+      { command: "show [--since <window>]", description: "Legacy automation-only: totals, completion/failure rates, run time, steering, stalls, approvals.", primary: true }
+    ],
+    examples: [
+      "rig stats --json # legacy automation only"
+    ],
+    next: ["For normal UX, use the OMP Runs screen."]
+  },
+  {
+    name: "inspect",
+    summary: "Legacy automation-only artifact/log inspection; normal UX is OMP session history.",
+    usage: ["rig inspect <logs|artifacts|failures|graph|audit> --task <id>"],
+    commands: [
+      { command: "logs --task <id>", description: "Legacy automation-only: latest old run log for a task.", primary: true },
+      { command: "artifacts --task <id>", description: "Legacy automation-only: list completion artifacts.", primary: true },
+      { command: "failures --task <id>", description: "Legacy automation-only: recorded failures for a task.", primary: true },
+      { command: "graph", description: "Legacy automation-only: task dependency graph." },
+      { command: "audit", description: "Legacy automation-only: controlled-command audit trail." }
+    ],
+    examples: ["rig inspect logs --task <id> # legacy automation only"],
+    next: ["For normal UX, use the OMP Runs screen and OMP session history."]
+  },
+  {
+    name: "repo",
+    summary: "Repository sync/baseline helpers for the Rig-managed checkout.",
+    usage: ["rig repo <sync|reset-baseline>"],
+    commands: [
+      { command: "sync", description: "Sync project repository state.", primary: true },
+      { command: "reset-baseline", description: "Reset the managed baseline for the repo." }
+    ],
+    examples: ["rig repo sync"]
+  },
+  {
+    name: "plugin",
+    summary: "Plugin listing, validation, and plugin-contributed commands.",
+    usage: ["rig plugin <list|validate|run> [options]"],
+    commands: [
+      { command: "list", description: "List plugins declared in rig.config.ts and their contributions.", primary: true },
+      { command: "validate --task <id>", description: "Run plugin-contributed validators for a task.", primary: true },
+      { command: "run <command-id> [args...]", description: "Execute a plugin-contributed CLI command (also callable as `rig <command-id>`)." }
+    ],
+    examples: ["rig plugin list", "rig plugin run <command-id>"]
+  },
+  {
+    name: "init",
+    summary: "Legacy automation-only config bootstrap/repair helper; not root onboarding.",
+    usage: ["rig init [--yes] [--server local|remote] [--repo owner/repo] [--remote-url <url>]"],
+    commands: [
+      { command: "init", description: "Legacy/fenced setup wizard for compatibility projects; not onboarding.", primary: true },
+      { command: "init --demo", description: "Legacy/fenced offline demo project for compatibility tests.", primary: true },
+      { command: "init --yes", description: "Legacy/fenced non-interactive setup for old automation.", primary: true },
+      { command: "init --server remote --remote-url <url>", description: "Legacy/fenced remote server link setup.", primary: true },
+      { command: "init --repair", description: "Legacy/fenced repair of missing private compatibility state." }
+    ],
+    examples: [
+      "rig init --demo   # legacy compatibility only",
+      "rig init --repair # legacy compatibility only"
+    ],
+    next: ["For onboarding and normal UX, run bare `rig`, then use Cockpit Server/Tasks and dispatch from Task detail."]
+  },
+  {
+    name: "doctor",
+    summary: "Diagnostic-only compatibility checks; normal health lives in the OMP Doctor screen.",
+    usage: ["rig doctor"],
+    commands: [
+      { command: "doctor", description: "Diagnostic/legacy-only: check compatibility setup/runtime state; not onboarding.", primary: true },
+      { command: "check", description: "Diagnostic/legacy-only spelling for compatibility checks." }
+    ],
+    examples: ["rig doctor --json # legacy diagnostic automation only"],
+    next: ["For normal UX, use the OMP Doctor screen."]
+  },
+  {
+    name: "github",
+    summary: "Legacy automation-only GitHub auth helpers for selected compatibility servers.",
+    usage: ["rig github auth <status|import-gh|token>"],
+    commands: [
+      { command: "auth status", description: "Legacy automation-only: show GitHub auth state.", primary: true },
+      { command: "auth import-gh", description: "Legacy automation-only: import the current `gh` token into the selected server." },
+      { command: "auth token --token <token>", description: "Legacy automation-only: store a token on the selected server." }
+    ],
+    examples: ["rig github auth status # legacy automation only"],
+    next: ["For normal UX, use bare `rig` and the OMP extension cockpit."]
+  }
+];
+var ADVANCED_GROUPS = [
+  {
+    name: "setup",
+    summary: "Legacy automation-only setup bootstrap/check helpers.",
+    usage: ["rig setup <bootstrap|check|preflight>"],
+    commands: [
+      { command: "bootstrap", description: "Legacy automation-only: bootstrap local setup dependencies.", primary: true },
+      { command: "check", description: "Legacy automation-only: check local setup state (toolchain, deps, config).", primary: true },
+      { command: "preflight", description: "Legacy automation-only: run preflight checks before an old run.", primary: true }
+    ]
+  },
+  {
+    name: "profile",
+    summary: "Runtime profile/model defaults.",
+    usage: ["rig profile <show|set>"],
+    commands: [
+      { command: "show", description: "Show the active execution profile.", primary: true },
+      { command: "set [--model <model>] [--runtime <runtime>] [--plugin <plugin>]", description: "Set model/runtime/plugin profile defaults.", primary: true }
+    ]
+  },
+  {
+    name: "review",
+    summary: "Inspect or change completion review gate policy.",
+    usage: ["rig review <show|set>"],
+    commands: [
+      { command: "show", description: "Show current review gate settings." },
+      { command: "set <off|advisory|required> [--provider <provider>]", description: "Change review strictness/provider (e.g. --provider greptile)." }
+    ],
+    examples: ["rig review show", "rig review set required --provider greptile"],
+    next: ["For normal workflow handoffs, use the OMP Inbox screen."]
+  },
+  {
+    name: "pi",
+    summary: "Manage Pi extension packages for this project (community extensions from npm/git).",
+    usage: ["rig pi <list|add|remove|search> [args]"],
+    commands: [
+      { command: "list", description: "Show project and user Pi extension packages." },
+      { command: "add <source>", description: "Add an npm/git Pi extension to .pi/settings.json (auto-installs at next session)." },
+      { command: "remove <source>", description: "Remove an operator-added Pi extension." },
+      { command: "search [term]", description: "Discover Pi extension packages on the npm registry." }
+    ],
+    examples: ["rig pi search subagents", "rig pi add pi-subagents", "rig pi list"],
+    next: ["Config-managed extensions: declare `runtime: { pi: { packages: [...] } }` in rig.config.ts \u2014 workers pick them up automatically."]
+  },
+  {
+    name: "queue",
+    summary: "Run task queues locally.",
+    usage: ["rig queue run [--workers <n>] [--max-tasks <n>] [--action validate|verify|pipeline] [--isolation off|worktree] [--no-runtime-reuse] [--fail-fast] [--skip-project-sync]"],
+    commands: [
+      { 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 }
+    ]
+  },
+  {
+    name: "agent",
+    summary: "Runtime agent workspace helpers.",
+    usage: ["rig agent <list|prepare|run|cleanup>"],
+    commands: [
+      { command: "list", description: "List prepared agent runtimes.", primary: true },
+      { command: "prepare [--id <id>] [--mode <mode>] [--task <task>]", description: "Prepare an isolated agent runtime workspace.", primary: true },
+      { command: "run [--id <id>] [--mode <mode>] [--task <task>] [--skip-project-sync]", description: "Prepare (if needed) and run an agent in its workspace.", primary: true },
+      { command: "cleanup [--all] [--id <id>]", description: "Remove prepared agent workspaces.", primary: true }
+    ]
+  },
+  { name: "inspector", summary: "Event stream and drift scanners.", usage: ["rig inspector <stream|scan-upstream-drift>"], commands: [{ command: "stream", description: "Stream events." }] },
+  {
+    name: "dist",
+    summary: "Build/install packaged Rig CLI.",
+    usage: ["rig dist <build|install|doctor|rebuild-agent>"],
+    commands: [
+      { command: "build [--output-dir <dir>]", description: "Build the distributable Rig CLI.", primary: true },
+      { command: "install [--scope <scope>] [--path <path>]", description: "Install the built CLI to a scope/path.", primary: true },
+      { command: "doctor", description: "Diagnose the dist toolchain and install state.", primary: true },
+      { command: "rebuild-agent", description: "Rebuild the agent runtime image, pruning stale images.", primary: true }
+    ]
+  },
+  { name: "workspace", summary: "Workspace topology/service helpers.", usage: ["rig workspace <summary|topology|remote-hosts>"], commands: [{ command: "summary", description: "Show workspace summary." }] },
+  {
+    name: "remote",
+    summary: "Legacy automation-only remote orchestration controls.",
+    usage: ["rig remote <status|tasks|watch|pause|resume|continue|stop|refresh|add-iterations|remove-iterations|endpoint ...>"],
+    commands: [
+      { command: "status [--remote <alias>]", description: "Legacy automation-only: show old remote orchestration state.", primary: true },
+      { command: "tasks [--remote <alias>]", description: "Legacy automation-only: list the old remote's tracked tasks.", primary: true },
+      { command: "watch [--remote <alias>] [--seconds <n>] [--event <type>]", description: "Legacy automation-only: stream old remote orchestration events.", primary: true },
+      { command: "pause [--remote <alias>]", description: "Legacy automation-only: pause old remote orchestration.", primary: true },
+      { 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 },
+      { command: "continue [--remote <alias>]", description: "Legacy automation-only: continue a paused old remote.", primary: true },
+      { command: "stop [--remote <alias>]", description: "Legacy automation-only: stop old remote orchestration.", primary: true },
+      { command: "refresh [--remote <alias>]", description: "Legacy automation-only: refresh old remote state.", primary: true },
+      { command: "add-iterations [--count <n>] [--remote <alias>]", description: "Legacy automation-only: grant an old remote more iterations.", primary: true },
+      { command: "remove-iterations [--count <n>] [--remote <alias>]", description: "Legacy automation-only: reduce an old remote's iteration budget.", primary: true },
+      { command: "endpoint list", description: "Legacy automation-only: list configured remote endpoints.", primary: true },
+      { command: "endpoint add --alias <alias> --host <host> --port <n> [--token <token>]", description: "Legacy automation-only: register a remote endpoint.", primary: true },
+      { command: "endpoint remove --alias <alias>", description: "Legacy automation-only: remove a remote endpoint.", primary: true },
+      { command: "endpoint test [--alias <alias>]", description: "Legacy diagnostic-only: test connectivity to a remote endpoint.", primary: true },
+      { command: "endpoint doctor", description: "Legacy diagnostic-only: diagnose remote endpoint configuration.", primary: true }
+    ]
+  },
+  { name: "git", summary: "Pass through to Rig git-flow helper.", usage: ["rig git <args...>"], commands: [{ command: "<args...>", description: "Advanced git flow operations." }] },
+  { name: "harness", summary: "Pass through to runtime harness CLI.", usage: ["rig harness <args...>"], commands: [{ command: "<args...>", description: "Advanced harness operations." }] },
+  { name: "test", summary: "Project test wrappers.", usage: ["rig test <unit|e2e|all>"], commands: [{ command: "all", description: "Run configured project tests." }] }
+];
+var ADVANCED_COMMANDS = [
+  { command: "rig server task-run ...", description: "Internal legacy server-owned task execution entry point." },
+  { command: "rig server notify-test [--event <type>]", description: "Internal diagnostic event notification smoke command." },
+  { command: "rig run start|start-serial|start-parallel", description: "Legacy/internal queue starters; not the Rig Cockpit task-detail dispatch path." },
+  { command: "rig remote orchestrate-*", description: "Legacy automation-only remote orchestration commands." }
+];
+var ALL_GROUPS = [...PRIMARY_GROUPS, ...ADVANCED_GROUPS];
+export {
+  helpCatalog,
+  TOP_LEVEL_SECTIONS,
+  PRIMARY_GROUPS,
+  ALL_GROUPS,
+  ADVANCED_GROUPS,
+  ADVANCED_COMMANDS
+};

package/dist/src/index.d.ts

@@ -1,8 +1,11 @@
+export { Schema } from "effect";
 export * from "./baseSchemas";
 export * from "./workspace";
 export * from "./graph";
 export * from "./runtime";
 export * from "./run-journal";
+export * from "./run-session-journal";
+export * from "./run-status";
 export * from "./conversation";
 export * from "./plugin";
 export * from "./plugin-hooks";
@@ -31,3 +34,4 @@ export * from "./task-source";
 export * from "./cli-output";
 export * from "./pi-session";
 export * from "./protocol-version";
+export * from "./help-catalog";