a48e4a5b6a
The template catalog is now Example 1-4: one stage, two stages (handoff), feedback loop (runner-owned limits, retries, timeout) and human decision (type=human approve/revise/abort with notify hooks). All read-only or leave changes uncommitted; none commits, pushes or deploys. A brand-new database (schema created by this Open) gets the examples once at server start, bound to the configured default model and harness. A server_settings marker records the decision, so removed examples never come back and existing installs are marked without any pipeline being added or rewritten.
108 lines
6.3 KiB
Go
108 lines
6.3 KiB
Go
package cli
|
|
|
|
const help = `PIPELINES — reusable workflows for your repositories
|
|
|
|
Usage: pipelines <command> [arguments] [options]
|
|
|
|
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> Resume a failed stage (use --mode=restart for a full restart)
|
|
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, Claude Code or Codex chat
|
|
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)
|
|
|
|
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
|
|
templates List optional templates (never seeds the DB)
|
|
template <key> Inspect a template; --source prints Markdown
|
|
|
|
AUTHORING — only when the user explicitly asks to create or change a definition
|
|
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
|
|
import [FILE.zip] Select/import definitions; explicitly resolve conflicts
|
|
|
|
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 <claude|codex|opencode|pi>
|
|
Install check, sign-in, models and verify for one harness
|
|
harness list Installed / signed-in / configured / default for all four
|
|
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 OpenCode and Claude Code workflow skill
|
|
update Update this installation from its source checkout
|
|
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 run "bug fix" "Fix the layout" --json
|
|
pipelines run "bug fix" "Fix the layout" --model openai/gpt-5 --stage-model review=openai/o4 --json
|
|
|
|
Authoring examples — use only when the operator explicitly requested a definition change:
|
|
pipelines edit "bug fix" "Add a review step"
|
|
pipelines new "release notes" "Summarize changes and notify my phone"
|
|
pipelines new "Add a feature" --template feedback-loop --no-open --json --yes
|
|
pipelines validate /path/to/draft.md --json
|
|
pipelines submit /path/to/draft.md
|
|
|
|
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.
|
|
`
|