DocsOpen app

The docs

Find your topic

44 pages

Get started

4 pages

Work with agents

8 pages

Review and land

6 pages

Build and ship

4 pages

Self-host

3 pages

Administer

4 pages

Reference

3 pages

Technical docs

12 pages
33Technical docsAgent quick-startzuppo-axi speaks forge APIs; vcs-axi manages local git/jj work. Neither is MCP.34Technical docsSelf-host Zuppo (alpha)One binary serves git over HTTP and SSH, the API and the embedded UI. It also needs the pinned C git; Zoekt is optional.35Technical docsOperator runbook (alpha)Start with self-host installation. Commands act on the running instance via its local mode-0600 socket; use its OS account and exact state path.36Technical docsThe read-only standby and the game day (HOST-4)A correlated Cloudflare failure (risk K2, threat SEC-T15; 2025-06-12, 2025-11-18) takes the RepoDOs, R2 and the edge down together.37Technical docsReleases and the LTS line (HOST-5)The policy is plan DEP-9 (the upgrade policy), DEP-7 (the two profiles) and DEP-10 (the parity rule).38Technical docsGitHub App two-way sync (SYNC-3)A Zuppo repository and a GitHub repository kept equal both ways through a GitHub App.39Technical docsAPI reference overviewThe source contract is proto/zuppo/v1, described in proto/README.md. The generated OpenAPI 3.1 document is also served at /openapi.json.40Technical docsThe GitHub-shaped edge: /api/v3 and ghZuppo serves a named subset of GitHub's REST API under /api/v3, and the fixed GraphQL operations stock gh sends to /api/graphql, so gh and Octokit work against…41Technical docsAPI endpoints (generated)Generated from OpenAPI; see the overview. Regenerate with python3 scripts/doc-test.py --generate-index; --contract-only checks exact parity.42Technical docsCode search (zuppo-searchd)zuppo-searchd answers "where does this text occur in this repository at this commit" for the web UI, the API and agents (SRV-4; ARC-18, ARC-43; criterion PC13…43Technical docsThe SSH bridge and HTTP/3 downloads (EDGE-4)Workers take no raw TCP on port 22, so the cloud serves SSH through a bridge (F14, DEP-3): Cloudflare Spectrum accepts TCP 22 at the edge and forwards it to…44Technical docsThreat-model suite (POL-5)Acceptance (PLAN/lanes.json POL-5): every §10.3 threat has a failing-before / passing-after test.