Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Every pikopod command, grouped by what it does.
pikopod [command] [flags]
--config <path>, which defaults to ./pikopod.yaml. pikopod --version prints the version, commit and date.
0 clean, 1 the check ran and failed, 2 pikopod or configuration error. See Exit codes.
error: no configuration found: pikopod.yaml does not exist → run `pikopod init` to scaffold one, or pass --config → https://github.com/pikopod/pikopod/blob/main/docs/config-reference.md
| Command | What it does |
|---|---|
spec-diff | Diff two spec versions. Exit 1 on breaking changes. |
spec-update | Write a traffic-evidenced spec update. |
pr comment, pr open | Post findings on a pull request, or open one. |
| Command | What it does |
|---|---|
import | Import a spec or a docs URL into a sandbox. |
sandbox add, list, reset, requests, webhooks | Manage sandboxes. |
chaos | Arm a fault on a running sandbox. |
mode set, show, clear | Put a running sandbox into a scenario’s standing state. |
webhook emit, list | Fire a declared event; inspect deliveries. |
why | Replay a request with decision tracing. |
| Command | What it does |
|---|---|
scenario list, run, create, from-drift, from-recordings, reproduce | Bind, run and generate scenarios. |
| Command | What it does |
|---|---|
incidents, incidents export | Read the event log; export a bundle. |
replay --ci | Gate builds offline on recorded traffic. |
conformance | Does the provider obey its own spec? |
contract | The effective contract and the observed state machine. |
status, report, inspect | Health, inventory, and stored records. |
ack, accept, baseline reset | Manage alerts and baselines. |
volatile suggest | Suggest and lint volatile_fields. |
| Needs | Commands |
|---|---|
pikopod up running | status, accept, chaos, mode, webhook, sandbox requests, and the MCP control tools. ack works offline too. |
| A model key | scenario create, fix, and import from a docs URL that has no spec any other way. |
| A git repository | pr open, pr comment, fix --pr, and spec-diff with a git: source. |
| No config file at all | demo, spec-diff, pr comment, pr open. |