b7c2ba7d56
The harness resumes a session when a background command finishes, so "tell me when this run is done" needs one command that blocks and exits rather than a polling script. - `pipelines wait <run-id> [run-id ...]` resolves every id up front (an unknown run is a fast client error), then polls each run to a terminal status - `succeeded`, `failed`, `canceled` or `interrupted`, blocking through a run parked on a human decision - and prints one line per run as it finishes with id, status and outcome, stage and duration. - A finished-but-unsuccessful run is still a finished run: it is reported and the command exits 0. The exit is non-zero only for a client-side failure: an unknown id, a connection that cannot be established, or `--timeout` expiring while a run is still active. A timeout reports the still-active runs, changes nothing, and is never treated as a run's outcome. - Reuses the existing `run --wait` polling machinery: the per-second `get_run` reattachment is factored into `awaitRuns`, used by `finishRun` too. No subscription or new protocol message. `--url`/`--timeout` follow the existing client conventions; `--timeout` is the overall client limit (default 0). - Read-only: sends only `get_run`, resolves no workspace, is not refused by the workspace guard and writes nothing. `--json` prints the final run envelope (one envelope for one id, an array for several). - `commands.go` and `help.go` add it to the usage inventory and EXECUTE help. Tests: `wait_test.go` (line format, batch reporting, wait-until-terminal, unknown id, timeout leaves the run active, `--json` shape) and `wait_command_test.go` (real CLI against the real websocket server and store). Packaged assets checked: no packaged template changes. No authoring skill reference file is added, so `internal/author/install.go`'s managed inventory needs no change. `internal/author/skill/references/operations.md` (the "inspect results first" run-operations list) and `docs/cli.md` (the scripted-runs `--wait` paragraph and the CLI/TUI capability-map row) are now stale and are recorded - not edited - in `docs/notes/wait-command.md` for the `docs-fold` writer. `SKILL.md` stays a task-directed index; no shared document is edited here. No protocol, server, store, TUI or Android change; no new dependency; no run started. Committed locally only, not pushed or deployed.
103 lines
5.9 KiB
Go
103 lines
5.9 KiB
Go
package cli
|
|
|
|
const help = `PIPELINES — reusable workflows for your repositories
|
|
|
|
Usage: pipelines <command> [arguments] [options]
|
|
|
|
AUTHOR
|
|
new [name] [prompt] Create a draft and open the configured harness
|
|
edit [name|id] [prompt] Pick a pipeline, draft changes, open a configured harness
|
|
drafts List retained draft files (including TUI drafts)
|
|
validate <draft.md> Check a draft using the server's validator
|
|
submit <draft.md> Explicitly publish a new immutable version
|
|
|
|
BROWSE
|
|
list List registered pipelines
|
|
search QUERY Search pipelines, versions, runs, steps, field text, artifacts
|
|
show <name|id> Inspect graph, settings, source and history
|
|
versions <name|id> List immutable versions
|
|
export [name|id ...] Select/export definitions as ZIP; one name prints Markdown
|
|
import [FILE.zip] Select/import definitions; explicitly resolve conflicts
|
|
templates List optional templates (never seeds the DB)
|
|
template <key> Inspect a template; --source prints Markdown
|
|
|
|
EXECUTE
|
|
provider-check Validate a provider/model with a tool-free response
|
|
run [name] [prompt] Fuzzy selection, multiline prompt, live inspector
|
|
runs List audited runs; --pipeline filters results
|
|
inspect <run-id> Inspect stages, outputs, errors and status
|
|
wait <run-id> ... Block until runs finish, then report each (read-only)
|
|
cancel <run-id> Cancel a run; changes are NOT rolled back
|
|
decide <run-id> [stage] Choose an option for a run waiting on a person
|
|
retry <run-id> Restart a failed run with its original input and directory
|
|
title <run-id> "<title>" Rename a run after the fact; input/steps unchanged
|
|
debug <run-id> Investigate a run with a configured harness or nvim
|
|
chat-adopt <session-id> Adopt an existing OpenCode session into chat_sessions
|
|
draft-delete <draft.md> Delete a selected retained draft and its metadata
|
|
connection Server and public phone connection (no secrets)
|
|
status Server/ntfy health, ports and server computer IPs
|
|
stats All-history usage, pipeline counts and daily activity
|
|
ping Check connection and identify the running server build
|
|
version Identify this CLI build without connecting (--version)
|
|
rpc <request.json|-> Send any protocol command (automation escape hatch)
|
|
|
|
MAINTAIN
|
|
retention report Show what a run-history policy would remove (read-only)
|
|
retention apply Remove it after approval; artifacts go with their run
|
|
|
|
SERVER / INTERFACE
|
|
harness [opencode|pi] Launch the configured default harness in this directory
|
|
harness setup opencode|pi Login/select separate harness and new-pipeline defaults
|
|
tui Open the dashboard (default with no command)
|
|
serve Start native server in the foreground (Ctrl+C stops it)
|
|
service enable Configure user autostart
|
|
service disable | status Stop/remove autostart, or inspect OS service status
|
|
skill install Install/update the shared Pi/OpenCode authoring skill
|
|
uninstall [--yes] Remove verified Go binaries; retain data and drafts
|
|
|
|
Legacy managed installs: select PIPELINES_PREFIX explicitly for start/stop,
|
|
restart/doctor/logs and retained-data or --purge uninstallation.
|
|
|
|
Options: --url ws://127.0.0.1:8080/connect --json --help
|
|
Use pipelines help <command> for its flags. Names with spaces must be quoted.
|
|
|
|
Stage result format:
|
|
Model and agent stages accept a line-oriented result. The first non-empty line
|
|
is the declared outcome, followed by "# " sections. "# output" is required and
|
|
short (a JSON object carrying the next stage's data); additional sections are
|
|
free-form markdown evidence. The legacy {"outcome":...,"output":...} JSON
|
|
envelope remains accepted for compatibility.
|
|
|
|
Examples:
|
|
pipelines edit "bug fix" "Add a review step"
|
|
pipelines new "release notes" "Summarize changes and notify my phone"
|
|
pipelines new "Add a feature" --template task --no-open --json --yes
|
|
pipelines validate /path/to/draft.md --json
|
|
pipelines submit /path/to/draft.md
|
|
pipelines run "bug fix" "Fix the layout" --json
|
|
pipelines run "bug fix" "Fix the layout" --model openai/gpt-5 --stage-model review=openai/o4 --json
|
|
|
|
Run retention (local, explicit, never automatic):
|
|
pipelines retention report --db ~/.local/share/pipelines/data/pipelines.db --keep 200 --json
|
|
pipelines retention apply --db ~/.local/share/pipelines/data/pipelines.db --keep 200 --yes
|
|
|
|
Launch-time model overrides: 'pipelines run --model P/M' covers every model stage;
|
|
'--stage-model STAGE=P/M' (repeatable; a repeated key is last-wins) overrides one
|
|
stage and wins over --model, which wins over the model pinned in the pipeline
|
|
version. Overrides apply to that run only, are recorded on the run, and are
|
|
validated before the run starts (an unknown stage key names the valid keys).
|
|
|
|
Draft-first: the configured harness (Pi/OpenCode; host by default, or Docker-linked
|
|
when a checkout is linked) edits a private draft; nvim remains a client editor.
|
|
Nothing is published automatically.
|
|
Every submission is validated server-side. Submission activates any schedules.
|
|
JSON mode never launches an editor or picker; supply explicit arguments.
|
|
|
|
Search: the 'pipelines search QUERY' command and the TUI '/' popup find pipelines,
|
|
versions, runs, steps/visits, artifact names and the text of stage inputs,
|
|
outputs and evidence. A bare status word (queued, running, succeeded, failed,
|
|
canceled, interrupted) or a date (today, yesterday, this week, or YYYY-MM-DD in
|
|
local time) selects runs. --type narrows to pipeline, version, run, step, field
|
|
or artifact; unrecognised words stay text.
|
|
`
|