LICENSE Documentation

1. Project Overview & Quickstart (openclaw/LICENSE) Copy Chapter

LICENSE

Open-source repository openclaw/LICENSE

Repository Details Copy Section

• Repository: openclaw/LICENSE
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (openclaw/docs) Copy Chapter

File: README.md Copy Chapter

openclaw-docs

Mirror repo for the published OpenClaw docs site.

Source of truth lives in openclaw/openclaw, under docs/.

How it works Copy Chapter

1. English docs are authored in openclaw/openclaw.
2. openclaw/openclaw/.github/workflows/docs-sync-publish.yml mirrors the docs tree into this repo.
3. This repo stores the published docs tree plus generated locale output.
4. openclaw/docs/.github/workflows/translate-incremental.yml debounces normal docs changes, while translate-all.yml handles full reconciliation for glossary changes, weekly schedule, release dispatch, or manual dispatch.
5. .github/workflows/r2-pages.yml builds the full unpruned static site and uploads changed objects to Cloudflare R2.
6. .github/workflows/pages.yml deploys the small Cloudflare Worker router that preserves clean URLs and markdown negotiation while reading docs from R2.

Translation behavior Copy Chapter

• Locale pages under docs/<locale>/** are generated output.
• Each translated page stores x-i18n.source_hash.
• The translate workflow computes a pending file list before calling the model.
• If no English source hashes changed, the workflow skips the expensive translation step entirely.
• If files changed, only the pending files are translated.
• The workflow retries transient model-format failures.
• Locale outputs are uploaded as artifacts first, then committed together by the finalizer.
• Incremental and full translation use separate concurrency lanes, so small docs edits do not cancel weekly or glossary-triggered full reconciliation.
• The weekly scheduled run uses full reconciliation mode to repair missed or flaky locale updates.

Editing rules Copy Chapter

• Do not treat this repo as the primary place for English doc edits.
• Make English doc changes in openclaw/openclaw, then let sync copy them here.
• Locale pages under docs/<locale>/** are generated output.
• .openclaw-sync/source.json records which openclaw/openclaw commit this mirror was synced from.

Static site build Copy Chapter

• npm run docs:build renders the mirrored Mintlify-flavored docs into dist/docs-site.
• npm run docs:build:cloudflare is the legacy Worker Static Assets fallback build.
• npm run docs:build:r2 renders the full unpruned site and prepares dist/docs-r2-manifest.json for R2 upload.
• npm run docs:r2:upload uploads only changed R2 objects, reports cache hits/misses, and refuses to turn a broken remote manifest read into a full-tree reupload.
• Manual R2 refreshes audit objects before upload; unchanged objects remain cache hits, and transient HEAD failures fall back to the signed manifest. R2_UPLOAD_PUT_ALL=1 is the emergency escape hatch for intentionally rewriting every object.
• npm run docs:smoke checks representative English and locale pages plus the Pagefind search bundle.
• npm run docs:check runs both steps.
• The generated site includes the language picker and static full-text search via Pagefind.
• Cloudflare deploys workers/docs-router.ts, which serves slashless page URLs, English markdown responses for .md paths or Accept: text/markdown, and /api/search through the DOCS_BUCKET R2 binding.
• Cloudflare hosting details and limitations are documented in CLOUDFLARE.md.

Secrets Copy Chapter

• OPENCLAW_DOCS_SYNC_TOKEN lives in openclaw/openclaw and lets the source repo push into this repo.
• OPENCLAW_DOCS_I18N_OPENAI_API_KEY lives in this repo and powers locale translation refreshes.
• CLOUDFLARE_API_TOKEN lives in this repo and deploys the docs.openclaw.ai router.
• R2 uploads verify CLOUDFLARE_API_TOKEN, try temporary R2 credentials, and normally fall back to the token-derived direct S3 credential form. OPENCLAW_R2_ACCESS_KEY_ID / OPENCLAW_R2_SECRET_ACCESS_KEY are only fallback upload credentials when the Cloudflare token cannot be verified.

File: docs/index.md Copy Chapter

summary: "OpenClaw is a multi-channel gateway for AI agents that runs on any OS."
read_when:

• Introducing OpenClaw to newcomers
  title: "OpenClaw"

OpenClaw 🦞

"EXFOLIATE! EXFOLIATE!" — A space lobster, probably

Browse docs Copy Chapter

Mobile browsers may show the section menu without the full desktop tab bar. Use
these hub links to reach the same top-level docs areas from the page body.

What is OpenClaw? Copy Chapter

OpenClaw is a self-hosted gateway that connects your favorite chat apps — Discord, Google Chat, iMessage, Matrix, Microsoft Teams, Signal, Slack, Telegram, WhatsApp, Zalo, and more via channel plugins — to AI coding agents. You run a single Gateway process on your own machine (or a server), and it becomes the bridge between your messaging apps and an always-available AI assistant.

Who is it for? Developers and power users who want a personal AI assistant they can message from anywhere — without giving up control of their data or relying on a hosted service.

What makes it different?

• Self-hosted: runs on your hardware, your rules
• Multi-channel: one Gateway serves every configured channel plugin simultaneously
• Agent-native: built for coding agents with tool use, sessions, memory, and multi-agent routing
• Open source: MIT licensed, community-driven

What do you need? Node 26 (recommended), or another supported release: Node 22.22.3+, Node 24.15+, or Node 25.9+. You also need an API key from your chosen provider and 5 minutes. For best quality and security, use the strongest latest-generation model available.

How it works Copy Chapter

flowchart LR
  A["Chat apps + plugins"] --> B["Gateway"]
  B --> C["OpenClaw agent"]
  B --> D["CLI"]
  B --> E["Web Control UI"]
  B --> F["macOS app"]
  B --> G["iOS and Android nodes"]

The Gateway is the single source of truth for sessions, routing, and channel connections.

Key capabilities Copy Chapter

Quick start Copy Chapter

```bash
npm install openclaw@latest --allow-scripts=openclaw
```

On npm 11.15 and earlier, omit `--allow-scripts=openclaw`.

```bash
openclaw dashboard
```

Or connect a channel ([Telegram](/channels/telegram) is fastest) and chat from your phone.

Need the full install and dev setup? See Getting Started.

Dashboard Copy Chapter

Open the browser Control UI after the Gateway starts.

• Local default: http://127.0.0.1:18789/
• Remote access: Web surfaces and Tailscale

Configuration (optional) Copy Chapter

Config lives at ~/.openclaw/openclaw.json.

• If you do nothing, OpenClaw uses the bundled OpenClaw agent runtime; DMs share the agent's main session, and each group chat gets its own session.
• If you want to lock it down, start with channels.whatsapp.allowFrom and (for groups) mention rules.

Example:

{
  channels: {
    whatsapp: {
      allowFrom: ["+15555550123"],
      groups: { "*": { requireMention: true } },
    },
  },
  messages: { groupChat: { mentionPatterns: ["@openclaw"] } },
}

Start here Copy Chapter

Learn more Copy Chapter