OpenClaw EnterpriseDOCSGitHub

Base Driver documentation template

When writing or rewriting a base Driver contract, use the repository-owned Driver contract Markdown template. It starts with kind: reference/driver. See the documentation taxonomy for the scope of this kind.

The required sections are Overview, Interface, IAM, Lifecycle, Limits, Troubleshooting, Implementations, and Related. Interface lists properties first and methods second. Each table lists required members before optional members. Use only Required or Optional in the Requirement column. Describe the effect of an omitted member in its behavior or value column. IAM describes authorization, identity scope, and credential boundaries. Lifecycle uses a Mermaid sequence diagram to show the calls in order. See the Sandbox lifecycle for an example.

Start with Driver development to find the existing base contract. Base contracts belong in docs/reference/drivers/<capability>.md; backend configuration, setup commands, and backend-specific troubleshooting remain in implementation references. See the ComputeDriver contract for an applied example.

Search documentation