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…

这是什么?OpenClaw Enterprise(OCE)是一个开源、厂商中立的 AI 智能体部署与管理控制平面,作者将其形容为“智能体界的 Kubernetes”。
OCC 是命令行工具、网页控制台,还是两者都是?两者都是:一个基于 Go 的命令行工具(occ)用于管理资源,加上由控制器组件提供的 HTTP API 和浏览器控制台。
怎么让 OCC 跑起来?在仓库根目录运行 occ dev up 做本地设置,要用 Kubernetes-only 配置才能真正部署 Agent;或者按照 Kubernetes 安装指南把 OCC 装到现有集群上。
运行前我需要装好哪些东西?你需要 Docker Engine 或 Podman、k3d、kubectl、Helm、Bash、Python 3、go.mod 锁定的 Go 版本、Node.js 24 或更新版本,以及 package.json 里指定的 pnpm 版本。
如果运行 occ dev up 时不选配置档会怎样?如果不选 Kubernetes-only 配置档,occ dev up 会退回到 Docker Compose 的控制平面预览模式,无法真正部署 Agent。
IAM 包实际管理什么?packages/iam 负责平台的身份、角色和资源授权,而 packages/audit 记录审计事件并清理日志中的敏感值。
代码库是怎么组织的?这是一个 monorepo,分为 apps/controller(API、控制台、worker、驱动)、packages/(共享契约、资源生命周期、IAM 和审计逻辑)、cmd/occ(Go 命令行入口)和 tests/(一致性测试和集成测试)。
我没有 Kubernetes 集群也能试用吗?你可以在本地运行 occ dev up,但不选 Kubernetes-only 配置档的话,它只会启动一个基于 Compose 的控制平面预览,无法部署真正的 Agent。
做第一次代码修改需要什么?你需要 Node.js 24+、package.json 锁定的 pnpm 版本和 go.mod 选定的 Go 版本,然后在提交 PR 之前运行本地格式化、lint、类型、CLI 和 API 检查。
Creator
openclaw
Size
92.2 MB
Stars
415
Updated
CommitOct 18
Age
1mo
Commits · 90 Days