121 lines
4.9 KiB
Markdown
121 lines
4.9 KiB
Markdown
# Pipelines
|
|
|
|
Small, reusable AI workflows for coding, research, and everyday project work.
|
|
Run them in your browser or terminal using your existing configured harnesses.
|
|
Inspect each stage's output, file changes, artifacts, and recorded session.
|
|
|
|
**Alpha:** single-user, supervised work. Models can make mistakes and editing
|
|
workflows can change files and run commands. Start in a disposable project;
|
|
review results before trusting them. Provider charges may apply.
|
|
|
|
## Install on macOS or Linux
|
|
|
|
Use a Git checkout and an already configured OpenCode installation. You also
|
|
need Go 1.27+, Python 3.9+, Git, curl, a C compiler, and Node.js 18+.
|
|
The installer checks prerequisites; it does not replace your harness or provider
|
|
credentials. Pi can also be used when configured.
|
|
|
|
```sh
|
|
git clone https://git.a-wan.net/alan/pipelines.git
|
|
cd pipelines
|
|
./install
|
|
```
|
|
|
|
Native installation is the default: Pipelines runs on your host and reuses your
|
|
existing harness setup. Follow the installer's connection details to open the
|
|
web app (default `http://localhost:8082/`). Setup creates or reuses its private
|
|
web sign-in credentials and enables startup at login. Run as your normal user
|
|
in a working macOS launchd or Linux systemd user session.
|
|
If no usable model default is configured, setup asks you to select one inside
|
|
`./install`; no separate configuration command or test generation is required.
|
|
|
|
For optional terminal commands, select the installation and add its binaries
|
|
to PATH (use your custom prefix if you changed it):
|
|
|
|
```sh
|
|
export PATH="$HOME/.local/share/pipelines/bin:$PATH"
|
|
pipelines service enable
|
|
pipelines service status
|
|
pipelines doctor
|
|
```
|
|
|
|
See [installation](docs/install.md) for autostart controls, custom ports, data
|
|
locations, and troubleshooting. No sudo is needed. Keep the raw
|
|
Pipelines and harness APIs private. Use the authenticated web proxy for browser
|
|
access; do not expose the control APIs to the Internet.
|
|
|
|
### Prefer Docker?
|
|
|
|
```sh
|
|
./install --docker
|
|
```
|
|
|
|
Docker remains optional, not the default. It uses its own persistent harness
|
|
credentials and needs Docker Compose and Python 3. Do not start a second native
|
|
server alongside it. [Docker setup and migration](docs/install.md).
|
|
|
|
## Try a starter
|
|
|
|
In the web app, open **Settings → Templates**, select a starter, and create a
|
|
pipeline. In the terminal, run `pipelines` and use `:templates`.
|
|
|
|
Choose a small code change, a read-only review, research, or a document utility.
|
|
Starters use your task and selected project—not this repository's paths, stack,
|
|
or accounts. They inherit configured model defaults. Templates are available
|
|
immediately but are never published or run without your choice.
|
|
|
|
1. Select the project directory **on the server machine**.
|
|
2. Give the pipeline a specific task and run it.
|
|
3. Inspect the report, stage visits, and any changed files.
|
|
|
|
For terminal use, launch from your project directory:
|
|
|
|
```sh
|
|
cd /path/to/your/project
|
|
pipelines
|
|
# After creating a pipeline:
|
|
pipelines run "your pipeline name" "Describe a small task"
|
|
pipelines runs
|
|
pipelines inspect 1
|
|
```
|
|
|
|
A browser on another machine does not upload that machine's project files.
|
|
Recurring work uses separate [saved run schedules](docs/schedules.md), not workflow
|
|
definitions. Reuse one pipeline with different prompts and timers; filter both
|
|
Pipelines and Runs by scheduling state.
|
|
For editing work, use version control and keep a backup. Cancellation and retries
|
|
are **not rollback**; a new execution can repeat side effects.
|
|
|
|
## Sessions and notifications
|
|
|
|
Pipelines records and exports stage sessions itself. A model stage cannot hand
|
|
its result to the next stage until its session is settled and its export is
|
|
verified. If export fails, the computed output is retained while export-only
|
|
recovery waits; this is not a request to rerun the agent or make a human decision.
|
|
See [session capture](docs/notes/session-export-handoff-gate.md).
|
|
|
|
Notifications have separate channels:
|
|
|
|
- **Web alerts:** require the page to be open and browser permission where
|
|
supported. Closed-app browser push is not implemented.
|
|
- **ntfy:** optional phone notifications, independent of the Pipelines app.
|
|
Removing the app does not unsubscribe an ntfy client.
|
|
|
|
See [notification setup](docs/ntfy.md). The installer checks publishing, not
|
|
actual delivery to your phone.
|
|
|
|
## More
|
|
|
|
- [Alpha walkthrough and known limits](docs/first-version-testing.md)
|
|
- [Installation and autostart](docs/install.md)
|
|
- [Configured harnesses and models](docs/harnesses-and-control.md)
|
|
- [CLI commands](docs/cli.md)
|
|
- [Pipeline format](internal/author/skill/references/format.md)
|
|
- [App (web and Android)](app/README.md) · [Web proxy](web/README.md)
|
|
- [Artifacts](docs/stage-artifacts.md) · [File diffs](docs/stage-file-diffs.md)
|
|
- [Transfer pipeline definitions](docs/pipeline-transfer.md)
|
|
|
|
When reporting a problem, include your OS, install mode, reproduction steps,
|
|
`pipelines version --json`, and `pipelines ping --json`. Redact credentials and
|
|
private task/file content; do not post your database or native session storage.
|