Skip to content

README.md

Latest commit

 

History

History
133 lines (106 loc) · 8.27 KB

README.md

File metadata and controls

133 lines (106 loc) · 8.27 KB
Raw

hotato docs

Find what broke in your agent calls. Pin it and CI stays red until you fix it. The loop: autopsy one recording (or scan a folder, or pull a platform's recent calls with vapi health), pin the incident as a portable failure check, and prove re-measures that stored evidence on every push, holding the build red until a fresh recording of the same moment clears it. This index maps every doc to the step it belongs to.

New here? Run hotato autopsy ./call.wav on one recording (AUTOPSY.md), or start with GETTING-STARTED.md. The whole loop on one page: LIFECYCLE.md.

The loop: find what broke, then pin it

  • AUTOPSY.md - autopsy, scan, and the <stack> health commands: one recording (or a folder, or your platform's recent calls) in, the incident list and health report out; pin graduates an incident
  • EVIDENCE-CONTRACT.md - the four-tier evidence policy: what every verdict stands on
  • CONTRACTS.md - failure contracts: a portable CI bundle of one call moment
  • CI.md - prove and the CI gate: fail the pull request on the pinned evidence, offline
  • GETTING-STARTED.md - one path from first touch to a CI gate
  • START.md - guided first run on the bundled demo data
  • WHY.md - four timing failures a text-level eval cannot see

Continuous use

  • CONNECT.md - store a stack's credentials once; feed every hotato command from your platform
  • ADAPTER-STATUS.md - per-stack pull, endpoint, and channel-separation status
  • PRODUCTION-MONITORING.md - turn production call events into offline regression candidates
  • WORKSPACE.md - hotato serve and hotato console: the self-hosted team web workspace and the live call console
  • SELF-HOST.md - run the full workspace in your own VPC

Working with audio

Reference

  • API.md - the stdlib-only scoring core, Python API
  • SDK.md - the typed Python SDK facade over the CLI
  • MCP.md - the hotato MCP server and its tools, over stdio
  • METHODOLOGY.md - how the timing measurement works, end to end
  • THREAT-MODEL.md - which commands are offline, which reach the network
  • EGRESS.md - every network call site mapped to its command
  • VALIDATION.md - the three separate jobs hotato is validated on
  • EVIDENCE-PACK.md - the reproducible proof artifacts, ranked
  • GALLERY.md - every image and worked example, each reproducible
  • COMPARE.md - where hotato sits next to broad QA platforms
  • evidence/README.md - the evidence standard: what counts, and ranking
  • case-studies/README.md - the honesty standard every case study meets

Lab: the deep toolkit

Every command in this section lives under hotato lab (hotato lab --help). The public commands are durable. hotato lab moves faster, and every command name that worked before 1.17 still runs unchanged.

Investigate and evaluate

Observe

  • OBSERVE.md - LLM and voice observability from your OpenTelemetry spans, locally
  • TRACE.md - voice traces: the pipeline-event timeline
  • OTEL.md - ingest OTel traces into the voice_trace span format
  • latency-waterfall.md - per-hop latency waterfall from a scored call

Test and simulate

Fix and gate, the long way

Pipe your stack in

Fleet, reports, and benchmarks

Contributing

See also the repository CONTRIBUTING.md, SECURITY.md, and CHANGELOG.md.