openclaw migrate
Import state from another agent system through a plugin-owned migration provider. Bundled providers cover Codex CLI state, Claude, and Hermes; third-party plugins can register additional providers.
Commands
Name of a registered migration provider, for example
hermes. Run openclaw migrate list to see installed providers.Build the plan and exit without changing state.
Override the source state directory. Hermes defaults to
~/.hermes.Import supported credentials. Off by default.
Allow apply to replace existing targets when the plan reports conflicts.
Skip the confirmation prompt. Required in non-interactive mode.
Select one skill copy item by skill name or item id. Repeat the flag to migrate multiple skills. When omitted, interactive Codex migrations show a checkbox selector and non-interactive migrations keep all planned skills.
Skip the pre-apply backup. Requires
--force when local OpenClaw state exists.Required alongside
--no-backup when apply would otherwise refuse to skip backup.Print the plan or apply result as JSON. With
--json and no --yes, apply prints the plan and does not mutate state.Safety model
openclaw migrate is preview-first.
Preview before apply
Preview before apply
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.Backups
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.Conflicts
Conflicts
Apply refuses to continue when the plan has conflicts. Review the plan, then rerun with
--overwrite if replacing existing targets is intentional. Providers may still write item-level backups for overwritten files in the migration report directory.Secrets
Secrets
Secrets are never imported by default. Use
--include-secrets to import supported credentials.Claude provider
The bundled Claude provider detects Claude Code state at~/.claude by default. Use --from <path> to import a specific Claude Code home or project root.
What Claude imports
- Project
CLAUDE.mdand.claude/CLAUDE.mdinto the OpenClaw agent workspace. - User
~/.claude/CLAUDE.mdappended to workspaceUSER.md. - MCP server definitions from project
.mcp.json, Claude Code~/.claude.json, and Claude Desktopclaude_desktop_config.json. - Claude skill directories that include
SKILL.md. - Claude command Markdown files converted into OpenClaw skills with manual invocation only.
Archive and manual-review state
Claude hooks, permissions, environment defaults, local memory, path-scoped rules, subagents, caches, plans, and project history are preserved in the migration report or reported as manual-review items. OpenClaw does not execute hooks, copy broad allowlists, or import OAuth/Desktop credential state automatically.Codex provider
The bundled Codex provider detects Codex CLI state at~/.codex by default, or
at CODEX_HOME when that environment variable is set. Use --from <path> to
inventory a specific Codex home.
Use this provider when moving to the OpenClaw Codex harness and you want to
promote useful personal Codex CLI assets deliberately. Local Codex app-server
launches use per-agent CODEX_HOME and HOME directories, so they do not read
your personal Codex CLI state by default.
Running openclaw migrate codex in an interactive terminal previews the full
plan, then opens a checkbox selector for skill copy items before the final
apply confirmation. Use Toggle all on or Toggle all off for bulk selection;
planned skills start checked, conflict skills start unchecked, and Skip for now
leaves skills unchanged without applying. For scripted or exact runs, pass
--skill <name> once per skill, for example:
What Codex imports
- Codex CLI skill directories under
$CODEX_HOME/skills, excluding Codex’s.systemcache. - Personal AgentSkills under
$HOME/.agents/skills, copied into the current OpenClaw agent workspace when you want per-agent ownership.
Manual-review Codex state
Codex native plugins,config.toml, and native hooks/hooks.json are not
activated automatically. Plugins may expose MCP servers, apps, hooks, or other
executable behavior, so the provider reports them for review instead of loading
them into OpenClaw. Config and hook files are copied into the migration report
for manual review.
Hermes provider
The bundled Hermes provider detects state at~/.hermes by default. Use --from <path> when Hermes lives elsewhere.
What Hermes imports
- Default model configuration from
config.yaml. - Configured model providers and custom OpenAI-compatible endpoints from
providersandcustom_providers. - MCP server definitions from
mcp_serversormcp.servers. SOUL.mdandAGENTS.mdinto the OpenClaw agent workspace.memories/MEMORY.mdandmemories/USER.mdappended to workspace memory files.- Memory config defaults for OpenClaw file memory, plus archive or manual-review items for external memory providers such as Honcho.
- Skills that include a
SKILL.mdfile underskills/<name>/. - Per-skill config values from
skills.config. - Supported API keys from
.env, only with--include-secrets.
Supported .env keys
OPENAI_API_KEY, ANTHROPIC_API_KEY, OPENROUTER_API_KEY, GOOGLE_API_KEY, GEMINI_API_KEY, GROQ_API_KEY, XAI_API_KEY, MISTRAL_API_KEY, DEEPSEEK_API_KEY.
Archive-only state
Hermes state that OpenClaw cannot safely interpret is copied into the migration report for manual review, but it is not loaded into live OpenClaw config or credentials. This preserves opaque or unsafe state without pretending OpenClaw can execute or trust it automatically:plugins/sessions/logs/cron/mcp-tokens/auth.jsonstate.db
After applying
Plugin contract
Migration sources are plugins. A plugin declares its provider ids inopenclaw.plugin.json:
api.registerMigrationProvider(...). The provider implements detect, plan, and apply. Core owns CLI orchestration, backup policy, prompts, JSON output, and conflict preflight. Core passes the reviewed plan into apply(ctx, plan), and providers may rebuild the plan only when that argument is absent for compatibility.
Provider plugins can use openclaw/plugin-sdk/migration for item construction and summary counts, plus openclaw/plugin-sdk/migration-runtime for conflict-aware file copies, archive-only report copies, cached config-runtime wrappers, and migration reports.
Onboarding integration
Onboarding can offer migration when a provider detects a known source. Bothopenclaw onboard --flow import and openclaw setup --wizard --import-from hermes use the same plugin migration provider and still show a preview before applying.
Onboarding imports require a fresh OpenClaw setup. Reset config, credentials, sessions, and the workspace first if you already have local state. Backup-plus-overwrite or merge imports are feature-gated for existing setups.
Related
- Migrating from Hermes: user-facing walkthrough.
- Migrating from Claude: user-facing walkthrough.
- Migrating: move OpenClaw to a new machine.
- Doctor: health check after applying a migration.
- Plugins: plugin install and registration.