05ae530442
Install current verified harness releases inside Docker, preserve persistent accounts and settings, and provide separate interactive and pipeline model defaults with terminal onboarding and fuzzy pickers. Add Docker-aware authoring transport, Pi stage execution, bounded workflow controls, reliable final-result readback and usage settlement, and finite short-lived CLI pipe draining. Keep dated installation evidence and packaged authoring guidance consistent. Verified with a real Docker installation, both harness stages and interactive authors, the built-in plan/implement/review starter, independent host race/vet checks, installer tests, and packaged skill tests. Generated release receipts stay ignored in clean checkouts.
61 lines
6.5 KiB
Go
61 lines
6.5 KiB
Go
package cli
|
|
|
|
// Help is also the public command inventory for agents and parity checks.
|
|
var usage = map[string]string{
|
|
"provider-check": "provider-check --model PROVIDER/MODEL [--yes] [--json]",
|
|
"new": "new [name] [prompt] [--template KEY] [--no-open | --json]",
|
|
"edit": "edit [name|id] [prompt] [--version N] [--no-open | --json]",
|
|
"drafts": "drafts [--json]",
|
|
"draft-delete": "draft-delete <draft.md> [--json]",
|
|
"validate": "validate <draft.md> [--json]",
|
|
"submit": "submit <draft.md> [--name NAME] [--create-only] [--yes] [--json]",
|
|
"list": "list [--json]",
|
|
"show": "show <name|id> [--version N] [--json]",
|
|
"versions": "versions <name|id> [--json]",
|
|
"export": "export [name|id ...] [--output FILE.zip] [--all] [--version N]",
|
|
"import": "import [FILE.zip] [--all] [--on-conflict ask|keep|both|import] [--yes] [--json]",
|
|
"templates": "templates [--json]",
|
|
"template": "template <key> [--source | --json]",
|
|
"run": "run [name|id] [prompt] [--json [--wait [--wait-timeout DURATION]]]",
|
|
"runs": "runs [--pipeline NAME] [--json]",
|
|
"inspect": "inspect <run-id> [--json]",
|
|
"cancel": "cancel <run-id> [--json]",
|
|
"retry": "retry <run-id> [--json [--wait [--wait-timeout DURATION]]]",
|
|
"debug": "debug <run-id> [--json | --no-open]",
|
|
"connection": "connection [--json]",
|
|
"ping": "ping [--json]",
|
|
"version": "version [--json]",
|
|
"status": "status [--json]",
|
|
"stats": "stats [--json]",
|
|
"rpc": "rpc <request.json|->",
|
|
"tui": "tui",
|
|
}
|
|
|
|
var notes = map[string]string{
|
|
"version": "Identify the local CLI binary without connecting to a server. --version is an alias. Use ping --json to identify the running server separately.",
|
|
"ping": "Pong includes the running server's compiled build.version, build.commit and build.dirty (null when unknown). This identifies the server, not the client or runtime workspace. Older servers omit build.",
|
|
"export": "Without a name, select pipelines with Space and save a ZIP in the current directory. --output writes a portable definition bundle; --all skips selection. One name without --output prints Markdown as before. No runs, credentials or old versions are exported.",
|
|
"import": "Select definitions from a ZIP. Identical existing definitions are skipped. For differing names, choose keep existing, keep both under a new name, or use imported as a new version (history retained). --on-conflict supplies an explicit automation policy; --yes only approves final publication. Schedules may activate; no run history is imported.",
|
|
"new": "Create an optional template copy or a one-stage starter. Opens the configured default harness; --harness opencode|pi|nvim overrides it. No submission is performed.",
|
|
"edit": "Omit the name to open fuzzy selection. Original immutable source is copied to a private draft. The configured harness edits that draft, never the live definition.",
|
|
"validate": "Uses the same server parser as submission. Does not persist or activate schedules. Structural validity does not prove runtime/tool availability.",
|
|
"submit": "Confirm publication at the prompt, or use --yes for explicit automation; schedules activate on acceptance. Managed drafts provide the name and base-version guard. --force never bypasses validation.",
|
|
"run": "Runs in your current directory after action confirmation (--yes skips it). Select a pipeline and compose a multiline task with Ctrl+S. Stage tools are enabled automatically; no file list or typed RUN confirmation. Cancellation does not undo edits. In JSON mode --wait polls until terminal; --wait-timeout bounds only the client wait after admission and is independent of per-request --timeout. A reached wait limit leaves the run active: inspect read-only with `inspect <run-id> --json`, or reattach with --wait reusing the original --request-key (never an automatic replay or cancel).",
|
|
"retry": "Start a new attempt of a failed run with the same initial input, directory, pipeline version, and edit scope. Original history is retained. Already-completed side effects are not undone. --wait/--wait-timeout behave as for run: a reached wait limit leaves the new run active; inspect read-only with `inspect <run-id> --json`, or reattach with --wait and the original --request-key instead of starting a duplicate retry.",
|
|
"debug": "Open a fresh configured harness conversation to investigate a run using inspect/show/runs CLI queries. --harness opencode|pi|nvim chooses another configured harness or read-only nvim packet. Does not resume implementation or retry. --json returns the prompt without launching anything.",
|
|
"rpc": "Accepts a JSON protocol envelope; '-' reads stdin. Every TUI server operation is available here too. Mutating commands are not dry runs.",
|
|
}
|
|
|
|
var serviceHelp = map[string]string{
|
|
"harness": "pipelines harness launches the configured default. harness setup opencode|pi offers fuzzy model selection; --login reopens login, --default chooses the default harness, --model and --pipeline-model set separate defaults explicitly. harness list prints non-secret settings. Only configured harnesses are offered.",
|
|
"skill": "pipelines skill install installs/updates the bundled global OpenCode skill without changing login/config or user-modified skills. ./install includes this step.",
|
|
"service": "Configure per-user OS autostart: pipelines service enable. Runs use the directory you invoke pipelines run from. Use --print to preview, service status to inspect, and service disable before uninstalling. Linux uses systemd; macOS uses launchd. No sudo.",
|
|
"serve": "Run the native server in the foreground. Its flags are documented by pipelines serve --help. Installation never starts it automatically.",
|
|
"start": "Start the per-user native pipeline server and this installation's Docker ntfy together.",
|
|
"stop": "Stop both services. Active execution is interrupted; file changes are not rolled back.",
|
|
"restart": "Stop, then start both services, retaining definitions, run history, and credentials.",
|
|
"doctor": "Check both health endpoints and host OpenCode API discovery; does not execute a model.",
|
|
"logs": "Follow the native server log. Press Ctrl+C to stop following.",
|
|
"uninstall": "Remove verified Go binaries from this command's bin directory; retain data and drafts. --yes skips confirmation. Existing managed installations can be selected explicitly with PIPELINES_PREFIX.",
|
|
}
|