openclaw-enterprise README

The project's README from github.com/openclaw/openclaw-enterprise. As one markdown file: README.md.

OpenClaw Enterprise

OpenClaw Enterprise (OCE) is the open source, vendor neutral platform for managing agents. Think of it as Kubernetes for agents.

OpenClaw in a mech suit, the OpenClaw Enterprise mascot

OCE includes the OpenClaw Control Plane (OCC) for deploying and managing Agents. Start with Getting Started to use the platform, Operate to administer it, or Contribute to change its source.

Getting started

Choose Local Setup to run OCC on your machine, or Kubernetes Setup to install it on a cluster you already operate. For local setup, run from the repository root:

pnpm cli:build
export OCC_DEVELOPMENT_COMPUTE_DRIVER=kubernetes
export OCC_DEVELOPMENT_CONTROL_PLANE=kubernetes
export OCC_DEVELOPMENT_SANDBOX_DRIVER=none
./bin/occ dev up

This selects the Kubernetes-only profile for Agent deployment. With no profile selection, occ dev up starts a Compose control-plane preview that cannot deploy Agents.

You need Docker Engine or Podman, k3d, kubectl, Helm, Bash, Python 3, Go (the version in go.mod), Node.js 24 or newer, and the pnpm version in package.json. The quickstart covers installation checks, the local API credentials, and cleanup.

After local setup, deploy your first Agent and send it a model request. You need an OpenAI API key with access to the default model or your selected override for that step. If you installed on an existing cluster, deploy and verify an Agent on that installation.

Reuse settings with Agent Presets, then fill variables and review the copied draft in the console.

Develop

Follow Make your first platform change for setup, a small source edit, and focused verification. You need Node.js 24 or newer, the pnpm version pinned in package.json, and the Go version selected by go.mod.

Use the local checks for the current formatting, lint, type, CLI, and API commands; follow the contribution policy before opening a PR. Testing explains additional PostgreSQL, Docker/Podman, and Kubernetes setup; CI coverage distinguishes PR-safe checks from protected integrations.

Code layout

Path Responsibility
apps/controller/ HTTP API, browser console, worker, and Drivers.
packages/contracts/ Resource models, Driver interfaces, and API schemas.
packages/occ/ Resource lifecycle, persistence, and work queue.
packages/iam/ Identities, roles, and resource authorization.
packages/audit/ Audit events and sensitive-value sanitization.
cmd/occ/ Go entry point for the OCC domain CLI.
internal/occcli/ OCC resource commands and human or structured output.
internal/occclient/ Internal Go client that owns OCC transport and authentication.
packages/utils/ Shared validation, hashing, and object helpers.
tests/ Conformance and integration tests.

Documentation

Run npm run docs:install once, then npm run docs:dev to preview the docs at http://127.0.0.1:4173. Use npm run docs:build for the full static build. See the local preview instructions for setup and checks.

Contributors

Thanks to everyone contributing code, documentation, reviews, and ideas. See the full contributor graph and how to update recognition.

derekwaynecarr drew ericcaiwx-star freeqaz freeqaz-openai jacobtomlinson kevinlin-openai kevinslin Kimiyu-186 mrunalp natedemoss rclarke0 RomneyDa russellb sallyom sjenning steipete stevenlee-oai vincentkoc

License

MIT. Third-party components retain their own licenses.

openclaw-enterprise (openclaw/openclaw-enterprise)

Searching Database…

415 ·GitHub
Openclaw-enterprise
What is this?OpenClaw Enterprise (OCE) is an open-source, vendor-neutral control plane for deploying and managing AI agents, described by its authors as being like 'Kubernetes for agents'.
Is OCC a CLI tool, a web console, or both?It is both: a Go-based CLI (occ) for managing resources, plus an HTTP API and browser console served by the controller component.
How do I get OCC running?Run occ dev up from the repository root for local setup, using the Kubernetes-only profile to actually deploy Agents, or follow the Kubernetes Setup guide to install OCC on an existing cluster.
What do I need installed before running it?You need Docker Engine or Podman, k3d, kubectl, Helm, Bash, Python 3, the Go version pinned in go.mod, Node.js 24 or newer, and the pnpm version in package.json.
What happens if I run occ dev up without picking a profile?Without selecting the Kubernetes-only profile, occ dev up falls back to a Docker Compose control-plane preview that cannot actually deploy Agents.
What does the IAM package actually manage?packages/iam handles identities, roles, and resource authorization for the platform, while packages/audit records audit events and sanitizes sensitive values in logs.
How is the codebase organized?It's a monorepo split into apps/controller (API, console, worker, drivers), packages/ for shared contracts, resource lifecycle, IAM and audit logic, cmd/occ for the Go CLI entry point, and tests/ for conformance and integration tests.
Can I try it without owning a Kubernetes cluster?You can run occ dev up locally, but without the Kubernetes-only profile it only starts a Compose-based preview of the control plane that cannot deploy real Agents.
What do I need to make my first code change?You need Node.js 24+, the pnpm version pinned in package.json, and the Go version selected by go.mod, then run the local formatting, lint, type, CLI and API checks before opening a PR.
What are similar projects?ruflo, turnstone, evenfire, casdoor, trueforge, infisical, vcluster, zitadel
Which topics is it in?iam, authorization, k8s, audit-log, pnpm, rbac, infrastructure, cloud-native, enterprise, monorepo, ci, orchestration
Creator
openclaw
Size
90.1 MB
Stars
415
Updated
CommitOct 17
Age
1mo
Commits · 90 Days