<div align="center">
<a href="https://www.openui.com/openclaw-os" target="_blank" rel="noopener noreferrer">
<img src="./assets/openclaw-os-hero.png" alt="OpenClaw OS — the workspace for OpenClaw" width="100%">
</a>
# OpenClaw OS — The default workspace for OpenClaw
[](https://github.com/thesysdev/openclaw-os/actions/workflows/build.yml)
[](./LICENSE)
[](https://discord.com/invite/Pbv5PsqUSv)
</div>
OpenClaw reads emails, manages files, runs scripts, and schedules work across tools. But people drive it from Telegram, Discord, or Slack. Chat falls apart fast: everything scrolls away, work gets buried, and you can't see what's running or done.
**OpenClaw-OS** is the missing interface. A workspace built for your agents. Sessions stay organized. Answers render as live, interactive apps (charts, tables, forms, dashboards) that persist, refresh with new data, and update from a prompt instead of a rebuild.
---
[Website](https://openui.com/openclaw-os) · [OpenUI Docs](https://openui.com) · [OpenClaw](https://github.com/openclaw/openclaw) · [Discord](https://discord.com/invite/Pbv5PsqUSv) · [Contributing](./CONTRIBUTING.md) · [Code of Conduct](./CODE_OF_CONDUCT.md) · [Security](./SECURITY.md) · [License](./LICENSE)
---
## Quick Start
Install OpenClaw OS into an existing OpenClaw setup with the command for your platform:
macOS or Linux:
```bash
curl -fsSL https://openui.com/openclaw-os/install.sh | bash
```
Windows:
```powershell
powershell -c "irm https://openui.com/openclaw-os/install.ps1 | iex"
```
The installer downloads the latest source, builds the workspace UI, registers it as an OpenClaw plugin, restarts the gateway, and opens the dashboard in your browser.
or through published package
```bash
openclaw plugins install @openuidev/openclaw-os-plugin
openclaw gateway restart
openclaw os url
```
> The workspace runs at `http://localhost:18789/plugins/openclawos`; run **`openclaw os url`** for the pre-authenticated URL.
>
> Don't have OpenClaw yet? Install it first from [openclaw.ai](https://openclaw.ai/install.sh), then run the matching command above.
>
> Installing from a local clone: see [`CONTRIBUTING.md`](./CONTRIBUTING.md).
---
## What you get
- **A workspace, not a chat log.** Agents, sessions, apps, artifacts, notifications, and crons are all first-class surfaces in the sidebar — structured and easy to navigate.
- **Live, interactive apps.** Agents render dashboards, charts, tables, and forms as React components that stream in as the model writes them. No copy-pasting JSON, no re-prompting for the same data.
- **Persistent and refinable.** Apps and artifacts are stored and re-rendered across turns. Update them with a prompt — they update in place instead of being regenerated from scratch.
- **Mobile + desktop.** Responsive UI; the same workspace works on your laptop, phone, or tablet.
- **Lives with your gateway.** The workspace is served by your OpenClaw gateway itself. If your gateway is remote, the workspace is reachable wherever the gateway is — no separate hosting, no tunnel, no CORS or allowed-origins config.
- **Session-scoped.** Only sessions opened from OpenClaw OS get the OpenUI prompt. CLI runs, scripts, and other clients on the same gateway are unaffected.
---
## How it works
OpenClaw OS ships as a single OpenClaw plugin. When the gateway loads it, two things happen:
1. **The workspace UI is served from the gateway** at `http://<gateway>/plugins/openclawos`. The plugin bundles the prebuilt static export of the web client and serves it over the gateway's own HTTP route — no separate Next.js process, no tunnel, no CORS dance.
2. **Agent runs from OpenClaw OS get an OpenUI prompt.** A `before_prompt_build` hook detects sessions originating from the workspace (by session-key suffix) and prepends an OpenUI Lang system prompt, so the LLM emits structured component markup the workspace can render.
The workspace then connects back to the same gateway over the same-origin WebSocket and renders the streaming output as live React components.
```mermaid
flowchart LR
U["You"] -->|"open /plugins/openclawos"| G["OpenClaw Gateway"]
G -->|"serves bundled UI"| W["OpenClaw OS workspace"]
W -->|"WebSocket"| G
G --> A["OpenClaw Agent"]
A -->|"OpenUI Lang stream"| W
W --> R["Live apps, dashboards, charts"]
```
See [`AGENTS.md`](./AGENTS.md) for the full protocol, the plugin detection mechanism, and the agent / session / thread mental model.
---
## Packages
| Package | Description |
| :--- | :--- |
| [`@openuidev/openclaw-os-plugin`](./packages/claw-plugin) | The OpenClaw plugin. Bundles the workspace UI, serves it over the gateway's HTTP route, and injects the OpenUI prompt for OpenClaw OS sessions. |
| [`@openuidev/claw-client`](./packages/claw-client) | The workspace UI itself — a Next.js app rendered with the OpenUI React renderer. Statically exported, then bundled into the plugin. |
Both packages live in this monorepo and are linked via pnpm workspaces. They are versioned together for now.
---
## Repository structure
```
openclaw-os/
├── packages/
│ ├── claw-client/ # Workspace UI (Next.js, statically exported)
│ └── claw-plugin/ # OpenClaw plugin (bundles + serves the UI)
├── scripts/ # Local helpers (open dashboard, etc.)
├── .github/ # CI workflows + issue / PR templates
├── AGENTS.md # Protocol and mental-model deep dive
├── CONTRIBUTING.md # Development workflow
└── README.md # You are here
```
Good places to start:
- [`packages/claw-client`](./packages/claw-client) — the workspace UI
- [`packages/claw-plugin`](./packages/claw-plugin) — the plugin that ships and serves it
- [`AGENTS.md`](./AGENTS.md) — gateway protocol & session model
- [`CONTRIBUTING.md`](./CONTRIBUTING.md) — local setup, code style, PR workflow
---
## Scripts
Run from the repo root — every script fans out across the workspace.
```bash
pnpm build # build every package
pnpm lint # ESLint check across packages
pnpm lint:fix # ESLint auto-fix
pnpm format # Prettier check
pnpm format:fix # Prettier write
pnpm typecheck # tsc --noEmit across packages
pnpm test # Vitest across packages
pnpm ci # full lint + format + typecheck + build (matches CI)
```
---
## Powered by OpenUI
The workspace renders agent output using [OpenUI](https://openui.com), an open standard for generative UI. Agents emit OpenUI Lang — a structured, streamable language designed for model-generated UI:
- **Streaming output** — components render incrementally as tokens arrive.
- **Token efficient** — up to 67% fewer tokens than equivalent JSON.
- **Controlled rendering** — agents can only emit the components defined in the workspace's library.
- **Typed component contracts** — props are declared up front with Zod schemas.
See the [OpenUI documentation](https://openui.com) and [token efficiency benchmarks](https://github.com/thesysdev/openui#token-efficiency-benchmarks) for details.
---
## Documentation
- [openui.com/openclaw-os](https://openui.com/openclaw-os) — landing page, demos, install
- [openui.com](https://openui.com) — OpenUI Lang reference, component library, and renderer docs
- [`AGENTS.md`](./AGENTS.md) — OpenClaw protocol, plugin detection, session model
- [`packages/claw-client/README.md`](./packages/claw-client/README.md) — workspace UI: local dev, env, layout
- [`packages/claw-plugin/README.md`](./packages/claw-plugin/README.md) — plugin: install, prompt regeneration
---
## Community
- [Discord](https://discord.com/invite/Pbv5PsqUSv) — Ask questions, share what you're building
- [GitHub Issues](https://github.com/thesysdev/openclaw-os/issues) — Report bugs or request features
- [GitHub Discussions](https://github.com/thesysdev/openclaw-os/discussions) — Longer-form questions and ideas
---
## Contributing
Contributions are welcome. See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the local setup, the code-style rules, and the pull request workflow.
## License
This project is available under the terms described in [`LICENSE`](./LICENSE).