rpi is a self-contained Rust coding agent CLI for interactive and non-interactive AI-assisted coding, with pluggable provider support, automatic context compaction, and native Pi v3 session storage.

The executable binary is rpi. Runtime configuration remains compatible with the upstream Pi layout (~/.pi/agent, project .pi/, and PI_* environment variables). The headless JSONL RPC control plane is rpi rpc (≡ --mode rpc).

Install the prebuilt rpi binary from GitHub Releases. The installer selects the current platform archive, verifies SHA256SUMS, and activates the binary:

curl -fsSL https://raw.githubusercontent.com/0x8f701/rpi/master/install.sh | sh

Windows (PowerShell):

irm https://raw.githubusercontent.com/0x8f701/rpi/master/install.ps1 | iex

Pin both the installer source and selected release to v0.2.11:

curl -fsSL https://raw.githubusercontent.com/0x8f701/rpi/v0.2.11/install.sh | bash -s -- --version v0.2.11

& ([scriptblock]::Create((irm https://raw.githubusercontent.com/0x8f701/rpi/v0.2.11/install.ps1))) -Version v0.2.11

The release archive contains the compiled rpi executable; users do not need Rust or a source checkout. Maintainers who need a local source build can follow the explicitly separated developer fallback in docs/src/introduction/install.md.

The release installer places the active binary at ~/.rpi/bin/rpi (%USERPROFILE%\.rpi\bin\rpi.exe on Windows) and adds that directory to the user PATH when needed. Open a new terminal before running rpi if the installer reports that it changed PATH. See docs/src/introduction/install.md for supported platforms, manual verification, and rollback behavior.

Configure one provider before the first model request:

rpi login anthropic

For non-interactive setup, set the provider-specific environment variable to a redacted credential value (see docs/src/user-guide/authentication.md).

Then run:

# Non-interactive print mode
rpi --print -m anthropic/claude-sonnet-4-5 "List the Rust files in this directory"

# JSON event stream (headless, one-shot)
rpi --mode json -m anthropic/claude-sonnet-4-5 "List Rust files"

# Interactive inline TUI (or line REPL when no terminal is available)
rpi -m anthropic/claude-sonnet-4-5

# List available models
rpi models

# Continue the newest saved session for the current directory
rpi --continue

See docs/src/introduction/quickstart.md for the first-run walkthrough and docs/src/user-guide/cli-modes.md for every flag and subcommand.

• docs/src/introduction/install.md — installation, platforms, and verification
• docs/src/introduction/quickstart.md — first steps
• docs/src/user-guide/cli-modes.md — print mode, REPL, TUI, slash commands
• docs/src/reference/settings-trust.md — settings.json, config directory, and trust boundaries
• docs/src/reference/architecture.md — crate dependency and runtime architecture diagrams
• docs/src/user-guide/authentication.md — env vars, auth.json, models.json, and precedence
• docs/src/user-guide/models.md — model catalog, model spec syntax, and custom providers
• docs/src/user-guide/rpc-json.md — event schema for library consumers
• docs/src/user-guide/tui.md — TUI keybindings and status bar
• docs/src/reference/prompt-templates.md — system prompt assembly
• docs/src/reference/skills.md — .pi/skills discovery
• docs/src/reference/update.md — release and update safety
• docs/src/reference/export-share.md — session export, clipboard, and gist sharing
• docs/src/reference/local-llama.md — local/self-hosted models
• docs/src/reference/extensions.md — process extension protocol and UI requests
• docs/src/reference/packages.md — local/git packages for rpi install (npm package sources deferred; the plugin marketplace accepts npm: sources via rpi plugin install)
• docs/src/reference/security.md — credentials, path scoping, and installer safety
• docs/src/reference/environment-variables.md — all environment variables
• docs/src/user-guide/goals.md — durable session goals: lifecycle, token budget, pins, journal
• docs/src/user-guide/todos.md — the Todo DAG, /todo panel, and steering/follow-up queues
• docs/src/user-guide/orchestration.md — subagents, jobs, soft budgets, IRC, and the task/hub/yield tools
• docs/src/user-guide/workflows.md — isolated concurrent workflows (worktree/overlayfs/none) with planning and Todo-DAG execution
• docs/src/user-guide/session-recovery.md — /rewind, /checkpoint, /snapcompact, /handoff, doom-loop recovery, and session TTL
• docs/src/user-guide/live.md — TUI hold-to-talk STT (/live) and Web realtime voice (/web)
• docs/src/reference/configuration-profiles.md — --profile, TOML settings, env expansion, and scoped auth
• docs/src/reference/sandbox-isolation.md — Linux filesystem sandbox and overlayfs isolation
• docs/src/reference/hooks.md — host hooks and the trust hook
• docs/src/reference/memory.md — local and Hindsight memory backends
• docs/src/reference/tools.md — extended tool catalog (LSP, browser, GitHub, debug, eval, notebook, images, ask)
• docs/src/reference/mcp.md — Model Context Protocol client
• docs/src/reference/acp.md — Agent Client Protocol mode (rpi agent stdio/serve)
• docs/src/user-guide/e2e-scenarios.md — user-perspective end-to-end scenarios (tmux-driven)

Runnable examples are in examples/.

• rpi models [filter] — list models
• rpi sessions — list sessions
• rpi import-session SOURCE INPUT [--output PATH] — convert external sessions
• rpi export SESSION_PATH [--output PATH] [--jsonl] — export to HTML/JSONL
• rpi login [provider] / rpi logout [provider] — manage stored credentials
• rpi reload — validate and print active resources
• rpi install SOURCE [--local] / rpi remove SOURCE [--local] / rpi list — manage local/git packages
• rpi plugin list [--updates] / rpi plugin install SOURCE / rpi plugin remove NAME / rpi plugin update NAME — manage marketplace plugins
• rpi update [--self] [--extensions] [--all] [--models] [--extension SOURCE] [PACKAGE] — update rpi, packages, or model catalogs
• rpi llama configure|status|refresh|load|unload|search|details|download|installed — manage local models
• rpi agent stdio / rpi agent serve — Agent Client Protocol (ACP) mode for ACP-speaking editors

See docs/src/user-guide/cli-modes.md for details.

rpi --listen <SOCKET_ADDR> runs a headless Web-only backend and serves the embedded client at /web. It never starts the TUI or line REPL, stays alive with closed stdin until Ctrl-C/SIGTERM, and records Web conversations in the normal session store so --continue/--resume restore them after restart. The flag requires a socket address. By default it uses HTTPS with an auto-generated self-signed certificate; provide real certificates with --listen-cert and --listen-key, or opt out with --listen-plaintext.

Authentication rules:

• Loopback (127.0.0.0/8 or ::1) may be tokenless or tokenized.
• A non-loopback HTTPS bind requires --listen-token-file; tokenless remote TLS is rejected pre-bind.
• --listen-allow-insecure-remote is the explicit tokenless-remote opt-in: it permits tokenless browsers on a non-loopback bind. Combined with --listen-plaintext it is both unauthenticated and unencrypted; without --listen-plaintext it is encrypted but unauthenticated.

Local HTTPS, no token — loopback:

$ rpi --listen 127.0.0.1:8765

Open https://127.0.0.1:8765/web; accept the self-signed certificate warning for local testing. The page auto-connects with no token.

Local plaintext, no token — opt out of TLS on loopback:

$ rpi --listen 127.0.0.1:8765 --listen-plaintext

Open http://127.0.0.1:8765/web; the page auto-connects with no token.

Remote / LAN HTTPS — non-loopback; a token file is mandatory:

$ rpi --listen 0.0.0.0:8765 --listen-token-file <workspace>/rpi-token

Open https://<host>:8765/web. The browser must present the token.

Remote plaintext, tokenless — explicit insecure opt-in (not recommended):

$ rpi --listen 0.0.0.0:8765 --listen-plaintext --listen-allow-insecure-remote

Open http://<host>:8765/web. Same-origin browser access applies (Origin authority equals HTTP Host). This is unauthenticated and unencrypted: anyone reachable on the network can drive the agent and observe traffic. Prefer loopback, real certificates, or a TLS-terminating proxy on untrusted networks.

The /web page stores the token per listener authority in localStorage; it is never placed in a URL or cookie. The token authenticates clients but does not encrypt the bearer token or control traffic against passive network observers. rpi agent serve remains loopback-only and rejects tokenless browsers.

Collaboration join links (/collab, collab_start without an explicit baseUrl) cannot be synthesized from a wildcard bind. For a wildcard --listen address (0.0.0.0 or ::), pass --listen-advertised-origin <URL> — a strict http/https origin with no credentials, path, query, or fragment — so collab links point at a reachable host. Loopback and other specific binds advertise their bound address automatically.

Startup also prints a reachable Web UI hint. Explicit --listen-advertised-origin wins (Web UI: <origin>/web). On a concrete bind the bound address is used. On a wildcard bind without that flag, rpi best-effort discovers a route-selected LAN address and prints Web UI: <scheme>://<lan-ip>:<port>/web; if discovery is unavailable it tells you to use this machine's LAN IP and port rather than an unreachable wildcard URL. Ordinary /web access does not depend on the banner.

See CHANGELOG.md.

MIT — see LICENSE.