Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
156 lines
4.2 KiB
Markdown
156 lines
4.2 KiB
Markdown
---
|
|
summary: "Get OpenClaw installed and run your first chat in minutes."
|
|
read_when:
|
|
- First time setup from zero
|
|
- You want the fastest path to a working chat
|
|
title: "Getting started"
|
|
---
|
|
|
|
Install OpenClaw, run onboarding, and chat with your AI assistant in about 5
|
|
minutes. By the end you will have a running Gateway, configured auth, and a
|
|
working chat session.
|
|
|
|
## What you need
|
|
|
|
- **Node.js 22.19+, 23.11+, or 24+** (24 is the recommended default)
|
|
- **An API key** from a model provider (Anthropic, OpenAI, Google, etc.) — onboarding will prompt you
|
|
|
|
<Tip>
|
|
Check your Node version with `node --version`.
|
|
**Windows users:** the native Windows Hub app is the easiest desktop path. The
|
|
PowerShell installer and WSL2 Gateway paths are also supported. See [Windows](/platforms/windows).
|
|
Need to install Node? See [Node setup](/install/node).
|
|
</Tip>
|
|
|
|
## Quick setup
|
|
|
|
<Steps>
|
|
<Step title="Install OpenClaw">
|
|
<Tabs>
|
|
<Tab title="macOS / Linux">
|
|
```bash
|
|
curl -fsSL https://openclaw.ai/install.sh | bash
|
|
```
|
|
<img
|
|
src="/assets/install-script.svg"
|
|
alt="Install Script Process"
|
|
className="rounded-lg"
|
|
/>
|
|
</Tab>
|
|
<Tab title="Windows (PowerShell)">
|
|
```powershell
|
|
iwr -useb https://openclaw.ai/install.ps1 | iex
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<Note>
|
|
Other install methods (Docker, Nix, npm): [Install](/install).
|
|
</Note>
|
|
|
|
</Step>
|
|
<Step title="Run onboarding">
|
|
```bash
|
|
openclaw onboard --install-daemon
|
|
```
|
|
|
|
The wizard walks you through choosing a model provider, setting an API key,
|
|
and configuring the Gateway. QuickStart is usually only a few minutes, but
|
|
provider sign-in, channel pairing, daemon install, network downloads, skills,
|
|
or optional plugins can make full onboarding take longer. Skip optional
|
|
steps and return later with `openclaw configure`.
|
|
|
|
See [Onboarding (CLI)](/start/wizard) for the full reference.
|
|
|
|
</Step>
|
|
<Step title="Verify the Gateway is running">
|
|
```bash
|
|
openclaw gateway status
|
|
```
|
|
|
|
You should see the Gateway listening on port 18789.
|
|
|
|
</Step>
|
|
<Step title="Open the dashboard">
|
|
```bash
|
|
openclaw dashboard
|
|
```
|
|
|
|
This opens the Control UI in your browser. If it loads, everything is working.
|
|
|
|
</Step>
|
|
<Step title="Send your first message">
|
|
Type a message in the Control UI chat and you should get an AI reply.
|
|
|
|
Want to chat from your phone instead? The fastest channel to set up is
|
|
[Telegram](/channels/telegram) (just a bot token). See [Channels](/channels)
|
|
for all options.
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Accordion title="Advanced: mount a custom Control UI build">
|
|
If you maintain a localized or customized dashboard build, point
|
|
`gateway.controlUi.root` to a directory that contains your built static
|
|
assets and `index.html`.
|
|
|
|
```bash
|
|
mkdir -p "$HOME/.openclaw/control-ui-custom"
|
|
# Copy your built static files into that directory.
|
|
```
|
|
|
|
Then set:
|
|
|
|
```json
|
|
{
|
|
"gateway": {
|
|
"controlUi": {
|
|
"enabled": true,
|
|
"root": "$HOME/.openclaw/control-ui-custom"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Restart the gateway and reopen the dashboard:
|
|
|
|
```bash
|
|
openclaw gateway restart
|
|
openclaw dashboard
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
## What to do next
|
|
|
|
<Columns>
|
|
<Card title="Connect a channel" href="/channels" icon="message-square">
|
|
Discord, Feishu, iMessage, Matrix, Microsoft Teams, Signal, Slack, Telegram, WhatsApp, Zalo, and more.
|
|
</Card>
|
|
<Card title="Pairing and safety" href="/channels/pairing" icon="shield">
|
|
Control who can message your agent.
|
|
</Card>
|
|
<Card title="Configure the Gateway" href="/gateway/configuration" icon="settings">
|
|
Models, tools, sandbox, and advanced settings.
|
|
</Card>
|
|
<Card title="Browse tools" href="/tools" icon="wrench">
|
|
Browser, exec, web search, skills, and plugins.
|
|
</Card>
|
|
</Columns>
|
|
|
|
<Accordion title="Advanced: environment variables">
|
|
If you run OpenClaw as a service account or want custom paths:
|
|
|
|
- `OPENCLAW_HOME` — home directory for internal path resolution
|
|
- `OPENCLAW_STATE_DIR` — override the state directory
|
|
- `OPENCLAW_CONFIG_PATH` — override the config file path
|
|
|
|
Full reference: [Environment variables](/help/environment).
|
|
</Accordion>
|
|
|
|
## Related
|
|
|
|
- [Install overview](/install)
|
|
- [Channels overview](/channels)
|
|
- [Setup](/start/setup)
|