Upgrading / Migrating

Post-upgrade checklist and breaking config migrations

OpenClaw releases can include breaking configuration moves. This guide keeps upgrades predictable: back up, upgrade, migrate config with openclaw doctor --fix, and verify the gateway comes up cleanly.

If you only remember one thing: after any upgrade, run openclaw doctor --fix.

Page scope (upgrade niche): This page is for post-install upgrades, migrations, and breaking config changes. For brand-new installation steps use Installation. For full chronological release details use Releases.

Upgrade checklist

  1. Backup your install: openclaw backup create
  2. Upgrade OpenClaw: openclaw update
  3. Migrate config and repair issues: openclaw doctor --fix
  4. Restart and verify: openclaw gateway restart then openclaw doctor

After that, if you use channel plugins (WhatsApp/Telegram/Discord/etc.), re-run your setup wizard steps if needed.

Breaking migrations (most common)

These are frequent “why did it break?” upgrade items. In many cases, openclaw doctor --fix migrates automatically—still verify your resulting config paths.

  • v2026.4.2 — xAI x_search: migrate from legacy core tools.web.x_search.* to plugins.entries.xai.config.xSearch.*; auth standardizes on plugins.entries.xai.config.webSearch.apiKey / XAI_API_KEY.
  • v2026.4.2 — Firecrawl web_fetch: migrate from tools.web.fetch.firecrawl.* to plugins.entries.firecrawl.config.webFetch.*.
  • v2026.3.31 — Nodes / Gateway exec behavior: node shell wrappers were consolidated so node execution uses exec host=node; pairing and trusted-proxy rules affect which requests become allowed.

For full context and additional breaking items, see Releases & Changelog.

Upgrade paths by version

Use this table when jumping across versions and you need a quick “what should I check?” list.

Target version What to verify Command / action
v2026.4.2 xAI x_search and Firecrawl web_fetch config paths moved to plugin-owned keys. openclaw doctor --fix, then verify plugin path keys in config.
v2026.3.31 Node exec behavior and gateway trust/pairing rules tightened; install scanning fails closed by default. Re-check node workflows and pairing/trust settings; use dangerous install override only if intentional.
v2026.3.28 Qwen portal OAuth removed; older legacy config keys may no longer auto-migrate. Move Qwen auth to Model Studio and run openclaw doctor + openclaw doctor --fix.

Need deeper details? See latest breaking changes, v2026.3.31 breaking changes, and v2026.3.28 breaking changes.

Post-upgrade commands

  • openclaw doctor — health checks and reporting
  • openclaw doctor --fix — auto-migrate common issues
  • openclaw gateway restart — apply changes safely
  • openclaw --version — include version when asking for help

If something breaks

Start with Troubleshooting and the FAQ for symptoms like gateway token errors, startup failures, and missing browser integration.

When reporting an issue, include the output of:

Commands
openclaw --version
openclaw doctor

Upgrade FAQ

What should I run after upgrading OpenClaw?

Run openclaw doctor --fix, then openclaw gateway restart, then openclaw doctor.

How do I migrate xAI x_search in v2026.4.2?

Move from tools.web.x_search.* to plugins.entries.xai.config.xSearch.* and verify plugins.entries.xai.config.webSearch.apiKey / XAI_API_KEY.

How do I migrate Firecrawl web_fetch in v2026.4.2?

Move from tools.web.fetch.firecrawl.* to plugins.entries.firecrawl.config.webFetch.*. Use openclaw doctor --fix for automatic migration where possible.

What changed in v2026.3.31 for node execution?

Node shell execution routes through exec host=node with tighter trust/pairing behavior; re-check workflows that relied on older wrapper behavior.

What if OpenClaw still fails after migration?

Use Troubleshooting, check FAQ, and include openclaw --version plus openclaw doctor output in bug reports.

Related