Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt

Use this file to discover all available pages before exploring further.

openclaw migrate

通过由插件拥有的迁移提供程序,从另一个代理系统导入状态。内置提供程序覆盖 Codex CLI 状态、ClaudeHermes;第三方插件可以注册额外的提供程序。
面向用户的操作指南,请参阅 从 Claude 迁移从 Hermes 迁移迁移中心 列出了所有路径。

Commands

openclaw migrate list
openclaw migrate claude --dry-run
openclaw migrate codex --dry-run
openclaw migrate codex --skill gog-vault77-google-workspace
openclaw migrate hermes --dry-run
openclaw migrate hermes
openclaw migrate apply codex --yes --skill gog-vault77-google-workspace
openclaw migrate apply codex --yes
openclaw migrate apply claude --yes
openclaw migrate apply hermes --yes
openclaw migrate apply hermes --include-secrets --yes
openclaw onboard --flow import
openclaw onboard --import-from claude --import-source ~/.claude
openclaw onboard --import-from hermes --import-source ~/.hermes
<provider>
string
已注册迁移提供程序的名称,例如 hermes。运行 openclaw migrate list 查看已安装的提供程序。
--dry-run
boolean
构建计划并退出,不更改状态。
--from <path>
string
覆盖源状态目录。Hermes 默认为 ~/.hermes
--include-secrets
boolean
导入受支持的凭据。默认关闭。
--overwrite
boolean
当计划报告冲突时,允许 apply 替换现有目标。
--yes
boolean
跳过确认提示。在非交互模式下必需。
--skill <name>
string
按技能名称或项目 ID 选择一个技能复制项。重复该标志可迁移多个技能。省略时,交互式 Codex 迁移会显示复选框选择器,非交互式迁移会保留所有计划中的技能。
--no-backup
boolean
跳过预应用备份。当本地 OpenClaw 状态存在时,需要配合 --force 使用。
--force
boolean
当 apply 否则会拒绝跳过备份时,需要与 --no-backup 一起使用。
--json
boolean
将计划或 apply 结果以 JSON 打印。使用 --json 且不带 --yes 时,apply 会打印计划且不会修改状态。

Safety model

openclaw migrate 采用先预览的方式。
提供程序会在任何内容发生变化之前返回一份逐项计划,包括冲突、跳过的项目和敏感项目。JSON 计划、apply 输出以及迁移报告会对嵌套的疑似密钥字段进行脱敏,例如 API 密钥、令牌、授权头、cookie 和密码。openclaw migrate apply <provider> 会先预览计划,并在更改状态前提示确认,除非设置了 --yes。在非交互模式下,apply 需要 --yes
apply 会在应用迁移前创建并验证一个 OpenClaw 备份。如果本地尚不存在 OpenClaw 状态,则会跳过备份步骤,迁移可继续进行。若状态已存在且要跳过备份,请同时传入 --no-backup--force
当计划存在冲突时,apply 会拒绝继续。请检查计划,然后在替换现有目标是有意为之时,使用 --overwrite 重新运行。提供程序仍可能会为迁移报告目录中被覆盖的文件写入逐项备份。
默认情况下绝不会导入密钥。使用 --include-secrets 可导入受支持的凭据。

Claude provider

内置的 Claude 提供程序默认检测位于 ~/.claude 的 Claude Code 状态。使用 --from <path> 可导入特定的 Claude Code 主目录或项目根目录。
面向用户的操作指南,请参阅 从 Claude 迁移

What Claude imports

  • 将项目 CLAUDE.md.claude/CLAUDE.md 导入到 OpenClaw 代理工作区。
  • 将用户 ~/.claude/CLAUDE.md 追加到工作区 USER.md
  • 来自项目 .mcp.json、Claude Code ~/.claude.json 和 Claude Desktop claude_desktop_config.json 的 MCP 服务器定义。
  • 包含 SKILL.md 的 Claude 技能目录。
  • 将 Claude 命令 Markdown 文件转换为 OpenClaw 技能,仅支持手动调用。

Archive and manual-review state

Claude hooks、权限、环境默认值、本地记忆、路径作用域规则、子代理、缓存、计划和项目历史会保留在迁移报告中,或作为需要人工审核的项目报告。OpenClaw 不会执行 hooks、复制宽泛的允许列表,或自动导入 OAuth/Desktop 凭据状态。

