Recommended: openclaw update
Detects your install type (npm, pnpm, Bun, or git), fetches the latest version, runs openclaw doctor, and restarts a managed Gateway service.
openclaw update has no --verbose flag (the installer does). For diagnostics use
--dry-run to preview planned actions, --json for structured results, or
openclaw update status --json to inspect channel and availability state.
--channel beta prefers the beta npm dist-tag, but falls back to stable/latest
when the beta tag is missing or its version is older than the latest stable
release. Use --tag beta for a one-off package update pinned to the raw npm
beta dist-tag instead.
A saved update.channel remains the channel for future updates, automatic
checks, and update status. For example, a one-off beta package on a saved stable
channel keeps checking stable afterward. Use --channel beta to subscribe to
beta updates. Plugins still follow the installed core version where required
for compatibility.
--channel extended-stable is package-only, and installation remains
foreground-only. OpenClaw reads the public npm extended-stable selector,
verifies the selected exact package, and installs that exact version. Missing
or inconsistent registry data fails closed; it never falls back to latest.
If the selected version is older than the installed version, the normal
downgrade confirmation still applies. The CLI persists the channel after a
successful core update; a direct
npm install -g openclaw@extended-stable --allow-scripts=openclaw does not
update update.channel, but a final extended-stable package version still
checks only the verified extended-stable selector for update availability.
That direct command is for npm 12 or npm 11.16+. On npm 11.15 and earlier,
omit --allow-scripts=openclaw.
After the core swap, eligible official npm and trusted official ClawHub plugins with bare/default or
latest intent converge to that exact core version. Exact pins and explicit
non-latest tags, third-party plugins, custom registries, and other sources remain unchanged.
Version-bound runtime plugins converge to the base release cohort when the
core is a correction release (for example, YYYY.M.P-2 uses plugin
YYYY.M.P).
Catalog installs created by current OpenClaw versions retain that default
intent. Older records that contain only an exact version remain pinned because
OpenClaw cannot safely distinguish an old automatic pin from a user pin. For npm
installs, run openclaw plugins update @openclaw/name once on the extended-stable
channel to opt that plugin back into exact-core tracking.
--channel dev gives a persistent moving GitHub main checkout. Package
installs reject the --tag main shorthand because the workspace checkout is
not a self-contained package artifact. Use openclaw update --channel dev to
switch to the supported checkout and build flow. Other explicit package specs
keep their package-manager behavior.
After a beta core update, eligible official npm plugins follow the exact installed
beta version, including one-off --tag updates from a stable installation.
For managed plugins, a missing beta release is a warning, not a failure: the
core update can still succeed while a plugin falls back to its recorded
default/latest release.
See Release channels for channel semantics.
From chat
The OpenClaw owner can say “update” (the agent uses thegateway action
update.run) or send /update. Update runs can send these notices in that
chat as the Gateway observes the recorded milestones:
- An acknowledgement when the update is accepted.
⏳ Restarting the gateway now (v<from> → v<to>)…when activation is recorded before the Gateway stops.🔁 Back on v<to>, verifying…when the new Gateway starts verification.- The final report, including successful updates.
sessionKey
is enough; the caller does not need to supply deliveryContext.
The report includes the outcome, recorded phase durations, failed steps,
verification facts, and the next action when needed. A run sends each notice
at most once; an update that stops before restart sends only the notices for
phases it reached. If the update cannot start, the bot records and explains why
and provides the manual command when available.
Chat, CLI, Control UI, and automatic updates share a durable run ID. Use
openclaw update status to read the active or latest report, including after a
restart; --json exposes the activeRun and lastRun records. See
Run history and reports for Gateway history
queries.
The sender must be in commands.ownerAllowFrom.
/update also requires commands.restart (enabled by default).
Agents must never run npm install -g openclaw or stop the Gateway service
from a chat shell; use the update action so restart and notification stay coordinated.
Retire update recovery data
Once you have verified the update and your conversations, preview retained migration originals:openclaw update cleanup. Cleanup never
stops or restarts the Gateway. Confirmation defaults to No; automation must
explicitly pass --yes, including when using --json.
Cleanup permanently gives up rollback to eligible originals, including repaired
branches and old provider metadata. Current SQLite history, operator backups,
and protected or unknown artifacts remain. It is not a substitute for a
pre-update backup. See
Update cleanup for eligibility, JSON output, and
resuming interrupted deletion.
Switch between npm and git installs
Installer-driven switches verify the replacement before the working owner is retired. Source wrappers are published atomically; same-path npm shim transitions use an identity-checked backup that is restored on failure, so a failed candidate leaves the previous command runnable. Theopenclaw update command prints its final success result only after post-core convergence and requested restart health checks succeed.
If a CLI update fails after installing a verified replacement, recovery uses the
newly installed CLI to restart the Gateway it stopped, preserving the managed
service definition. A failure preparing the staging directory, before package
hooks can run, can recover the verified original installation. Package-manager
and lifecycle commands can change configuration or state even in a temporary
prefix. After they start, a rejected staged candidate or a fully restored package
and launcher no longer authorizes automatic restart. Only complete candidate
verification, including the required nonblocking Doctor result, permits activation.
This deliberately limits automatic recovery after hooks; file rollback does not
roll back state. Incomplete file rollback retains its backups for inspection.
If an older target does not support preserving the service definition, automatic
recovery stops and reports the error without retrying with weaker options. Repair
the reported failure, rerun openclaw update, and check openclaw gateway status --deep.
See Failed update recovery.
On macOS, if Doctor reports an installed but unloaded and disabled Gateway
LaunchAgent after an interrupted update, finish update verification or Doctor and
triage first. Then use the printed openclaw gateway start command, preserving
its profile and state/config or custom-label overrides. doctor --fix diagnoses
the disabled label but leaves an already-stopped Gateway stopped.
Use channels to change the install type. The updater keeps your state, config,
credentials, and workspace in ~/.openclaw; it only changes which OpenClaw
code install the CLI and gateway use.
dev ensures a git checkout, builds it, and installs the global CLI from that
checkout. The stable, extended-stable, and beta channels use package
installs. Extended-stable is rejected on a git checkout without mutating or
converting it. If the gateway is already installed, openclaw update refreshes
the service metadata and restarts it unless you pass --no-restart.
Dev updates build the complete runtime, including plugins and the Control UI,
without generating TypeScript declarations. Preflight still validates the
candidate, and the final checkout is rebuilt after checkout or rebase. Ordinary
pnpm build and package builds continue to generate declarations.
For package installs with a managed Gateway service, openclaw update targets
the package root used by that service. If the shell openclaw command comes
from a different install, the updater prints both roots and the managed
service’s Node path, and checks that Node version against the target release’s
engines.node requirement before replacing the package.
Source-checkout servers (reference script)
Teams running a gateway directly from a git checkout on a server can update it withscripts/update-gateway.sh from inside that checkout. It is the reference
for a source-server update: it fails closed on all tracked local changes,
including build outputs, fast-forwards main (or rebases a local server branch
onto origin/main), installs dependencies with a frozen lockfile, builds clean,
and restarts the gateway only after the build succeeds.
This reference script requires Corepack and creates temporary shims without
global activation before fetching. After fetching, it freezes the target commit
and checks that its exact pnpm pin can run through those shims in a private probe
workspace. The probe contains only package-manager metadata, not the target’s
dependencies, hooks, or configuration. Missing or invalid metadata, provisioning
failure, or a version mismatch stops before checkout update or restart; repair
the target pin or install a compatible Corepack, then retry.
The same fetched commit is used for fast-forward or rebase. This is a fetched-target
toolchain preflight, not a complete preflight of a rebased local branch or its
build, and the script does not roll back later install or build failures. Local
branch overrides remain in effect: install and build resolve the resulting
checkout’s pin, which may differ from the probed target pin. Operators must verify
those overrides and maintain a recovery path. The same shim directory leads
nested commands’ PATH, and child workspace and lockfile roots follow each
operation’s directory. Bootstrap, install, or build failure prevents restart.
The hosted installers also support npm-owned temporary provisioning
when Corepack is unavailable; this server script deliberately requires Corepack.
Generated output roots such as dist, dist-runtime, and package-local
dist directories must be real directories. Builds refuse symbolic-link roots
before reading or mutating their contents so cleanup cannot affect the link
target. Replace an output-root symlink with a real directory before updating or
building a source checkout.
openclaw update --channel dev
instead — it manages the checkout, build, and gateway restart for you.
Alternative: re-run the installer
--no-onboard to skip onboarding. To force a specific install type, pass
--install-method git --no-onboard or --install-method npm --no-onboard.
If openclaw triage cannot start after a failed npm package replacement, re-run
the installer. It runs the global package install directly and can recover a
partially updated npm install. Keep an unverified Gateway stopped while repairing it.
--version:
Alternative: manual npm, pnpm, or bun
The npm command below is for npm 12 or npm 11.16+. On npm 11.15 and earlier, omit--allow-scripts=openclaw.
openclaw update for supervised installs: it can coordinate the package
swap with the running Gateway service. If you update manually on a supervised
install, stop the managed Gateway first. Package managers replace files in
place, and a running Gateway can otherwise try to load core or plugin files
mid-swap. Restart the Gateway after the package manager finishes so it picks up
the new install.
For a root-owned Linux system-global install, if openclaw update fails with
EACCES, recover with system npm while keeping the Gateway stopped for the
manual replacement. Use the same profile flags/environment you normally use for
that Gateway. Replace /usr/bin/npm with the system npm that owns the
root-owned global prefix on your host:
The npm command below follows the same version contract: use the flag on npm 12
or npm 11.16+, and omit it on npm 11.15 and earlier.
openclaw update manages a global npm install, it installs the target
into a temporary npm prefix first. The candidate package validates the host
Node version during preinstall; OpenClaw verifies the packaged dist inventory
before swapping the clean package tree into the real global prefix. Pending
lifecycle work is recorded in .openclaw-lifecycle-pending at the package root,
outside the dist inventory. postinstall removes that marker after completion.
If package scripts were skipped, the CLI completes the pending lifecycle before
running any command, including --version; failure stops the command with
reinstall guidance. The updater probes the owning npm before mutation. On npm
11.15 and earlier it omits the unsupported lifecycle-policy flag. On npm 12 and
npm 11.16+, it approves only the candidate OpenClaw lifecycle; transitive
dependency scripts remain unapproved.
This avoids npm overlaying a new package onto stale files from the old one. If
the install command fails, OpenClaw retries once with --omit=optional, which
helps hosts where native optional dependencies cannot compile.
For local tarball targets on npm 12, the archive filename and every parent
directory must be comma-free. See Installer path requirements.
OpenClaw-managed npm update and plugin-update commands also clear npm’s
min-release-age supply-chain quarantine (or the older before config key)
for the child npm process. That policy exists for general protection, but an
explicit OpenClaw update means “install the selected release now.”
global/v11 layout; the layout number does not need to match
the pnpm CLI major version.
If OpenClaw shares a pnpm global install group with another package, the
automatic updater stops before changing the group. Update the original
comma-separated group manually so its sibling packages and build policy stay
intact.
--trust allows OpenClaw’s lifecycle scripts. The canonical openclaw update
path applies the same OpenClaw-only Bun trust when it owns the install.
Package lifecycle and operator state
Package lifecycle hooks validate the Node runtime and update only package-local artifacts: the installeddist tree and lifecycle markers. Plugin-registry and
operator-state migration belong to Doctor, not package installation. Doctor also
removes genuinely dangling global plugin-runtime links, but preserves shared and
versioned runtime caches and valid links to them: other installs or profiles may
still use them. openclaw update still runs Doctor after installing the candidate;
after a manual package replacement, run openclaw doctor --fix before restarting
the Gateway.
OPENCLAW_DISABLE_BUNDLED_PLUGIN_POSTINSTALL=1 skips package-local postinstall
cleanup, but still completes the lifecycle marker. It does not disable Doctor or
Gateway startup migrations.
Advanced npm install topics
Read-only package tree
Read-only package tree
After package lifecycle completion, OpenClaw treats packaged global installs as read-only at runtime, even when the global package directory is writable by the current user. Plugin package installs live in OpenClaw-owned npm/git roots under the user config directory, and Gateway startup does not mutate the OpenClaw package tree.Some Linux npm setups install global packages under root-owned directories such as
/usr/lib/node_modules/openclaw. OpenClaw supports that layout because plugin install/update commands write outside that global package directory.Hardened systemd units
Hardened systemd units
Give OpenClaw write access to its config/state roots so explicit plugin installs, plugin updates, and doctor cleanup can persist their changes:
Disk-space preflight
Disk-space preflight
Before package updates and explicit plugin installs, OpenClaw tries a best-effort disk-space check for the target volume. Low space produces a warning with the checked path, but does not block the update because filesystem quotas, snapshots, and network volumes can change after the check. The actual package-manager install and post-install verification remain authoritative.
Auto-updater
Off by default. Enable it in~/.openclaw/openclaw.json:
/settings/updates) in the Control UI.
Check for updates controls the existing update.checkOnStart setting.
When it is off, Automatic updates is disabled but keeps your saved preference;
turning checks back on resumes discovery and any enabled automatic-update policy.
This does not change your separate feature-statistics preference.
Recorded failures on that page include typed Check status and Retry
update actions when the connected Gateway supports them. See Update
troubleshooting for reason codes, guided
recovery, CLI fallbacks, and diagnostics to collect.
For a dev git install, opening this page refreshes the tracked upstream and
shows whether the checkout is current, ahead, diverged, unavailable, or a
specific number of commits behind. It also shows exact and relative build,
verified install, and last-commit times. Existing checkouts show an unknown
install time until their next verified successful update.
Automatic installation requires a managed Gateway service that can hand off
the update and restart safely. A Gateway running directly in a terminal can
still show update hints, but it does not automatically replace its running
installation. Stop that Gateway, run openclaw update, and launch it again
afterward, or install a managed service for
unattended updates.
Update campaigns
When an automatic update is due, the campaign waits for active work to finish, then starts a one-minute countdown. Once that countdown starts, new work does not reset it or return the campaign to waiting. A 15-minute hard deadline starts the update even if work remains, using the normal restart drain and session-recovery path. Open terminal sessions do not defer the countdown or apply. The Gateway restart ends these process-local PTYs, and terminal sessions are not recovered afterward. An admin can use Hold 1 h once to postpone the campaign and shift its hard deadline, or choose Update now from the sidebar update card or Settings → Updates. For adev git install, the campaign installs the exact
commit it announced. The displayed list previews up to five commits from that
fixed target and does not move if upstream main advances during the countdown.
Every failed apply ends the campaign so the UI does not remain on
Updating…. Failures after a managed-service handoff starts are also recorded
in the restart sentinel and surface after the Gateway returns.
update.checkOnStart: false disables all automatic update checks, feature
statistics, and update notices, even when update.auto.enabled is true.
OPENCLAW_NO_AUTO_UPDATE=1 also disables automatic checks and applies.
External-supervisor mode disables automatic applies; startup update hints can
still run unless update.checkOnStart is also disabled. See
Usage telemetry and update checks for the information
sent by the daily check and optional anonymous feature statistics.
Disabling checks also cancels unfinished discovery and its campaign; a late
response from the previous settings cannot start an update afterward.
Gateway shutdown or replacement cancels unfinished update discovery and waits
for its Git processes and temporary preflight cleanup to settle. Updates already
handed off to the managed service updater remain under that separate updater’s
control.
The gateway also logs an update hint on startup (disable with
update.checkOnStart: false). Stored extended-stable selections use this
read-only hint path and the existing 24-hour hint interval, but never invoke
automatic installation, handoff, restart, stable delay/jitter, or beta polling.
Package-manager updates requested through the live Gateway control-plane
(update.run) do not replace the package tree inside the running Gateway
process. On managed service installs, the Gateway starts a detached handoff,
exits, and lets the normal openclaw update --yes --json CLI path stop the
service, replace the package, refresh service metadata, restart, verify the
Gateway version and reachability, and recover an installed-but-unloaded macOS
LaunchAgent when possible. If the Gateway cannot make that handoff safely,
update.run reports a safe shell command instead of running the package
manager in-process.
When update.run has a routable chat session, the Gateway sends an update
acknowledgement before starting the handoff or in-process update. It waits up to
10 seconds for delivery; a failed chat send does not block the update. The RPC
response includes ackDelivered so clients can distinguish a delivered
acknowledgement from an unavailable or failed route. Restart, verification,
and completion notices follow the durable run state, as described in
From chat.
The Control UI includes its active session in the update request. Any run with an
existing internal/webchat origin session receives its report in that session’s
transcript, whether or not the caller supplied a delivery context. Sessions with
an external delivery route receive a durable notice in that channel. Updates
without an originating session send their notice through the system main
session’s external route when available. Otherwise, recovery keeps the
system-session wake without an outbound chat notice. Session-less recovery never
resumes a supplied continuation as another chat’s turn.
The Control UI sidebar update card shows Update Gateway when it will start
this update.run flow directly. This covers browser-hosted Control UI, remote
Gateways, and manually managed local Gateways.
Manual updates started from the Control UI always ask first. The first click on
the sidebar update card or on Settings → Updates → Update now opens a
confirmation naming the target, the installed and available versions when known,
and the restart impact; it sends nothing until you choose Update and restart.
Cancel, Escape, and dismissing the dialog leave the Gateway untouched. Automatic
campaigns, the CLI, and update.run API clients are unaffected.
After confirmation, the dialog shows the live phase list, step details, and
verification results. It stays open during restart and resumes from the Gateway’s
run record after reconnecting. Success and failure both leave a final report in
the dialog and Settings → Updates. See Control UI updates.
In the signed macOS app, a local app-owned Gateway changes that card to
Update Mac app + Gateway. Sparkle updates the app first; after relaunch, the
app runs openclaw update --tag <app-version> --json, restarts its Gateway,
and verifies health in a setup-style progress window. The window appears only
when that managed Gateway needs update, repair, or installation; app-only updates relaunch
directly into the app. Failure details stay visible with Retry, Update guide, and
Discord actions. The app never uses this coordinated
path for a remote or externally managed Gateway, never downgrades a newer
Gateway, and never overrides an extended-stable channel pin.
When the update succeeds, the app queues a one-time welcome event for the most
recent top-level direct session with a real user/channel interaction. Cron runs,
heartbeats, and background-only session updates do not move that selection. In
remote mode, the app updates only its local Mac node runtime and sends the event
only when the connected remote Gateway is at least as new as the app.
After updating
Rollback
Rollback has two layers:- Reinstall older OpenClaw code while keeping the current state.
- Restore pre-update state only when the older code cannot use a migrated config or database.
Before updating: create a verified backup
openclaw update preserves an automatic pre-update config copy, but it does not
create a full state recovery point. Before a significant update, create one
explicitly:
Roll back a package install
List published versions, then preview and install the known-good version:openclaw update --tag is preferred over a direct package-manager install. It
detects the downgrade, asks for confirmation, runs managed plugin convergence
and compatibility checks against the installed target, refreshes service
metadata, restarts the Gateway, and verifies the running version. If the stored
channel is extended-stable, use
--channel stable --tag <known-good-version> because exact one-off tags cannot
be combined with the extended-stable selector.
Downgrade finalization runs in the installed target when it supports the update
handoff. After successful validation, current targets save the configuration with
their own version, including when a one-off --tag leaves the channel unchanged.
This allows later Gateway restarts without an older-binary override. Older targets
that lack this finalization behavior can still refuse service activation because
the configuration records a newer writer; follow the reported recovery guidance.
Package updates stage and verify the candidate before activation. If the
filesystem swap or command-shim replacement fails, OpenClaw restores the old
package automatically. After a successful swap, a later Gateway health failure
reports the previous version and manual rollback instructions instead of
automatically replacing the package again.
If the CLI update path is unavailable, use the same package manager and install
scope that own the current Gateway:
The npm command below is for npm 12 or npm 11.16+. On npm 11.15 and earlier,
omit --allow-scripts=openclaw.
pnpm add -g --allow-build=openclaw openclaw@<known-good-version> instead. For
a Bun-owned install, use
bun add -g --trust openclaw@<known-good-version>; --trust allows OpenClaw’s
lifecycle scripts. During incident recovery, prevent an enabled auto-updater
from immediately applying a newer release by setting
OPENCLAW_NO_AUTO_UPDATE=1 in the Gateway environment.
Roll back a source checkout
Use a clean checkout and select a known-good tag or commit. First verify that your Corepack bootstrap supports that ref’s pnpm pin as described in Source-checkout servers:git checkout main && git pull.
Before candidate Doctor starts, the updater can return a Git checkout to its
previous branch and SHA after dependency, build, or UI build failure, then verify
its rebuilt runtime. Once Doctor starts, failures retain the candidate: switching
code back cannot undo configuration or database migrations. Inspect the failed
checks before selecting an older commit, and verify that it supports your state.
Downgrading across the session SQLite migration
Before starting an older file-backed OpenClaw release, use the current CLI to restore archived legacy transcript artifacts:Restore state only when necessary
If the older code cannot read a newer config or database schema, stop the Gateway and restore the verified pre-update filesystem, volume, or VM snapshot. Preserve the current state separately before restoring because this removes changes made after the snapshot. Restore a broad archive to a fresh staging directory with the current CLI:OPENCLAW_STATE_DIR at the restored
state asset, run openclaw doctor, then restart.
Treat a state restore as time travel. Ratcheting channel credentials, especially
WhatsApp, can desynchronize and require relinking. Approvals and
delivery/dedupe state roll back too, and plugin node_modules trees are not
archived. See Restore a full archive
for the complete activation and recovery sequence. openclaw backup sqlite restore likewise writes a verified database to a fresh target; activating that
target remains an explicit offline operator step.
Verify the rollback
If you are stuck
Runopenclaw triage in a terminal on the Gateway host, using the printed
installation-specific command or keeping the same profile and state/config
overrides. It opens the first directly launchable coding agent in this order:
Claude Code, Codex, OpenCode, then Pi. The agent receives local diagnostics and
any recorded failed-update outcome so it can repair the installation and verify
Gateway health, using its normal authentication, sandbox, and approval settings.
Use openclaw triage --agent codex to select a particular agent.
Failed interactive updates open triage automatically after updater cleanup and
pass the captured failure to the agent before fresh diagnostics can delay the
handoff. JSON, --yes, and non-interactive update invocations collect diagnostics
and print handoff commands without starting an agent. For diagnostic collection
alone, use openclaw triage --non-interactive; add --update-result <path> to
include a saved update-failure artifact. See Triage for command
formatting and installation targeting.
Keep an unverified Gateway stopped and preserve migrated state during repair.
The failed update retains its nonzero exit code even if the agent repairs it.
- For
openclaw update --channel devon source checkouts, the updater auto-bootstrapspnpmwhen needed. If you see a pnpm/corepack bootstrap error, installpnpmmanually (or re-enablecorepack) and rerun the update. - Check: Troubleshooting
- Ask in Discord: https://discord.gg/clawd
openclaw triage --run
in a terminal on the Gateway host. It checks Doctor lint, then runs up to one
embedded repair turn with time and tool-call limits and checks Doctor again.
It uses the system-agent owner’s model and configured fallbacks before trying
other agents’ authenticated routes. Operator-owned updates and explicit repair requests
replace interactive exec approval with a prompt-free run scoped to the installation
or staged candidate root (fs.workspaceOnly: true), preserving safe-bin and tool
allowlists and refusing explicit exec or repair-tool denies with exec-denied-by-policy
and an openclaw triage external handoff. See Triage
for the repair contract, installation targeting, and validation results.
Related
- Install overview: all installation methods.
- Doctor: health checks after updates.
- Migrating: major version migration guides.