Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.92 KB

File metadata and controls

40 lines (32 loc) · 1.92 KB
title Overview
description Every Gas City reference page — generated docs, hand-maintained references, specifications, and internals.

Reference material answers "what exactly is this?" — commands, config keys, APIs, formats, and contracts, stated precisely. Tutorials and guides teach; these pages are for looking things up.

Generated Docs

Regenerated from code by go run ./cmd/genschema and go run ./cmd/genspec (the pre-commit hook keeps them in sync) — edit the Go sources, never these pages.

Page Covers
CLI Reference Every gc command, flag, and example
Gas City Configuration The city.toml schema
Supervisor REST API The typed HTTP + SSE control plane
gc events Output Formats Exact output formats emitted by gc events
Schemas Downloadable machine-readable schema artifacts (OpenAPI, events, city/pack schemas)

Hand-Maintained References

Page Covers
Gas Town → Gas City Command Map The closest gc/bd equivalent for each gt command
System Packs Built-in packs bundled with gc
Command Execution Trust Boundaries Which component runs what, and with whose authority
Exec Session Provider The exec session runtime provider contract
Exec Beads Provider The exec beads backend contract
Tmux Agent Slice GC_AGENT_SLICE systemd scoping for tmux panes

Sibling Sections

  • Specifications — authoritative, normative specs for file formats and contracts (packs, formulas v1, formulas v2).
  • Internal — internals-grade reference for operators and contributors.