farcasclaudiu/openclaw
1
0
Fork 0
mirror of https://github.com/farcasclaudiu/openclaw.git synced 2026-06-28 23:02:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

refactor: rename to openclaw

Browse Source
This commit is contained in:
Peter Steinberger
2026-01-30 03:15:10 +01:00
parent 4583f88626
commit 9a7160786a
2357 changed files with 16688 additions and 16788 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/start/wizard.md
+30 -30
View File
@@ -7,7 +7,7 @@ read_when:
# Onboarding Wizard (CLI)
The onboarding wizard is the **recommended** way to set up Moltbot on macOS,
The onboarding wizard is the **recommended** way to set up OpenClaw on macOS,
Linux, or Windows (via WSL2; strongly recommended).
It configures a local Gateway or a remote Gateway connection, plus channels, skills,
and workspace defaults in one guided flow.
@@ -15,20 +15,20 @@ and workspace defaults in one guided flow.
Primary entrypoint:
```bash
moltbot onboard
openclaw onboard
```
Fastest first chat: open the Control UI (no channel setup needed). Run
`moltbot dashboard` and chat in the browser. Docs: [Dashboard](/web/dashboard).
`openclaw dashboard` and chat in the browser. Docs: [Dashboard](/web/dashboard).
Follow‑up reconfiguration:
```bash
moltbot configure
openclaw configure
```
Recommended: set up a Brave Search API key so the agent can use `web_search`
(`web_fetch` works without a key). Easiest path: `moltbot configure --section web`
(`web_fetch` works without a key). Easiest path: `openclaw configure --section web`
which stores `tools.web.search.apiKey`. Docs: [Web tools](/tools/web).
## QuickStart vs Advanced
@@ -62,7 +62,7 @@ It does **not** install or change anything on the remote host.
To add more isolated agents (separate workspace + sessions + auth), use:
```bash
moltbot agents add <name>
openclaw agents add <name>
```
Tip: `--json` does **not** imply non-interactive mode. Use `--non-interactive` (and `--workspace`) for scripts.
@@ -70,11 +70,11 @@ Tip: `--json` does **not** imply non-interactive mode. Use `--non-interactive` (
## Flow details (local)
1) **Existing config detection**
- If `~/.clawdbot/moltbot.json` exists, choose **Keep / Modify / Reset**.
- If `~/.openclaw/openclaw.json` exists, choose **Keep / Modify / Reset**.
- Re-running the wizard does **not** wipe anything unless you explicitly choose **Reset**
(or pass `--reset`).
- If the config is invalid or contains legacy keys, the wizard stops and asks
you to run `moltbot doctor` before continuing.
you to run `openclaw doctor` before continuing.
- Reset uses `trash` (never `rm`) and offers scopes:
- Config only
- Config + credentials + sessions
@@ -87,7 +87,7 @@ Tip: `--json` does **not** imply non-interactive mode. Use `--non-interactive` (
- **OpenAI Code (Codex) subscription (Codex CLI)**: if `~/.codex/auth.json` exists, the wizard can reuse it.
- **OpenAI Code (Codex) subscription (OAuth)**: browser flow; paste the `code#state`.
- Sets `agents.defaults.model` to `openai-codex/gpt-5.2` when model is unset or `openai/*`.
- **OpenAI API key**: uses `OPENAI_API_KEY` if present or prompts for a key, then saves it to `~/.clawdbot/.env` so launchd can read it.
- **OpenAI API key**: uses `OPENAI_API_KEY` if present or prompts for a key, then saves it to `~/.openclaw/.env` so launchd can read it.
- **OpenCode Zen (multi-model proxy)**: prompts for `OPENCODE_API_KEY` (or `OPENCODE_ZEN_API_KEY`, get it at https://opencode.ai/auth).
- **API key**: stores the key for you.
- **Vercel AI Gateway (multi-model proxy)**: prompts for `AI_GATEWAY_API_KEY`.
@@ -102,11 +102,11 @@ Tip: `--json` does **not** imply non-interactive mode. Use `--non-interactive` (
- **Skip**: no auth configured yet.
- Pick a default model from detected options (or enter provider/model manually).
- Wizard runs a model check and warns if the configured model is unknown or missing auth.
- OAuth credentials live in `~/.clawdbot/credentials/oauth.json`; auth profiles live in `~/.clawdbot/agents/<agentId>/agent/auth-profiles.json` (API keys + OAuth).
- OAuth credentials live in `~/.openclaw/credentials/oauth.json`; auth profiles live in `~/.openclaw/agents/<agentId>/agent/auth-profiles.json` (API keys + OAuth).
- More detail: [/concepts/oauth](/concepts/oauth)
3) **Workspace**
- Default `~/clawd` (configurable).
- Default `~/.openclaw/workspace` (configurable).
- Seeds the workspace files needed for the agent bootstrap ritual.
- Full workspace layout + backup guide: [Agent workspace](/concepts/agent-workspace)
@@ -124,7 +124,7 @@ Tip: `--json` does **not** imply non-interactive mode. Use `--non-interactive` (
- Mattermost (plugin): bot token + base URL.
- Signal: optional `signal-cli` install + account config.
- iMessage: local `imsg` CLI path + DB access.
- DM security: default is pairing. First DM sends a code; approve via `moltbot pairing approve <channel> <code>` or use allowlists.
- DM security: default is pairing. First DM sends a code; approve via `openclaw pairing approve <channel> <code>` or use allowlists.
6) **Daemon install**
- macOS: LaunchAgent
@@ -135,8 +135,8 @@ Tip: `--json` does **not** imply non-interactive mode. Use `--non-interactive` (
- **Runtime selection:** Node (recommended; required for WhatsApp/Telegram). Bun is **not recommended**.
7) **Health check**
- Starts the Gateway (if needed) and runs `moltbot health`.
- Tip: `moltbot status --deep` adds gateway health probes to status output (requires a reachable gateway).
- Starts the Gateway (if needed) and runs `openclaw health`.
- Tip: `openclaw status --deep` adds gateway health probes to status output (requires a reachable gateway).
8) **Skills (recommended)**
- Reads the available skills and checks requirements.
@@ -165,7 +165,7 @@ Notes:
## Add another agent
Use `moltbot agents add <name>` to create a separate agent with its own workspace,
Use `openclaw agents add <name>` to create a separate agent with its own workspace,
sessions, and auth profiles. Running without `--workspace` launches the wizard.
What it sets:
@@ -174,7 +174,7 @@ What it sets:
- `agents.list[].agentDir`
Notes:
- Default workspaces follow `~/clawd-<agentId>`.
- Default workspaces follow `~/.openclaw/workspace-<agentId>`.
- Add `bindings` to route inbound messages (the wizard can do this).
- Non-interactive flags: `--model`, `--agent-dir`, `--bind`, `--non-interactive`.
@@ -183,7 +183,7 @@ Notes:
Use `--non-interactive` to automate or script onboarding:
```bash
moltbot onboard --non-interactive \
openclaw onboard --non-interactive \
--mode local \
--auth-choice apiKey \
--anthropic-api-key "$ANTHROPIC_API_KEY" \
@@ -199,7 +199,7 @@ Add `--json` for a machine‑readable summary.
Gemini example:
```bash
moltbot onboard --non-interactive \
openclaw onboard --non-interactive \
--mode local \
--auth-choice gemini-api-key \
--gemini-api-key "$GEMINI_API_KEY" \
@@ -210,7 +210,7 @@ moltbot onboard --non-interactive \
Z.AI example:
```bash
moltbot onboard --non-interactive \
openclaw onboard --non-interactive \
--mode local \
--auth-choice zai-api-key \
--zai-api-key "$ZAI_API_KEY" \
@@ -221,7 +221,7 @@ moltbot onboard --non-interactive \
Vercel AI Gateway example:
```bash
moltbot onboard --non-interactive \
openclaw onboard --non-interactive \
--mode local \
--auth-choice ai-gateway-api-key \
--ai-gateway-api-key "$AI_GATEWAY_API_KEY" \
@@ -232,7 +232,7 @@ moltbot onboard --non-interactive \
Moonshot example:
```bash
moltbot onboard --non-interactive \
openclaw onboard --non-interactive \
--mode local \
--auth-choice moonshot-api-key \
--moonshot-api-key "$MOONSHOT_API_KEY" \
@@ -243,7 +243,7 @@ moltbot onboard --non-interactive \
Synthetic example:
```bash
moltbot onboard --non-interactive \
openclaw onboard --non-interactive \
--mode local \
--auth-choice synthetic-api-key \
--synthetic-api-key "$SYNTHETIC_API_KEY" \
@@ -254,7 +254,7 @@ moltbot onboard --non-interactive \
OpenCode Zen example:
```bash
moltbot onboard --non-interactive \
openclaw onboard --non-interactive \
--mode local \
--auth-choice opencode-zen \
--opencode-zen-api-key "$OPENCODE_API_KEY" \
@@ -265,8 +265,8 @@ moltbot onboard --non-interactive \
Add agent (non‑interactive) example:
```bash
moltbot agents add work \
--workspace ~/clawd-work \
openclaw agents add work \
--workspace ~/.openclaw/workspace-work \
--model openai/gpt-5.2 \
--bind whatsapp:biz \
--non-interactive \
@@ -282,7 +282,7 @@ Clients (macOS app, Control UI) can render steps without re‑implementing onboa
The wizard can install `signal-cli` from GitHub releases:
- Downloads the appropriate release asset.
- Stores it under `~/.clawdbot/tools/signal-cli/<version>/`.
- Stores it under `~/.openclaw/tools/signal-cli/<version>/`.
- Writes `channels.signal.cliPath` to your config.
Notes:
@@ -292,7 +292,7 @@ Notes:
## What the wizard writes
Typical fields in `~/.clawdbot/moltbot.json`:
Typical fields in `~/.openclaw/openclaw.json`:
- `agents.defaults.workspace`
- `agents.defaults.model` / `models.providers` (if Minimax chosen)
- `gateway.*` (mode, bind, auth, tailscale)
@@ -305,10 +305,10 @@ Typical fields in `~/.clawdbot/moltbot.json`:
- `wizard.lastRunCommand`
- `wizard.lastRunMode`
`moltbot agents add` writes `agents.list[]` and optional `bindings`.
`openclaw agents add` writes `agents.list[]` and optional `bindings`.
WhatsApp credentials go under `~/.clawdbot/credentials/whatsapp/<accountId>/`.
Sessions are stored under `~/.clawdbot/agents/<agentId>/sessions/`.
WhatsApp credentials go under `~/.openclaw/credentials/whatsapp/<accountId>/`.
Sessions are stored under `~/.openclaw/agents/<agentId>/sessions/`.
Some channels are delivered as plugins. When you pick one during onboarding, the wizard
will prompt to install it (npm or a local path) before it can be configured.