docs: format migration docs

This commit is contained in:
Peter Steinberger
2026-04-27 09:16:36 +01:00
parent f9181835e8
commit 3eb6a5b209
2 changed files with 7 additions and 0 deletions

View File

@@ -63,6 +63,7 @@ openclaw onboard --import-from hermes --import-source ~/.hermes
The provider returns an itemized plan before anything changes, including conflicts, skipped items, and sensitive items. JSON plans, apply output, and migration reports redact nested secret-looking keys such as API keys, tokens, authorization headers, cookies, and passwords.
`openclaw migrate apply <provider>` previews the plan and prompts before changing state unless `--yes` is set. In non-interactive mode, apply requires `--yes`.
</Accordion>
<Accordion title="Backups">
Apply creates and verifies an OpenClaw backup before applying the migration. If no local OpenClaw state exists yet, the backup step is skipped and the migration can continue. To skip a backup when state exists, pass both `--no-backup` and `--force`.

View File

@@ -28,6 +28,7 @@ Imports require a fresh OpenClaw setup. If you already have local OpenClaw state
```bash
openclaw onboard --import-from hermes --import-source ~/.hermes
```
</Tab>
<Tab title="CLI">
Use `openclaw migrate` for scripted or repeatable runs. See [`openclaw migrate`](/cli/migrate) for the full reference.
@@ -38,6 +39,7 @@ Imports require a fresh OpenClaw setup. If you already have local OpenClaw state
```
Add `--from <path>` when Hermes lives outside `~/.hermes`.
</Tab>
</Tabs>
@@ -89,6 +91,7 @@ OpenClaw refuses to execute or trust this state automatically because the format
```
The plan lists everything that will change, including conflicts, skipped items, and any sensitive items. Plan output redacts nested secret-looking keys.
</Step>
<Step title="Apply with backup">
```bash
@@ -96,6 +99,7 @@ OpenClaw refuses to execute or trust this state automatically because the format
```
OpenClaw creates and verifies a backup before applying. If you need API keys imported, add `--include-secrets`.
</Step>
<Step title="Run doctor">
```bash
@@ -103,6 +107,7 @@ OpenClaw refuses to execute or trust this state automatically because the format
```
[Doctor](/gateway/doctor) reapplies any pending config migrations and checks for issues introduced during the import.
</Step>
<Step title="Restart and verify">
```bash
@@ -111,6 +116,7 @@ OpenClaw refuses to execute or trust this state automatically because the format
```
Confirm the gateway is healthy and your imported model, memory, and skills are loaded.
</Step>
</Steps>