Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.protean.peerislands.io/llms.txt

Use this file to discover all available pages before exploring further.

Per ADR-0003, protean is a thin shim around @mariozechner/pi-coding-agent. For interactive coding-agent use, the shim spawns pi with our extensions/skills/theme injected. Other commands run in-process.

Subcommands

CommandWhat it does
protean versionPrint the CLI version.
protean helpShow usage.
protean healthRound-trip through @protean/sdk to apps/api’s /v1/health.
protean replay <run_id>Read-back of a recorded run from ./runs/<run_id>.json. (Re-execution lands with Slice 1.)
protean login [provider]Begin an OAuth flow; prints the authorization URL. Provider: google, github, or o365.
protean code [args...]Interactive coding-agent. Forwards args to pi.

Global options

FlagDescription
--api <url>Base URL of the API. Defaults to $PROTEAN_API_URL then http://localhost:8000.
--jsonJSON output where supported.
--help, -hShow help.
--version, -vShow version.

Source

apps/cli/src/main.ts is the dispatch table. Commands are pure functions (run<X>(opts)) that return { ok, ... }; formatting and exit codes are handled in main.ts.