Skip to content

Reference

Every public surface of Fathom is documented here.

Most pages under this tab are generated from source — the SDK, REST, gRPC, MCP, CLI, and rule-pack references are rewritten by make docs-gen, so hand edits to them are overwritten on the next build. The YAML pages and Configuration are hand-written and cite the files they describe in their frontmatter.

Which of these surfaces the project promises to keep working is VERSIONING.md.

Deployment

  • Configuration — every FATHOM_* variable, gRPC TLS, and the server token scopes

SDKs

APIs

YAML

Tooling

Rule Packs