Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

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

​
openclaw migrate

通过插件拥有的迁移提供商从另一个智能体系统导入状态。内置提供商覆盖 Codex CLI 状态、Claude 和 Hermes；第三方插件可以注册其他提供商。
如需面向用户的操作指南，请参阅从 Claude 迁移和从 Hermes 迁移。迁移中心列出了所有路径。

​
命令

openclaw migrate list
openclaw migrate claude --dry-run
openclaw migrate codex --dry-run
openclaw migrate codex --skill gog-vault77-google-workspace
openclaw migrate codex --plugin google-calendar --dry-run
openclaw migrate codex --plugin google-calendar --verify-plugin-apps --dry-run
openclaw migrate hermes --dry-run
openclaw migrate hermes
openclaw migrate apply codex --yes --skill gog-vault77-google-workspace
openclaw migrate apply codex --yes --plugin google-calendar
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 迁移会显示复选框选择器，非交互式迁移会保留所有计划中的技能。
​
--plugin <name>
string
按插件名称或项目 ID 选择一个 Codex 插件安装项。重复此标志可迁移多个 Codex 插件。省略时，交互式 Codex 迁移会显示原生 Codex 插件复选框选择器，非交互式迁移会保留所有计划中的插件。这仅适用于由 Codex app-server 清单发现的源端已安装 openai-curated Codex 插件。
​
--verify-plugin-apps
boolean
仅限 Codex。在规划原生插件激活之前，强制执行一次新的源 Codex app-server app/list 遍历。默认关闭，以保持迁移规划快速。
​
--no-backup
boolean
跳过 apply 前备份。当本地 OpenClaw 状态存在时，需要 --force。
​
--force
boolean
当 apply 本来会拒绝跳过备份时，需要与 --no-backup 一起使用。
​
--json
boolean
以 JSON 打印计划或 apply 结果。使用 --json 且没有 --yes 时，apply 会打印计划且不会变更状态。

​
安全模型

openclaw migrate 采用预览优先。
提供商会在任何更改发生前返回逐项计划，包括冲突、跳过项和敏感项。JSON 计划、apply 输出和迁移报告会遮蔽看起来像密钥的嵌套键，例如 API key、令牌、授权标头、cookie 和密码。openclaw migrate apply <provider> 会预览计划，并在更改状态前提示，除非设置了 --yes。在非交互模式下，apply 需要 --yes。
apply 会在应用迁移前创建并验证 OpenClaw 备份。如果尚不存在本地 OpenClaw 状态，则会跳过备份步骤并继续迁移。若要在状态存在时跳过备份，请同时传入 --no-backup 和 --force。
当计划存在冲突时，apply 会拒绝继续。查看计划，然后在确实要替换现有目标时使用 --overwrite 重新运行。提供商仍可能在迁移报告目录中为被覆盖的文件写入项目级备份。
默认永不导入密钥。使用 --include-secrets 导入受支持的凭证。

​
Claude 提供商

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

​
Claude 导入内容

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

​
归档和手动审核状态

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

​
Codex 提供商

内置 Codex 提供商默认在 ~/.codex 检测 Codex CLI 状态，或在设置了 CODEX_HOME 环境变量时使用该位置。使用 --from <path> 清点特定的 Codex 主目录。 当你迁移到 OpenClaw Codex harness，并希望有意识地提升有用的个人 Codex CLI 资产时，请使用此提供商。本地 Codex app-server 启动会使用按智能体配置的 CODEX_HOME 和 HOME 目录，因此默认不会读取你的个人 Codex CLI 状态。 在交互式终端中运行 openclaw migrate codex 会预览完整计划，然后在最终 apply 确认前打开复选框选择器。技能复制项会先提示。使用 Toggle all on 或 Toggle all off 进行批量选择。按空格切换行，或按 Enter 激活高亮行并继续。计划中的技能初始为选中，冲突技能初始为未选中，Skip for now 会跳过本次运行的技能复制，同时仍继续进入插件选择。当源端已安装的精选 Codex 插件可迁移且未提供 --plugin 时，迁移随后会按插件名称提示激活原生 Codex 插件。插件项默认选中，除非目标 OpenClaw Codex 插件配置中已有该插件。现有目标插件初始未选中，并显示类似 conflict: plugin exists 的冲突提示；选择 Toggle all off 可在该次运行中不迁移任何原生 Codex 插件，或选择 Skip for now 在应用前停止。对于脚本化或精确运行，请为每个技能传入一次 --skill <name>，例如： 
openclaw migrate codex --dry-run --skill gog-vault77-google-workspace
openclaw migrate apply codex --yes --skill gog-vault77-google-workspace
使用 --plugin <name> 将原生 Codex 插件迁移以非交互方式限制为一个或多个源端已安装的精选插件： 
openclaw migrate codex --dry-run --plugin google-calendar
openclaw migrate apply codex --yes --plugin google-calendar

