Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
openclaw setup
Initialize the baseline config and agent workspace. With any onboarding flag present, also runs the wizard.
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. Use the first-party nix-openclaw Quick Start or the equivalent source config for another Nix package.Options
| Flag | Description |
|---|---|
--workspace <dir> | Agent workspace directory (default ~/.openclaw/workspace; stored as agents.defaults.workspace). |
--wizard | Run interactive onboarding. |
--non-interactive | Run onboarding without prompts. |
--mode <mode> | Onboarding mode: local or remote. |
--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 (optional). |
Wizard auto-trigger
openclaw setup runs the wizard when any of these flags are explicitly present, even without --wizard:
--wizard, --non-interactive, --mode, --import-from, --import-source, --import-secrets, --remote-url, --remote-token.
Examples
Notes
- Plain
openclaw setupinitializes config and workspace without running the full onboarding flow. - After plain setup, run
openclaw onboardfor the full guided journey,openclaw configurefor targeted changes, oropenclaw channels addto add channel accounts. - 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.