Codex provider

内置的 Codex 提供程序默认在 ~/.codex 检测 Codex CLI 状态,或者在设置了该环境变量时于 CODEX_HOME 中检测。使用 --from <path> 可盘点特定的 Codex 主目录。 当你迁移到 OpenClaw Codex harness,并且希望有意地提取有用的个人 Codex CLI 资产时,请使用此提供程序。本地 Codex app-server 启动会为每个代理使用各自的 CODEX_HOMEHOME 目录,因此默认不会读取你的个人 Codex CLI 状态。 在交互式终端中运行 openclaw migrate codex 时,会先预览完整计划,然后在最终应用确认之前打开一个技能复制项的复选框选择器。所有技能默认都已选中;取消勾选你不想复制到此代理中的任何技能。对于脚本化或精确运行,请对每个技能各传一次 --skill <name>,例如:
openclaw migrate codex --dry-run --skill gog-vault77-google-workspace
openclaw migrate apply codex --yes --skill gog-vault77-google-workspace

What Codex imports

  • $CODEX_HOME/skills 下的 Codex CLI 技能目录,不包括 Codex 的 .system 缓存。
  • $HOME/.agents/skills 下的个人 AgentSkills,当你希望按代理拥有权复制到当前 OpenClaw 代理工作区时。

Manual-review Codex state

Codex 原生插件、config.toml 和原生 hooks/hooks.json 不会自动激活。插件可能暴露 MCP 服务器、应用、hooks 或其他可执行行为,因此提供程序会将它们报告出来供审查,而不是将其加载到 OpenClaw 中。配置和 hook 文件会被复制到迁移报告中以供人工审核。

Hermes provider

内置的 Hermes 提供程序默认检测位于 ~/.hermes 的状态。若 Hermes 位于其他位置,请使用 --from <path>

What Hermes imports

  • 来自 config.yaml 的默认模型配置。
  • 来自 providerscustom_providers 的已配置模型提供程序以及自定义 OpenAI 兼容端点。
  • 来自 mcp_serversmcp.servers 的 MCP 服务器定义。
  • SOUL.mdAGENTS.md 导入到 OpenClaw 代理工作区。
  • memories/MEMORY.mdmemories/USER.md 追加到工作区记忆文件。
  • OpenClaw 文件记忆的记忆配置默认值,以及来自 Honcho 等外部记忆提供程序的归档或人工审核项目。
  • skills/<name>/ 下包含 SKILL.md 文件的技能。
  • 来自 skills.config 的每项技能配置值。
  • 仅在使用 --include-secrets 时,从 .env 导入受支持的 API 密钥。

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.

仅归档状态

OpenClaw 无法安全解释的 Hermes 状态会被复制到迁移报告中供人工审核,但不会加载到实际的 OpenClaw 配置或凭据中。这样可以保留不透明或不安全的状态,而不会假装 OpenClaw 能自动执行或信任它:
  • plugins/
  • sessions/
  • logs/
  • cron/
  • mcp-tokens/
  • auth.json
  • state.db

应用后

openclaw doctor

Plugin contract

迁移源是插件。插件在 openclaw.plugin.json 中声明其 provider id:
{
  "contracts": {
    "migrationProviders": ["hermes"]
  }
}
运行时插件调用 api.registerMigrationProvider(...)。该提供程序实现 detectplanapply。核心负责 CLI 编排、备份策略、提示、JSON 输出和冲突预检。核心将审阅后的计划传入 apply(ctx, plan);为了兼容性,只有当该参数缺失时,提供程序才可重建计划。 提供程序插件可以使用 openclaw/plugin-sdk/migration 进行条目构建和摘要计数,也可以使用 openclaw/plugin-sdk/migration-runtime 进行具备冲突感知的文件复制、仅归档报告复制、缓存的 config-runtime 包装器以及迁移报告。

Onboarding integration

当提供程序检测到已知来源时,引导流程可以提供迁移。openclaw onboard --flow importopenclaw setup --wizard --import-from hermes 都使用相同的插件迁移提供程序,并且在应用前仍会显示预览。
引导导入需要全新的 OpenClaw 安装。如果你已经有本地状态,请先重置配置、凭据、会话和工作区。现有安装的备份加覆盖或合并导入属于功能开关控制。