LLM/moltbot
1
0
Fork 0
mirror of https://github.com/moltbot/moltbot.git synced 2026-05-10 20:45:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
29fe040cda58454edcd403afb104dbf989c1fb67
moltbot/docs/cli/setup.md
Vincent Koc f13dfd6004 docs(cli): align setup command hierarchy
2026-05-10 10:28:48 +08:00

2.4 KiB
Raw Blame History

summary, read_when, title
summary read_when title
CLI reference for `openclaw setup` (initialize config + workspace)
You're doing first-run setup without full CLI onboarding
You want to set the default workspace path
Setup

openclaw setup

Initialize the baseline config and agent workspace without running the full guided onboarding flow.

`openclaw setup` is for mutable config installs. In Nix mode (`OPENCLAW_NIX_MODE=1`), OpenClaw refuses setup writes because the config file is managed by Nix. Agents should use the first-party [nix-openclaw Quick Start](https://github.com/openclaw/nix-openclaw#quick-start) or the equivalent source config for another Nix package.

Related:

Examples

openclaw setup
openclaw setup --workspace ~/.openclaw/workspace
openclaw setup --wizard
openclaw setup --wizard --import-from hermes --import-source ~/.hermes
openclaw setup --non-interactive --mode remote --remote-url wss://gateway-host:18789 --remote-token <token>

Options

  • --workspace <dir>: agent workspace directory (stored as agents.defaults.workspace)
  • --wizard: run onboarding
  • --non-interactive: run onboarding without prompts
  • --mode <local|remote>: onboarding mode
  • --import-from <provider>: migration provider to run during onboarding
  • --import-source <path>: source agent home for --import-from
  • --import-secrets: import supported secrets during onboarding migration
  • --remote-url <url>: remote Gateway WebSocket URL
  • --remote-token <token>: remote Gateway token

To run onboarding via setup:

openclaw setup --wizard

Notes:

  • Plain openclaw setup initializes config + workspace without the full onboarding flow.
  • After plain setup, run openclaw onboard for the full guided journey, openclaw configure for targeted changes, or openclaw channels add to add channel accounts.
  • Onboarding auto-runs when any onboarding flags are present (--wizard, --non-interactive, --mode, --import-from, --import-source, --import-secrets, --remote-url, --remote-token).
  • If Hermes state is detected, interactive onboarding can offer migration automatically. Import onboarding requires a fresh setup; use Migrate for dry-run plans, backups, and overwrite mode outside onboarding.

Related