diff --git a/README.md b/README.md index 17849fef..79e829d0 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ Small, reusable AI workflows for coding, research and everyday project work, plus chats with the coding agents you already use. -Pipelines is one per-user server with three clients: +Pipelines is one per-user server with two clients: -- **Web app** (Flutter, served behind a sign-in) and the same app as an +- **The app** (Flutter): served as a web app behind a sign-in, and as an **Android APK**. - **CLI and TUI** (`pipelines`) for scripting, inspection and authoring. @@ -26,6 +26,7 @@ results, and expect provider charges. git clone https://git.a-wan.net/alan/pipelines.git cd pipelines ./install # server + CLI + web app, login autostart +./install --web # rebuild only the web app after app changes ./install --apk # optional: Android app, offered to phones for update ``` @@ -34,13 +35,9 @@ compiler, a **running Docker** (the web app is built in Docker; the install refuses without it) and an existing OpenCode on `PATH`. The installer never installs these for you. See [Installation](docs/install.md). -Then put the CLI on your `PATH`, open the URL the installer prints (default -`http://localhost:8082/`) and sign in with the password you chose: - -```sh -export PATH="$HOME/.local/share/pipelines/bin:$PATH" # add to ~/.bashrc or ~/.zshrc -pipelines status -``` +Then open the URL the installer prints (default `http://localhost:8082/`) +and sign in with the password you chose. Put the CLI on your `PATH` as in the +[terminal quick start](#terminal-quick-start). ### Linux quick start (Debian/Ubuntu) @@ -86,12 +83,12 @@ pipelines harness list # status of all four ## What you can do **Runs** -- Runs list with filters, multi-select and delete, and sorting by newest, - oldest, **largest on disk**, duration, pipeline or status. -- Run detail tabs: Summary, Timeline, and Artifacts and Changes when the run - has any. +- Runs list with filters, sorting and multi-select delete. +- Run detail: Summary, Timeline, and Artifacts and Changes when the run has + any. - Artifacts viewer for files a stage produced, including the recorded session - export (`session.html`). + export (`session.html`), with a full-screen view where HTML pages scroll, + zoom and open their links. - Changes: the file diffs each stage made in the workspace. - Human decision stages: a run waits for you; decide in the app or with `pipelines decide`. @@ -156,7 +153,8 @@ See [Harnesses](docs/harnesses.md). ## Terminal quick start ```sh -export PATH="$HOME/.local/share/pipelines/bin:$PATH" +export PATH="$HOME/.local/share/pipelines/bin:$PATH" # add to ~/.bashrc or ~/.zshrc +pipelines status cd /path/to/your/project pipelines # TUI pipelines run "pipeline name" "Describe a small task"