Agent-Friendly Docs
General Augment publishes plain-text documentation for coding agents that need product, API, CLI, and integration context without scraping the rendered site.
Entrypoints
Section titled “Entrypoints”/llms.txt: short canonical index./llms-full.txt: concatenated source for deeper implementation context./markdown/...: page-level Markdown exports.- One-prompt coding-agent handoff.
- Generated OpenAPI reference.
Exact defaults
Section titled “Exact defaults”- Product: General Augment.
- CLI:
genaug. - Project source:
genaug-agent.yamlwithapiVersion: genaug/v3. - Runtime API:
POST /v1/responses. - Production API:
https://api.generalaugment.com. - Dashboard:
https://app.generalaugment.com. - Runtime: Hermes only.
Coding-agent contract
Section titled “Coding-agent contract”- Inspect the app and classify new-app, add-Agent, or replace-Agent.
- Preserve its UI, auth, authorization, data, billing, business logic, package manager, and deployment shape.
- Use
genaug launch --plan --json, then commit the same framework-neutral contract with--wait --json. - Keep
GENAUG_API_KEYserver-only. Never request or exposeGENAUG_ADMIN_API_KEY. - Define capabilities, credentials, memory namespaces, connections, and runtime keys once per Project. Give each Agent exact grants and its own SOUL and Skills.
- Wire browser/mobile code to the app backend; wire the app backend to
POST /v1/responseswith the stable Agent and server-authenticated user. - Preserve app-owned authorization for every direct tool and write.
- Run focused app checks and
genaug agent test <agent> --user <user> --json. - Require hosted evidence tied to the exact Candidate, Agent, and user. Never submit a local evidence file.
- Return exact receipts, fingerprints, run evidence, blockers, and dashboard review URL. Stop before Live promotion.
The dashboard and CLI operate the same server-versioned Project desired state. Coding agents may create and test Candidates; only a freshly authenticated Workspace owner/admin can move Live.