Files
pipelines/README.md
T

127 lines
4.0 KiB
Markdown

# Pipelines
Reusable, sequential workflows for your repositories. A Go CLI/TUI and native
server reuse your OpenCode login; Docker ntfy handles phone notifications.
## Install
Requires **Go 1.27+** to install. Use your existing OpenCode for model stages;
Docker/ntfy notifications are optional.
```sh
git clone https://git.a-wan.net/alan/pipelines.git
cd pipelines
./install.sh
pipelines help
```
Go uses `GOBIN` or its normal `GOPATH/bin` default; put that directory on PATH.
`./install.sh` installs the Go binaries and the shared OpenCode `pipelines` skill.
There are no login checks, dependency installers, hardcoded install paths, or
automatic services. With plain `go install ./cmd/...`, also run `pipelines skill install`.
For system-wide use, install the binaries into your chosen system bin directory
with the appropriate permissions. Configuration and data remain per-user.
Start explicitly; fresh databases contain no pipelines:
```sh
pipelines serve # foreground server
# In another terminal:
pipelines
```
Optional autostart at login (starts the server now):
```sh
pipelines service enable
pipelines service status
```
Uses user-level systemd on Linux or launchd on macOS; no sudo. Runs use the
directory you invoke `pipelines run` from. Preview with `--print`. Stop any existing
foreground/legacy server first. Disable with `pipelines service disable` before
uninstalling. See [installation](docs/install.md) for environment and boot options.
## Uninstall
```sh
pipelines uninstall # remove Go binaries; keep history, drafts, and ntfy data
```
## A three-stage pipeline
**Plan → Implement → Review**. Each stage receives the previous stage's output;
the first receives your task prompt. One outcome selects the next stage—no
parallel branches. Definitions use Markdown `output`, `prompt`, `tools`,
`configs`, and `edges` blocks. For example:
````markdown
# stage planner
```output
{ task, plan, acceptance_checks }
```
```prompt
Turn input.prompt into a focused plan and acceptance checks.
```
```tools
```
```configs
provider=opencode-go
model=deepseek-v4.1-flash
retries=0
```
```edges
success -> implementer
error -> #failure
```
````
The [complete three-stage example](examples/three-stage.md) adds the implementer
and reviewer. Review and explicitly submit it:
```sh
pipelines validate examples/three-stage.md
pipelines submit examples/three-stage.md --name "three stage" --create-only
pipelines run "three stage"
```
Every submission is validated and creates an immutable version. Examples are
optional; nothing is imported automatically. Run from your repository directory;
stage tools are enabled automatically. Edits support any language/file type and
new files. No file list or typed RUN confirmation is required.
## Useful commands
```sh
pipelines # dashboard; b browses templates
pipelines list
pipelines run # fuzzy selection + multiline prompt
pipelines run "bug fix" "Fix the layout" # run in the current repository
pipelines new "daily digest" "Summarize changes"
pipelines edit "bug fix" "Add a review step"
pipelines drafts --json
pipelines validate /path/to/draft.md
pipelines submit /path/to/draft.md # explicit publication
pipelines runs
pipelines inspect 1
pipelines serve # foreground server; Ctrl+C stops it
pipelines ping
pipelines help edit
```
`new`/`edit` open OpenCode directly with `@pipelines`. The installed skill asks
missing questions; `pipelines new` needs no preliminary questionnaire. Changes stay
as drafts by default; CLI and TUI share validation and draft storage. Most
commands support `--json` for agents and scripts.
In the TUI, press **d** (or use **:drafts**) to browse retained drafts, including
CLI-created ones. **e** reopens a draft, **v** validates it, and **s** opens explicit
submission confirmation. Drafts remain retained after submission.
More: [CLI](docs/cli.md) · [installation](docs/install.md) · [pipeline format](internal/author/skill/references/format.md).