Selig
4c966a3ad2
6 custom skills (assign-task, dispatch-webhook, daily-briefing, task-capture, qmd-brain, tts-voice) with technical documentation. Compatible with Claude Code, OpenClaw, Codex CLI, and OpenCode.
127 lines
12 KiB
JSON
Executable File
127 lines
12 KiB
JSON
Executable File
{
|
||
"title": "Getting Started",
|
||
"content": "Goal: go from **zero** → **first working chat** (with sane defaults) as quickly as possible.\n\nFastest chat: open the Control UI (no channel setup needed). Run `openclaw dashboard`\nand chat in the browser, or open `http://127.0.0.1:18789/` on the gateway host.\nDocs: [Dashboard](/web/dashboard) and [Control UI](/web/control-ui).\n\nRecommended path: use the **CLI onboarding wizard** (`openclaw onboard`). It sets up:\n\n* model/auth (OAuth recommended)\n* gateway settings\n* channels (WhatsApp/Telegram/Discord/Mattermost (plugin)/...)\n* pairing defaults (secure DMs)\n* workspace bootstrap + skills\n* optional background service\n\nIf you want the deeper reference pages, jump to: [Wizard](/start/wizard), [Setup](/start/setup), [Pairing](/start/pairing), [Security](/gateway/security).\n\nSandboxing note: `agents.defaults.sandbox.mode: \"non-main\"` uses `session.mainKey` (default `\"main\"`),\nso group/channel sessions are sandboxed. If you want the main agent to always\nrun on host, set an explicit per-agent override:\n\n* Node `>=22`\n* `pnpm` (optional; recommended if you build from source)\n* **Recommended:** Brave Search API key for web search. Easiest path:\n `openclaw configure --section web` (stores `tools.web.search.apiKey`).\n See [Web tools](/tools/web).\n\nmacOS: if you plan to build the apps, install Xcode / CLT. For the CLI + gateway only, Node is enough.\nWindows: use **WSL2** (Ubuntu recommended). WSL2 is strongly recommended; native Windows is untested, more problematic, and has poorer tool compatibility. Install WSL2 first, then run the Linux steps inside WSL. See [Windows (WSL2)](/platforms/windows).\n\n## 1) Install the CLI (recommended)\n\nInstaller options (install method, non-interactive, from GitHub): [Install](/install).\n\nWindows (PowerShell):\n\nAlternative (global install):\n\n## 2) Run the onboarding wizard (and install the service)\n\n* **Local vs Remote** gateway\n* **Auth**: OpenAI Code (Codex) subscription (OAuth) or API keys. For Anthropic we recommend an API key; `claude setup-token` is also supported.\n* **Providers**: WhatsApp QR login, Telegram/Discord bot tokens, Mattermost plugin tokens, etc.\n* **Daemon**: background install (launchd/systemd; WSL2 uses systemd)\n * **Runtime**: Node (recommended; required for WhatsApp/Telegram). Bun is **not recommended**.\n* **Gateway token**: the wizard generates one by default (even on loopback) and stores it in `gateway.auth.token`.\n\nWizard doc: [Wizard](/start/wizard)\n\n### Auth: where it lives (important)\n\n* **Recommended Anthropic path:** set an API key (wizard can store it for service use). `claude setup-token` is also supported if you want to reuse Claude Code credentials.\n\n* OAuth credentials (legacy import): `~/.openclaw/credentials/oauth.json`\n\n* Auth profiles (OAuth + API keys): `~/.openclaw/agents/<agentId>/agent/auth-profiles.json`\n\nHeadless/server tip: do OAuth on a normal machine first, then copy `oauth.json` to the gateway host.\n\n## 3) Start the Gateway\n\nIf you installed the service during onboarding, the Gateway should already be running:\n\nManual run (foreground):\n\nDashboard (local loopback): `http://127.0.0.1:18789/`\nIf a token is configured, paste it into the Control UI settings (stored as `connect.params.auth.token`).\n\n⚠️ **Bun warning (WhatsApp + Telegram):** Bun has known issues with these\nchannels. If you use WhatsApp or Telegram, run the Gateway with **Node**.\n\n## 3.5) Quick verify (2 min)\n\n## 4) Pair + connect your first chat surface\n\n### WhatsApp (QR login)\n\nScan via WhatsApp → Settings → Linked Devices.\n\nWhatsApp doc: [WhatsApp](/channels/whatsapp)\n\n### Telegram / Discord / others\n\nThe wizard can write tokens/config for you. If you prefer manual config, start with:\n\n* Telegram: [Telegram](/channels/telegram)\n* Discord: [Discord](/channels/discord)\n* Mattermost (plugin): [Mattermost](/channels/mattermost)\n\n**Telegram DM tip:** your first DM returns a pairing code. Approve it (see next step) or the bot won’t respond.\n\n## 5) DM safety (pairing approvals)\n\nDefault posture: unknown DMs get a short code and messages are not processed until approved.\nIf your first DM gets no reply, approve the pairing:\n\nPairing doc: [Pairing](/start/pairing)\n\n## From source (development)\n\nIf you’re hacking on OpenClaw itself, run from source:\n\nIf you don’t have a global install yet, run the onboarding step via `pnpm openclaw ...` from the repo.\n`pnpm build` also bundles A2UI assets; if you need to run just that step, use `pnpm canvas:a2ui:bundle`.\n\nGateway (from this repo):\n\n## 7) Verify end-to-end\n\nIn a new terminal, send a test message:\n\nIf `openclaw health` shows “no auth configured”, go back to the wizard and set OAuth/key auth — the agent won’t be able to respond without it.\n\nTip: `openclaw status --all` is the best pasteable, read-only debug report.\nHealth probes: `openclaw health` (or `openclaw status --deep`) asks the running gateway for a health snapshot.\n\n## Next steps (optional, but great)\n\n* macOS menu bar app + voice wake: [macOS app](/platforms/macos)\n* iOS/Android nodes (Canvas/camera/voice): [Nodes](/nodes)\n* Remote access (SSH tunnel / Tailscale Serve): [Remote access](/gateway/remote) and [Tailscale](/gateway/tailscale)\n* Always-on / VPN setups: [Remote access](/gateway/remote), [exe.dev](/platforms/exe-dev), [Hetzner](/platforms/hetzner), [macOS remote](/platforms/mac/remote)",
|
||
"code_samples": [
|
||
{
|
||
"code": "## 0) Prereqs\n\n* Node `>=22`\n* `pnpm` (optional; recommended if you build from source)\n* **Recommended:** Brave Search API key for web search. Easiest path:\n `openclaw configure --section web` (stores `tools.web.search.apiKey`).\n See [Web tools](/tools/web).\n\nmacOS: if you plan to build the apps, install Xcode / CLT. For the CLI + gateway only, Node is enough.\nWindows: use **WSL2** (Ubuntu recommended). WSL2 is strongly recommended; native Windows is untested, more problematic, and has poorer tool compatibility. Install WSL2 first, then run the Linux steps inside WSL. See [Windows (WSL2)](/platforms/windows).\n\n## 1) Install the CLI (recommended)",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "Installer options (install method, non-interactive, from GitHub): [Install](/install).\n\nWindows (PowerShell):",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "Alternative (global install):",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "## 2) Run the onboarding wizard (and install the service)",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "What you’ll choose:\n\n* **Local vs Remote** gateway\n* **Auth**: OpenAI Code (Codex) subscription (OAuth) or API keys. For Anthropic we recommend an API key; `claude setup-token` is also supported.\n* **Providers**: WhatsApp QR login, Telegram/Discord bot tokens, Mattermost plugin tokens, etc.\n* **Daemon**: background install (launchd/systemd; WSL2 uses systemd)\n * **Runtime**: Node (recommended; required for WhatsApp/Telegram). Bun is **not recommended**.\n* **Gateway token**: the wizard generates one by default (even on loopback) and stores it in `gateway.auth.token`.\n\nWizard doc: [Wizard](/start/wizard)\n\n### Auth: where it lives (important)\n\n* **Recommended Anthropic path:** set an API key (wizard can store it for service use). `claude setup-token` is also supported if you want to reuse Claude Code credentials.\n\n* OAuth credentials (legacy import): `~/.openclaw/credentials/oauth.json`\n\n* Auth profiles (OAuth + API keys): `~/.openclaw/agents/<agentId>/agent/auth-profiles.json`\n\nHeadless/server tip: do OAuth on a normal machine first, then copy `oauth.json` to the gateway host.\n\n## 3) Start the Gateway\n\nIf you installed the service during onboarding, the Gateway should already be running:",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "Manual run (foreground):",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "Dashboard (local loopback): `http://127.0.0.1:18789/`\nIf a token is configured, paste it into the Control UI settings (stored as `connect.params.auth.token`).\n\n⚠️ **Bun warning (WhatsApp + Telegram):** Bun has known issues with these\nchannels. If you use WhatsApp or Telegram, run the Gateway with **Node**.\n\n## 3.5) Quick verify (2 min)",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "## 4) Pair + connect your first chat surface\n\n### WhatsApp (QR login)",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "Scan via WhatsApp → Settings → Linked Devices.\n\nWhatsApp doc: [WhatsApp](/channels/whatsapp)\n\n### Telegram / Discord / others\n\nThe wizard can write tokens/config for you. If you prefer manual config, start with:\n\n* Telegram: [Telegram](/channels/telegram)\n* Discord: [Discord](/channels/discord)\n* Mattermost (plugin): [Mattermost](/channels/mattermost)\n\n**Telegram DM tip:** your first DM returns a pairing code. Approve it (see next step) or the bot won’t respond.\n\n## 5) DM safety (pairing approvals)\n\nDefault posture: unknown DMs get a short code and messages are not processed until approved.\nIf your first DM gets no reply, approve the pairing:",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "Pairing doc: [Pairing](/start/pairing)\n\n## From source (development)\n\nIf you’re hacking on OpenClaw itself, run from source:",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "If you don’t have a global install yet, run the onboarding step via `pnpm openclaw ...` from the repo.\n`pnpm build` also bundles A2UI assets; if you need to run just that step, use `pnpm canvas:a2ui:bundle`.\n\nGateway (from this repo):",
|
||
"language": "unknown"
|
||
},
|
||
{
|
||
"code": "## 7) Verify end-to-end\n\nIn a new terminal, send a test message:",
|
||
"language": "unknown"
|
||
}
|
||
],
|
||
"headings": [
|
||
{
|
||
"level": "h2",
|
||
"text": "0) Prereqs",
|
||
"id": "0)-prereqs"
|
||
},
|
||
{
|
||
"level": "h2",
|
||
"text": "1) Install the CLI (recommended)",
|
||
"id": "1)-install-the-cli-(recommended)"
|
||
},
|
||
{
|
||
"level": "h2",
|
||
"text": "2) Run the onboarding wizard (and install the service)",
|
||
"id": "2)-run-the-onboarding-wizard-(and-install-the-service)"
|
||
},
|
||
{
|
||
"level": "h3",
|
||
"text": "Auth: where it lives (important)",
|
||
"id": "auth:-where-it-lives-(important)"
|
||
},
|
||
{
|
||
"level": "h2",
|
||
"text": "3) Start the Gateway",
|
||
"id": "3)-start-the-gateway"
|
||
},
|
||
{
|
||
"level": "h2",
|
||
"text": "3.5) Quick verify (2 min)",
|
||
"id": "3.5)-quick-verify-(2-min)"
|
||
},
|
||
{
|
||
"level": "h2",
|
||
"text": "4) Pair + connect your first chat surface",
|
||
"id": "4)-pair-+-connect-your-first-chat-surface"
|
||
},
|
||
{
|
||
"level": "h3",
|
||
"text": "WhatsApp (QR login)",
|
||
"id": "whatsapp-(qr-login)"
|
||
},
|
||
{
|
||
"level": "h3",
|
||
"text": "Telegram / Discord / others",
|
||
"id": "telegram-/-discord-/-others"
|
||
},
|
||
{
|
||
"level": "h2",
|
||
"text": "5) DM safety (pairing approvals)",
|
||
"id": "5)-dm-safety-(pairing-approvals)"
|
||
},
|
||
{
|
||
"level": "h2",
|
||
"text": "From source (development)",
|
||
"id": "from-source-(development)"
|
||
},
|
||
{
|
||
"level": "h2",
|
||
"text": "7) Verify end-to-end",
|
||
"id": "7)-verify-end-to-end"
|
||
},
|
||
{
|
||
"level": "h2",
|
||
"text": "Next steps (optional, but great)",
|
||
"id": "next-steps-(optional,-but-great)"
|
||
}
|
||
],
|
||
"url": "llms-txt#getting-started",
|
||
"links": []
|
||
} |