From 3eb6a5b2099b8c565e6aa145cfc1b745f8404b22 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 27 Apr 2026 09:16:36 +0100 Subject: [PATCH] docs: format migration docs --- docs/cli/migrate.md | 1 + docs/install/migrating-hermes.md | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/docs/cli/migrate.md b/docs/cli/migrate.md index 8968aeb0432..6fcca6d8c32 100644 --- a/docs/cli/migrate.md +++ b/docs/cli/migrate.md @@ -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 ` previews the plan and prompts before changing state unless `--yes` is set. In non-interactive mode, apply requires `--yes`. + 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`. diff --git a/docs/install/migrating-hermes.md b/docs/install/migrating-hermes.md index 51d64c2c763..11bf129d80e 100644 --- a/docs/install/migrating-hermes.md +++ b/docs/install/migrating-hermes.md @@ -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 ``` + 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 ` when Hermes lives outside `~/.hermes`. + @@ -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. + ```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`. + ```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. + ```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. +