Use Reference to look up commands and flags, HTTP operations and permissions, request and response fields, PostgreSQL tables, and environment variables for the OpenClaw Control Plane (OCC).
- GitHub Actions: workflows, triggers, and blocking failures.
- API: public methods and what they do, by entity.
- Permissions: all IAM actions, resources, and access scopes.
- Database entities: PostgreSQL tables, their purpose, and their columns.
- Environment variables: variables by topic.
Use occ from a terminal to manage an Installation, Namespaces, Configurations,
and Agents. Start with CLI setup to install it, connect, and
make your first request. The command reference lists the available
commands, flags, and output formats.
Use the HTTP API from automation or when you need an operation the CLI does not expose. The HTTP API quickstart makes authenticated requests and explains the responses. Use the interactive API reference to inspect paths, schemas, permissions, error codes, and examples. The Markdown reference provides a text-only view for browsing and site search. Both use the generated OpenAPI contract. Follow create and deploy an Agent for the complete workflow.
The OCC metrics reference defines application and process metrics and the private listener configuration.
The auth binding defines the package interface and pool/schema ownership for controller authentication.
- Topics explains what product features do; Configuration and Installation settings cover supported configuration.
- Authentication and authorization explain which credentials and permissions requests need.
- Agent Presets defines reusable launch settings, variables, and CRUD permissions.
- Agent native admin UI covers trusted operator access, exact Agent authorization, and routing limits.
- Integrations covers named Drivers and Backends.
- Contribute covers development; see API generation checks when changing routes or schemas.