Platform developer guide
Use this guide to change OpenClaw Enterprise: the control plane, console, CLI, Drivers, deployment packaging, or documentation. For a first code change, start with Local development and the first-change walkthrough. To use or administer an installation, start with Getting Started.
To schedule work, follow Add issues to a sprint to create tasks or assign existing issues to a two-week iteration in the project.
Find the code and its design
- Design links the platform architecture, remaining design work, and source-backed implementation guides.
- The RFC guide explains how to propose architectural changes and request feedback; start with the RFC template.
- RFCs and implementation plans explains document choice, numbering, delivery tracking, and the repository-local spec skill.
- Design philosophy guides interface, ownership, and lifecycle decisions; Readable code works through the practical choices with one example.
- Repository layout shows who owns each directory and where to put code, tests, and documentation.
- Module boundaries explains import rules, dependency cycle checks, and policy exceptions.
- Driver development links the base interfaces for building or changing a Driver.
Build, test, and debug
Use Testing & CI for local checks, integration setup, and the scenarios and results for each CI check.
- oce-cookbook provides maintenance
recipes only when deliberately invoked. Start with
$oce-cookbook update-openclaw-pin <ref>to update the source pin and qualify its images. - Local development covers the checkout, a running local platform, and how to choose checks for your change.
- Console components and styles shows how to build a page with the shared controls, typography, and layout.
- Console Storybook lets you inspect console pages, states, and Agent flows with simulated API responses; its Agent workflows walk through each Agent story.
- Runtime flows helps you trace requests, worker operations, and Agent deployment in the source.
- Documentation explains where pages belong, how to name them, and how to build and check the site.
- Documentation hosting covers private publication, the custom domain, and the approval required to enable public access.
Release
Use the release guides to configure publication workflows and publish containers, Helm charts, and OCC CLI binaries.
Read the contribution policy before opening a pull request. It covers repository access, verification, review, and private security reporting.
