mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-29 13:06:47 +02:00
1fc5b2b703
* feat: add migration providers * feat: offer Hermes migration during onboarding * feat(hermes): map imported config surfaces * feat(onboard): require fresh migration imports * docs(cli): clarify Hermes import coverage * chore(migrations): rename Hermes importer package * chore(migrations): rewire Hermes importer id * fix(migrations): redact migration JSON details * fix(hermes): use provider runtime for config imports * test(hermes): cover missing source planning --------- Co-authored-by: Peter Steinberger <steipete@gmail.com>
56 lines
1.9 KiB
Markdown
56 lines
1.9 KiB
Markdown
---
|
||
summary: "CLI reference for `openclaw setup` (initialize config + workspace)"
|
||
read_when:
|
||
- You’re doing first-run setup without full CLI onboarding
|
||
- You want to set the default workspace path
|
||
title: "Setup"
|
||
---
|
||
|
||
# `openclaw setup`
|
||
|
||
Initialize `~/.openclaw/openclaw.json` and the agent workspace.
|
||
|
||
Related:
|
||
|
||
- Getting started: [Getting started](/start/getting-started)
|
||
- CLI onboarding: [Onboarding (CLI)](/start/wizard)
|
||
|
||
## Examples
|
||
|
||
```bash
|
||
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:
|
||
|
||
```bash
|
||
openclaw setup --wizard
|
||
```
|
||
|
||
Notes:
|
||
|
||
- Plain `openclaw setup` initializes config + workspace without the full onboarding flow.
|
||
- 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](/cli/migrate) for dry-run plans, backups, and overwrite mode outside onboarding.
|
||
|
||
## Related
|
||
|
||
- [CLI reference](/cli)
|
||
- [Install overview](/install)
|