Skip to content

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.

  • Product: General Augment.
  • CLI: genaug.
  • Project source: genaug-agent.yaml with apiVersion: genaug/v3.
  • Runtime API: POST /v1/responses.
  • Production API: https://api.generalaugment.com.
  • Dashboard: https://app.generalaugment.com.
  • Runtime: Hermes only.
  1. Inspect the app and classify new-app, add-Agent, or replace-Agent.
  2. Preserve its UI, auth, authorization, data, billing, business logic, package manager, and deployment shape.
  3. Use genaug launch --plan --json, then commit the same framework-neutral contract with --wait --json.
  4. Keep GENAUG_API_KEY server-only. Never request or expose GENAUG_ADMIN_API_KEY.
  5. Define capabilities, credentials, memory namespaces, connections, and runtime keys once per Project. Give each Agent exact grants and its own SOUL and Skills.
  6. Wire browser/mobile code to the app backend; wire the app backend to POST /v1/responses with the stable Agent and server-authenticated user.
  7. Preserve app-owned authorization for every direct tool and write.
  8. Run focused app checks and genaug agent test <agent> --user <user> --json.
  9. Require hosted evidence tied to the exact Candidate, Agent, and user. Never submit a local evidence file.
  10. 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.