​
Codex 导入内容

  • $CODEX_HOME/skills 下的 Codex CLI 技能目录，不包括 Codex 的 .system 缓存。
  • $HOME/.agents/skills 下的个人 AgentSkills；当你希望按智能体拥有时，会复制到当前 OpenClaw Agent 工作区。
  • 通过 Codex app-server plugin/list 发现的源端已安装 openai-curated Codex 插件。规划会为每个已启用的已安装插件读取 plugin/read。由应用支持的插件要求源 Codex app-server 账户响应是 ChatGPT 订阅账户；非 ChatGPT 或缺失的账户响应会以 codex_subscription_required 跳过。默认情况下，迁移不会调用源 app/list，因此通过账户门槛的由应用支持插件会在没有源应用可访问性验证的情况下被纳入计划，账户查找传输失败会以 codex_account_unavailable 跳过。当你希望迁移强制获取新的源 app/list 快照，并要求每个拥有的应用在规划原生激活前存在、启用且可访问时，请传入 --verify-plugin-apps。在该模式下，账户查找传输失败会转入源应用清单验证。源应用清单快照会保留在当前进程的内存中；不会写入迁移输出或目标配置。已禁用插件、不可读的插件详情、受订阅限制的源账户，以及在请求验证时缺失的应用、已禁用的应用、不可访问的应用或源应用清单失败，都会成为带类型原因的手动跳过项，而不是目标配置条目。 apply 会为每个选中的合格插件调用 app-server plugin/install，即使目标 app-server 已报告该插件已安装且已启用。迁移后的 Codex 插件仅可在选择原生 Codex harness 的会话中使用；它们不会暴露给 Pi、常规 OpenAI provider 运行、ACP 对话绑定或其他 harness。

​
手动审核 Codex 状态

Codex config.toml、原生 hooks/hooks.json、非精选 marketplace、并非源端已安装精选插件的缓存插件 bundle，以及未通过源订阅门槛的源端已安装插件，不会自动激活。设置 --verify-plugin-apps 时，未通过源应用清单门槛的插件也会被跳过。它们会被复制到迁移报告中或在其中报告，以供手动审核。 对于迁移的源端已安装精选插件，apply 会写入：
  • plugins.entries.codex.enabled: true
  • plugins.entries.codex.config.codexPlugins.enabled: true
  • plugins.entries.codex.config.codexPlugins.allow_destructive_actions: true
  • 一个显式插件条目，其中包含每个选中插件的 marketplaceName: "openai-curated" 和 pluginName
迁移永远不会写入 plugins["*"]，也永远不会存储本地 marketplace 缓存路径。源端订阅失败会在手动项上以类型化原因报告，例如 codex_subscription_required、codex_account_unavailable、plugin_disabled 或 plugin_read_unavailable。使用 --verify-plugin-apps 时，源应用清单失败也可能显示为 app_inaccessible、app_disabled、app_missing 或 app_inventory_unavailable。跳过的插件不会写入目标配置。 目标端需要认证的安装会在受影响的插件项上报告为 status: "skipped"、reason: "auth_required"，并带有已清理的应用标识符。其显式配置条目会以禁用状态写入，直到你重新授权并启用它们。其他安装失败是限定到项目的 error 结果。 如果规划期间 Codex app-server 插件清单不可用，迁移会回退到缓存 bundle 建议项，而不是使整个迁移失败。

​
Hermes 提供商

内置 Hermes 提供商默认在 ~/.hermes 检测状态。当 Hermes 位于其他位置时，请使用 --from <path>。

​
Hermes 导入内容

  • 来自 config.yaml 的默认模型配置。
  • 来自 providers 和 custom_providers 的已配置模型提供商和自定义 OpenAI 兼容端点。
  • 来自 mcp_servers 或 mcp.servers 的 MCP 服务器定义。
  • 将 SOUL.md 和 AGENTS.md 放入 OpenClaw agent 工作区。
  • 将 memories/MEMORY.md 和 memories/USER.md 追加到工作区记忆文件。
  • OpenClaw 文件记忆的 Memory 配置默认值，以及 Honcho 等外部记忆提供商的归档或人工审阅项。
  • 在 skills/<name>/ 下包含 SKILL.md 文件的 Skills。
  • 来自 skills.config 的各项 Skills 配置值。
  • 来自 .env 的受支持 API 密钥，仅在使用 --include-secrets 时包含。

​
支持的 .env 键

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

​
插件契约

迁移源是插件。插件会在 openclaw.plugin.json 中声明其提供商 ID： 
{
  "contracts": {
    "migrationProviders": ["hermes"]
  }
}
运行时，插件调用 api.registerMigrationProvider(...)。提供商实现 detect、plan 和 apply。核心负责 CLI 编排、备份策略、提示、JSON 输出和冲突预检。核心将已审阅的计划传入 apply(ctx, plan)，并且提供商只能在该参数因兼容性而缺失时重新构建计划。 提供商插件可以使用 openclaw/plugin-sdk/migration 来构造条目和汇总计数，并使用 openclaw/plugin-sdk/migration-runtime 来执行支持冲突感知的文件复制、仅归档报告复制、缓存的配置运行时包装器和迁移报告。

​
新手引导集成

当提供商检测到已知源时，新手引导可以提供迁移。openclaw onboard --flow import 和 openclaw setup --wizard --import-from hermes 都使用同一个插件迁移提供商，并且仍会在应用前显示预览。
新手引导导入需要全新的 OpenClaw 设置。如果你已经有本地状态，请先重置配置、凭证、会话和工作区。带备份后覆盖或合并导入的功能对现有设置启用功能门控。

​
相关内容