CLI commands

Setup

openclaw setup

Initialize the baseline config and agent workspace. With any onboarding flag present, also runs the wizard.

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.
--accept-risk Acknowledge full-system agent access risk; required with --non-interactive.
--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, --accept-risk, --mode, --import-from, --import-source, --import-secrets, --remote-url, --remote-token.

Examples

bash
openclaw setupopenclaw setup --workspace ~/.openclaw/workspaceopenclaw setup --wizardopenclaw setup --wizard --import-from hermes --import-source ~/.hermesopenclaw setup --non-interactive --accept-risk --mode remote --remote-url wss://gateway-host:18789 --remote-token <token>

Notes

  • Plain openclaw setup initializes config and workspace without running 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.
  • 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.
Was this useful?
On this page

On this page