mirror of
https://github.com/getpaseo/paseo.git
synced 2026-07-29 12:01:31 +00:00
* Add Docker images and agent Docker Mods Ship official container images that run the Paseo daemon headless. One Dockerfile parametrized by BASE_IMAGE covers Debian 12/13, Ubuntu 22.04/24.04 and Alpine; it bundles Node 22, the npm-published server + CLI, a vendored s6-overlay as PID 1, and a small Docker Mods loader. Agents are chosen at runtime via DOCKER_MODS (pipe-separated mod images). Each mod is a FROM scratch image carrying only an install hook that runs `npm install -g <agent-cli>`; the loader pulls the layers from the registry, extracts them, and runs the hook before the daemon starts, so any requested agent is on PATH when Paseo probes provider availability. - docker/base: Dockerfile, install scripts, s6 services, mods loader - docker/mods/*: claude-code, codex, copilot, opencode, pi - docker/docker-compose.example.yml + docker/README.md - .github/workflows/docker.yml: multi-arch (amd64/arm64) buildx matrix, publishes to ghcr.io/getpaseo on version tags - docs/docker.md + CLAUDE.md docs index row * feat(docker): print pairing QR and link on daemon startup Add an s6 oneshot service that waits for the daemon to listen, then runs `paseo daemon pair` so the pairing QR code and link surface in the container logs. Best-effort: never blocks boot, skips gracefully when relay is disabled. Opt out with PASEO_PAIRING_QR=0. * build(docker): add Arch image support * ci(docker): build Arch without Buildx * docs(docker): document paseo env contract * feat(docker): add opt-in sudo mode * docs(docker): link env references * fix(docker): create agent config dirs * fix(docker): default home to /home/paseo * docs(docker): document agent auth setup * docs(docker): document relay port setup * fix(docker): install Node from tarball * docs: add Docker quick start * docs(docker): remove legacy home example * docs(docker): set container hostname * fix(docker): prepare opencode storage * fix(docker): allow paseo login shell * fix docker opencode permissions * ci(docker): use Node 24 actions * fix(docker): install bzip2 runtime tools * fix(docker): update Pi mod package * fix(docker): quiet default daemon logs * fix(docker): split home from state Docker images now keep HOME at /home/paseo and store Paseo daemon state under /home/paseo/.paseo by default. Existing volumes can keep the old layout by setting PASEO_HOME=/home/paseo. * fix(docker): keep mods out of paseo home * ci(docker): skip alpine arm64 builds * fix(docker): address review findings * fix(docker): verify s6 overlay downloads * fix(docker): honor custom healthcheck port * fix(docker): fail on mod extraction errors * feat(docker): add official container image Ship a focused daemon image with the bundled web UI enabled and document extending it with agent CLIs. * ci(docker): publish images only on stable releases * fix(docker): check daemon health over HTTP --------- Co-authored-by: Herbrant <cdavide98carnemolla@gmail.com>
188 lines
5.8 KiB
Markdown
188 lines
5.8 KiB
Markdown
---
|
|
title: CLI
|
|
description: "Paseo CLI reference: manage agents, daemons, permissions, and worktrees from your terminal."
|
|
nav: CLI
|
|
order: 3
|
|
category: Getting started
|
|
---
|
|
|
|
# CLI
|
|
|
|
The Paseo CLI lets you manage agents from your terminal. It's the same interface exposed by the daemon's API, so anything you can do in the app you can do from the command line.
|
|
|
|
> **Agent orchestration:** You can tell coding agents to use the Paseo CLI to spawn and manage other agents. This enables multi-agent workflows where one agent delegates subtasks to others and waits for results.
|
|
|
|
## Quick reference
|
|
|
|
```bash
|
|
paseo run "fix the tests" # Start an agent
|
|
paseo ls # List running agents
|
|
paseo attach <id> # Stream agent output
|
|
paseo send <id> "also fix linting" # Send follow-up task
|
|
paseo logs <id> # View agent timeline
|
|
paseo stop <id> # Stop an agent
|
|
```
|
|
|
|
## Running agents
|
|
|
|
Use `paseo run` to start a new agent with a task:
|
|
|
|
```bash
|
|
paseo run "implement user authentication"
|
|
paseo run --provider codex "refactor the API layer"
|
|
paseo run --detach "run the full test suite" # background
|
|
paseo run --worktree feature-x "implement feature X"
|
|
paseo run --output-schema schema.json "extract release notes"
|
|
paseo run --output-schema '{"type":"object","properties":{"summary":{"type":"string"}},"required":["summary"]}' "summarize release notes"
|
|
```
|
|
|
|
The `--worktree` flag creates the agent in an isolated git worktree, useful for parallel feature development.
|
|
|
|
Use `--output-schema` to return only matching JSON output. You can pass a schema file path or an inline JSON schema object. This mode cannot be used with `--detach`.
|
|
|
|
By default, `paseo run` waits for completion. Use `--detach` to run in the background.
|
|
|
|
## Listing agents
|
|
|
|
```bash
|
|
paseo ls # Running agents in current directory
|
|
paseo ls -a # Include completed/stopped agents
|
|
paseo ls -g # All directories
|
|
paseo ls -a -g --json # Full list as JSON
|
|
```
|
|
|
|
## Streaming output
|
|
|
|
Use `paseo attach` to stream an agent's output in real-time:
|
|
|
|
```bash
|
|
paseo attach abc123 # Attach to agent (Ctrl+C to detach)
|
|
```
|
|
|
|
Agent IDs can be shortened, `abc` works if it's unambiguous.
|
|
|
|
## Sending messages
|
|
|
|
Send follow-up tasks to a running or idle agent:
|
|
|
|
```bash
|
|
paseo send <id> "now run the tests"
|
|
paseo send <id> --image screenshot.png "what's wrong here?"
|
|
paseo send <id> --no-wait "queue this task"
|
|
```
|
|
|
|
## Viewing logs
|
|
|
|
```bash
|
|
paseo logs <id> # Full timeline
|
|
paseo logs <id> -f # Follow (streaming)
|
|
paseo logs <id> --tail 10 # Last 10 entries
|
|
paseo logs <id> --filter tools # Only tool calls
|
|
```
|
|
|
|
## Waiting for agents
|
|
|
|
Block until an agent finishes its current task:
|
|
|
|
```bash
|
|
paseo wait <id>
|
|
paseo wait <id> --timeout 60 # 60 second timeout
|
|
```
|
|
|
|
Useful in scripts or when one agent needs to wait for another.
|
|
|
|
## Permissions
|
|
|
|
Agents may request permission for certain actions. Manage these from the CLI:
|
|
|
|
```bash
|
|
paseo permit ls # List pending requests
|
|
paseo permit allow <id> # Allow all pending for agent
|
|
paseo permit deny <id> --all # Deny all pending
|
|
```
|
|
|
|
## Agent modes
|
|
|
|
Change an agent's operational mode (provider-specific):
|
|
|
|
```bash
|
|
paseo agent mode <id> --list # Show available modes
|
|
paseo agent mode <id> bypass # Set bypass mode
|
|
paseo agent mode <id> plan # Set plan mode
|
|
```
|
|
|
|
## Daemon management
|
|
|
|
```bash
|
|
paseo daemon start # Start the daemon
|
|
paseo daemon start --web-ui # Start and serve the bundled web UI
|
|
paseo daemon status # Check status
|
|
paseo daemon stop # Stop the daemon
|
|
```
|
|
|
|
Use `PASEO_HOME` to run multiple isolated daemon instances.
|
|
|
|
## Connecting to a remote daemon
|
|
|
|
`--host` accepts either a local target (`host:port`, a unix socket, or a Windows pipe) or a pairing offer URL, the same `https://app.paseo.sh/#offer=...` link the mobile app uses for QR pairing. With an offer URL the CLI connects through the Paseo relay with end-to-end encryption, so you can drive a daemon on another machine without exposing it to the network.
|
|
|
|
Get an offer URL from the daemon you want to control:
|
|
|
|
```bash
|
|
paseo daemon pair --json # prints { url, qr, ... }
|
|
```
|
|
|
|
Use it from anywhere:
|
|
|
|
```bash
|
|
paseo ls --host 'https://app.paseo.sh/#offer=eyJ2IjoyLC...'
|
|
paseo run --host "$OFFER_URL" "fix the failing tests"
|
|
```
|
|
|
|
You can also set it once via `PASEO_HOST` instead of passing `--host` on every command.
|
|
|
|
## Multi-agent workflows
|
|
|
|
The CLI is designed to be used by agents themselves. You can instruct an agent to spawn sub-agents for parallel work:
|
|
|
|
```bash
|
|
# Agent A spawns Agent B and waits for it
|
|
paseo run --detach "implement the API" --name api-agent
|
|
paseo wait api-agent
|
|
paseo logs api-agent --tail 5
|
|
```
|
|
|
|
Simple implement + verify loop:
|
|
|
|
```bash
|
|
# Requires jq
|
|
while true; do
|
|
paseo run --provider codex "make the tests pass" >/dev/null
|
|
|
|
verdict=$(paseo run --provider claude --output-schema '{"type":"object","properties":{"criteria_met":{"type":"boolean"}},"required":["criteria_met"],"additionalProperties":false}' "ensure tests all pass")
|
|
if echo "$verdict" | jq -e '.criteria_met == true' >/dev/null; then
|
|
echo "criteria met"
|
|
break
|
|
fi
|
|
done
|
|
```
|
|
|
|
This pattern enables hierarchical task decomposition, a lead agent can break down work, delegate to specialists, and synthesize results.
|
|
|
|
## Output formats
|
|
|
|
Most commands support multiple output formats for scripting:
|
|
|
|
```bash
|
|
paseo ls --json # JSON output
|
|
paseo ls --format yaml # YAML output
|
|
paseo ls -q # IDs only (quiet)
|
|
```
|
|
|
|
## Global options
|
|
|
|
- `--host <target>`, connect to a different daemon (`host:port`, unix socket, or `https://app.paseo.sh/#offer=...` for relay). See [Connecting to a remote daemon](#connecting-to-a-remote-daemon).
|
|
- `--json`, JSON output
|
|
- `-q, --quiet`, minimal output
|
|
- `--no-color`, disable colors
|