All apps · 0 apps
OpenClaw
OfficialDocker app from Selfhosters
Overview
Readme
View on GitHubOpenClaw 🦞 — Your assistant, on your devices, in your chats
OpenClaw is an AI assistant that runs on your devices and meets you in the channels you already use. It connects models, tools, messaging channels, and optional companion apps through one Gateway, for a single operator or for a team whose members trust each other: the same gateway runs as a personal assistant on one laptop or as a shared team deployment, and configuration is the only difference. The architecture case — trusted gateway, untrusted execution, deterministic policy — is in Why OpenClaw.
Website · Docs · Getting started · Why OpenClaw · Showcase · FAQ · Vision · DeepWiki
Install
The installer supports macOS, Linux, and Windows. It provisions a supported Node.js runtime when needed.
# macOS / Linux / WSL2
curl -fsSL https://openclaw.ai/install.sh | bash
# Windows PowerShell
iwr -useb https://openclaw.ai/install.ps1 | iex
Already manage Node.js? Install the published package instead (Node 22.22.3+, 24.15+, or 25.9+):
npm install -g openclaw@latest --allow-scripts=openclaw
That command is for npm 12 or npm 11.16+. On npm 11.15 and earlier, omit
--allow-scripts=openclaw. See the
installation guide for the lifecycle script
contract, Docker, Nix, and other deployment paths.
Quick start
On a fresh install, the installer scripts start onboarding automatically. Complete the wizard they open. If you installed the package directly with npm, pnpm, or Bun, run:
openclaw onboard --install-daemon
After onboarding:
openclaw gateway status
openclaw dashboard
Onboarding verifies model access, creates the workspace, and configures the Gateway. The last command opens the Control UI; send a message there to confirm the assistant is working. See the getting started guide for channel setup and troubleshooting.
How it fits together
- The Gateway is the local control plane for sessions, tools, events, and channel connections.
- The Control UI, CLI, and TUI connect to the Gateway.
- Channels bring the assistant to WhatsApp, Telegram, Slack, Discord, Google Chat, Signal, iMessage, and other messaging services.
- Companion apps and nodes add voice, Canvas, camera, screen, and device-local actions on supported platforms.
OpenClaw works with hosted and local model providers. Its tools, skills, and plugins extend what an assistant can do.
Security
Treat inbound messages as untrusted input. DM-capable channels pair unknown senders by default; approve a pairing request with openclaw pairing approve <channel> <code>.
Tools run on the host for the main session unless you configure sandboxing. Read the security guide, exposure runbook, and sandboxing guide before connecting other users or exposing the Gateway remotely.
Documentation
| Goal | Start here |
|---|---|
| Configure models and auth | Models · Model providers |
| Connect a messaging service | Channels |
| Add tools, skills, and plugins | Tools · Skills · Plugins · ClawHub |
| Run apps and device nodes | Platforms · Nodes |
| Use the CLI and chat commands | CLI reference · Slash commands |
| Configure or operate the Gateway | Configuration · Architecture · Updating · Release channels |
Development
The repository is a pnpm workspace. Plain npm install at the repository root is not supported.
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install
pnpm build
pnpm ui:build
See CONTRIBUTING.md for the contribution workflow and the source setup guide for the development loop.
Community
OpenClaw is developed in the open by the OpenClaw Foundation, a non-profit. See CONTRIBUTING.md for maintainers and contribution guidelines; AI-assisted PRs are welcome.
Use the issue chooser for bugs and feature requests, ask setup questions in Discord, and report vulnerabilities through SECURITY.md. New capabilities usually belong in plugins built on the plugin SDK and shared through ClawHub.
OpenClaw was built for Molty, a space lobster AI assistant, by Peter Steinberger and the community. Explore the project lore, soul.md, Peter's site, Star History, and @openclaw.
Special thanks to Mario Zechner for his support and for pi, and to Adam Doppelt for the lobster.bot domain.
Sponsors
Contributors
Thanks to all clawtributors:
License
MIT © OpenClaw Foundation. See THIRD_PARTY_NOTICES.md for incorporated or adapted code.
Media gallery
Install OpenClaw on Unraid in a few clicks.
Find OpenClaw in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Categories
Download Statistics
Related apps
Explore more like this
Explore allDetails
ghcr.io/openclaw/openclaw:latestRuntime arguments
- Web UI
http://[IP]:[PORT:18789]/- Network
bridge- Shell
sh- Privileged
- false
- Extra Params
--user root --hostname OpenClaw
Template configuration
Port for Control UI and Gateway API. Access at http://IP:18789/?token=YOUR_TOKEN
- Target
- 18789
- Default
- 18789
- Value
- 18789
Path to store OpenClaw configuration files, sessions, and credentials
- Target
- /root/.openclaw
- Default
- /mnt/user/appdata/openclaw/config
- Value
- /mnt/user/appdata/openclaw/config
Path for agent workspace (files, memory, AGENTS.md, projects)
- Target
- /home/node/clawd
- Default
- /mnt/user/appdata/openclaw/workspace
- Value
- /mnt/user/appdata/openclaw/workspace
Optional additional path for coding projects
- Target
- /projects
- Default
- /mnt/user/appdata/openclaw/projects
- Value
- /mnt/user/appdata/openclaw/projects
Persistent storage for Homebrew packages. If you install Homebrew manually via console, this mount ensures it persists across restarts.
- Target
- /home/linuxbrew/.linuxbrew
- Default
- /mnt/user/appdata/openclaw/homebrew
- Value
- /mnt/user/appdata/openclaw/homebrew
Secret token for authentication. Generate with: openssl rand -hex 24 (or use any secret value). Required to access the Control UI.
- Target
- OPENCLAW_GATEWAY_TOKEN
API key for Claude models (recommended). Get from console.anthropic.com
- Target
- ANTHROPIC_API_KEY
API key for GPT models. Get from platform.openai.com
- Target
- OPENAI_API_KEY
API key for OpenRouter - access 100+ models. Get from openrouter.ai
- Target
- OPENROUTER_API_KEY
API key for Google Gemini models. Get from aistudio.google.com
- Target
- GEMINI_API_KEY
API key for Groq (fast Llama/Mixtral inference). Get from console.groq.com
- Target
- GROQ_API_KEY
API key for xAI Grok models. Get from console.x.ai
- Target
- XAI_API_KEY
API key for Z.AI/Zhipu GLM models. Get from z.ai/model-api
- Target
- ZAI_API_KEY
(Advanced) GitHub Copilot OAuth token. Requires running 'openclaw models auth login-github-copilot' on another machine first.
- Target
- COPILOT_GITHUB_TOKEN
(Optional) Discord bot token for Discord integration. Can also configure via Control UI after install.
- Target
- DISCORD_BOT_TOKEN
(Optional) Telegram bot token from @BotFather. Can also configure via Control UI after install.
- Target
- TELEGRAM_BOT_TOKEN
Internal gateway port. Change if 18789 is already in use (must match Control UI Port).
- Target
- OPENCLAW_GATEWAY_PORT
- Default
- 18789
- Value
- 18789
System PATH including Homebrew. Do not modify unless you know what you're doing.
- Default
- /home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin:/root/.bun/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
- Value
- /home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin:/root/.bun/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
(Optional) Brave Search API key for web search. Free tier: 2000 queries/month at brave.com/search/api
- Target
- BRAVE_API_KEY