klaus Documents

Documentation index for klaus, the API verification CLI.

Getting Started

• Getting Started — from installation to running your first flow

Guides

• Generating Flows from OpenAPI — bootstrap flow definition YAML files from an OpenAPI 3.x spec
• record / replay mode — verify flows against a recorded cassette instead of the live network
• localhost UI — how to use klaus ui, and its security model
• Agent Skill (Claude Code / Codex) — teach an AI coding agent klaus's workflow via a bundled Agent Skill
• Troubleshooting — real error messages klaus prints, with their cause and fix

Reference

• CLI Reference — all options for klaus run / klaus ui, the exit code scheme, and output modes
• Flow Definition Reference — the complete YAML reference (request / GraphQL / WebSocket / SSE / templates / capture / assert)
• Default CLI options (klaus.config.yaml) — set project-wide defaults for CLI options
• Execution History — the schema and versioning contract for .klaus/history/*.jsonl