Files
openclaw/docs/install/updating.md

258 lines
7.3 KiB
Markdown
Raw Normal View History

2026-01-06 19:24:33 +01:00
---
2026-01-30 03:15:10 +01:00
summary: "Updating OpenClaw safely (global install or source), plus rollback strategy"
2026-01-06 19:24:33 +01:00
read_when:
2026-01-30 03:15:10 +01:00
- Updating OpenClaw
2026-01-06 19:24:33 +01:00
- Something breaks after an update
title: "Updating"
2026-01-06 19:24:33 +01:00
---
# Updating
2026-01-30 03:15:10 +01:00
OpenClaw is moving fast (pre “1.0”). Treat updates like shipping infra: update → run checks → restart (or use `openclaw update`, which restarts) → verify.
2026-01-06 19:24:33 +01:00
2026-01-13 07:58:47 +00:00
## Recommended: re-run the website installer (upgrade in place)
The **preferred** update path is to re-run the installer from the website. It
2026-01-30 03:15:10 +01:00
detects existing installs, upgrades in place, and runs `openclaw doctor` when
2026-01-13 07:58:47 +00:00
needed.
```bash
curl -fsSL https://openclaw.ai/install.sh | bash
2026-01-13 07:58:47 +00:00
```
Notes:
2026-01-31 21:13:13 +09:00
2026-01-13 07:58:47 +00:00
- Add `--no-onboard` if you dont want the onboarding wizard to run again.
- For **source installs**, use:
2026-01-13 07:58:47 +00:00
```bash
curl -fsSL https://openclaw.ai/install.sh | bash -s -- --install-method git --no-onboard
2026-01-13 07:58:47 +00:00
```
2026-01-13 07:58:47 +00:00
The installer will `git pull --rebase` **only** if the repo is clean.
2026-01-30 03:15:10 +01:00
- For **global installs**, the script uses `npm install -g openclaw@latest` under the hood.
2026-02-02 17:22:22 -06:00
- Legacy note: `clawdbot` remains available as a compatibility shim.
2026-01-13 07:58:47 +00:00
2026-01-06 19:24:33 +01:00
## Before you update
2026-01-13 07:58:47 +00:00
- Know how you installed: **global** (npm/pnpm) vs **from source** (git clone).
- Know how your Gateway is running: **foreground terminal** vs **supervised service** (launchd/systemd).
2026-01-06 19:24:33 +01:00
- Snapshot your tailoring:
2026-01-30 03:15:10 +01:00
- Config: `~/.openclaw/openclaw.json`
- Credentials: `~/.openclaw/credentials/`
- Workspace: `~/.openclaw/workspace`
2026-01-06 19:24:33 +01:00
2026-01-10 21:14:30 +01:00
## Update (global install)
2026-01-06 19:24:33 +01:00
Global install (pick one):
```bash
2026-01-30 03:15:10 +01:00
npm i -g openclaw@latest
2026-01-06 19:24:33 +01:00
```
```bash
2026-01-30 03:15:10 +01:00
pnpm add -g openclaw@latest
2026-01-06 19:24:33 +01:00
```
2026-01-31 21:13:13 +09:00
2026-01-13 07:58:47 +00:00
We do **not** recommend Bun for the Gateway runtime (WhatsApp/Telegram bugs).
2026-01-10 21:14:30 +01:00
2026-01-20 13:33:31 +00:00
To switch update channels (git + npm installs):
2026-01-17 11:40:02 +00:00
```bash
2026-01-30 03:15:10 +01:00
openclaw update --channel beta
openclaw update --channel dev
openclaw update --channel stable
2026-01-17 11:40:02 +00:00
```
Use `--tag <dist-tag|version>` for a one-off install tag/version.
2026-01-20 13:33:31 +00:00
See [Development channels](/install/development-channels) for channel semantics and release notes.
Note: on npm installs, the gateway logs an update hint on startup (checks the current channel tag). Disable via `update.checkOnStart: false`.
### Core auto-updater (optional)
Auto-updater is **off by default** and is a core Gateway feature (not a plugin).
```json
{
"update": {
"channel": "stable",
"auto": {
"enabled": true,
"stableDelayHours": 6,
"stableJitterHours": 12,
"betaCheckIntervalHours": 1
}
}
}
```
Behavior:
- `stable`: when a new version is seen, OpenClaw waits `stableDelayHours` and then applies a deterministic per-install jitter in `stableJitterHours` (spread rollout).
- `beta`: checks on `betaCheckIntervalHours` cadence (default: hourly) and applies when an update is available.
- `dev`: no automatic apply; use manual `openclaw update`.
Use `openclaw update --dry-run` to preview update actions before enabling automation.
2026-01-06 19:24:33 +01:00
Then:
```bash
2026-01-30 03:15:10 +01:00
openclaw doctor
openclaw gateway restart
openclaw health
2026-01-06 19:24:33 +01:00
```
Notes:
2026-01-31 21:13:13 +09:00
2026-01-30 03:15:10 +01:00
- If your Gateway runs as a service, `openclaw gateway restart` is preferred over killing PIDs.
2026-01-06 19:24:33 +01:00
- If youre pinned to a specific version, see “Rollback / pinning” below.
2026-01-30 03:15:10 +01:00
## Update (`openclaw update`)
2026-01-10 20:32:19 +01:00
For **source installs** (git checkout), prefer:
```bash
2026-01-30 03:15:10 +01:00
openclaw update
2026-01-10 20:32:19 +01:00
```
It runs a safe-ish update flow:
2026-01-31 21:13:13 +09:00
2026-01-10 20:32:19 +01:00
- Requires a clean worktree.
2026-01-20 13:33:31 +00:00
- Switches to the selected channel (tag or branch).
- Fetches + rebases against the configured upstream (dev channel).
2026-01-30 03:15:10 +01:00
- Installs deps, builds, builds the Control UI, and runs `openclaw doctor`.
- Restarts the gateway by default (use `--no-restart` to skip).
2026-01-10 20:32:19 +01:00
2026-01-30 03:15:10 +01:00
If you installed via **npm/pnpm** (no git metadata), `openclaw update` will try to update via your package manager. If it cant detect the install, use “Update (global install)” instead.
2026-01-10 20:32:19 +01:00
## Update (Control UI / RPC)
The Control UI has **Update & Restart** (RPC: `update.run`). It:
2026-01-31 21:13:13 +09:00
1. Runs the same source-update flow as `openclaw update` (git checkout only).
2. Writes a restart sentinel with a structured report (stdout/stderr tail).
3. Restarts the gateway and pings the last active session with the report.
If the rebase fails, the gateway aborts and restarts without applying the update.
2026-01-06 19:24:33 +01:00
## Update (from source)
From the repo checkout:
2026-01-10 20:32:19 +01:00
Preferred:
```bash
2026-01-30 03:15:10 +01:00
openclaw update
2026-01-10 20:32:19 +01:00
```
Manual (equivalent-ish):
2026-01-06 19:24:33 +01:00
```bash
git pull
pnpm install
pnpm build
2026-01-09 07:02:42 +00:00
pnpm ui:build # auto-installs UI deps on first run
2026-01-30 03:15:10 +01:00
openclaw doctor
openclaw health
2026-01-06 19:24:33 +01:00
```
Notes:
2026-01-31 21:13:13 +09:00
2026-01-30 03:15:10 +01:00
- `pnpm build` matters when you run the packaged `openclaw` binary ([`openclaw.mjs`](https://github.com/openclaw/openclaw/blob/main/openclaw.mjs)) or use Node to run `dist/`.
- If you run from a repo checkout without a global install, use `pnpm openclaw ...` for CLI commands.
- If you run directly from TypeScript (`pnpm openclaw ...`), a rebuild is usually unnecessary, but **config migrations still apply** → run doctor.
- Switching between global and git installs is easy: install the other flavor, then run `openclaw doctor` so the gateway service entrypoint is rewritten to the current install.
2026-01-06 19:24:33 +01:00
2026-01-30 03:15:10 +01:00
## Always Run: `openclaw doctor`
2026-01-06 19:24:33 +01:00
Doctor is the “safe update” command. Its intentionally boring: repair + migrate + warn.
2026-01-30 03:15:10 +01:00
Note: if youre on a **source install** (git checkout), `openclaw doctor` will offer to run `openclaw update` first.
2026-01-10 21:14:30 +01:00
2026-01-06 19:24:33 +01:00
Typical things it does:
2026-01-31 21:13:13 +09:00
2026-01-06 19:24:33 +01:00
- Migrate deprecated config keys / legacy config file locations.
- Audit DM policies and warn on risky “open” settings.
- Check Gateway health and can offer to restart.
2026-01-30 03:15:10 +01:00
- Detect and migrate older gateway services (launchd/systemd; legacy schtasks) to current OpenClaw services.
2026-01-06 19:24:33 +01:00
- On Linux, ensure systemd user lingering (so the Gateway survives logout).
2026-01-07 02:04:02 +01:00
Details: [Doctor](/gateway/doctor)
2026-01-06 19:24:33 +01:00
## Start / stop / restart the Gateway
CLI (works regardless of OS):
```bash
2026-01-30 03:15:10 +01:00
openclaw gateway status
openclaw gateway stop
openclaw gateway restart
openclaw gateway --port 18789
openclaw logs --follow
2026-01-06 19:24:33 +01:00
```
If youre supervised:
2026-01-31 21:13:13 +09:00
2026-01-30 03:15:10 +01:00
- macOS launchd (app-bundled LaunchAgent): `launchctl kickstart -k gui/$UID/bot.molt.gateway` (use `bot.molt.<profile>`; legacy `com.openclaw.*` still works)
- Linux systemd user service: `systemctl --user restart openclaw-gateway[-<profile>].service`
- Windows (WSL2): `systemctl --user restart openclaw-gateway[-<profile>].service`
- `launchctl`/`systemctl` only work if the service is installed; otherwise run `openclaw gateway install`.
2026-01-06 19:24:33 +01:00
2026-01-06 23:32:12 +00:00
Runbook + exact service labels: [Gateway runbook](/gateway)
2026-01-06 19:24:33 +01:00
## Rollback / pinning (when something breaks)
2026-01-10 21:14:30 +01:00
### Pin (global install)
2026-01-06 19:24:33 +01:00
2026-01-11 04:46:26 +01:00
Install a known-good version (replace `<version>` with the last working one):
2026-01-06 19:24:33 +01:00
```bash
2026-01-30 03:15:10 +01:00
npm i -g openclaw@<version>
2026-01-06 19:24:33 +01:00
```
2026-01-10 21:14:30 +01:00
```bash
2026-01-30 03:15:10 +01:00
pnpm add -g openclaw@<version>
2026-01-10 21:14:30 +01:00
```
2026-01-30 03:15:10 +01:00
Tip: to see the current published version, run `npm view openclaw version`.
2026-01-11 04:46:26 +01:00
2026-01-06 19:24:33 +01:00
Then restart + re-run doctor:
```bash
2026-01-30 03:15:10 +01:00
openclaw doctor
openclaw gateway restart
2026-01-06 19:24:33 +01:00
```
### Pin (source) by date
Pick a commit from a date (example: “state of main as of 2026-01-01”):
```bash
git fetch origin
git checkout "$(git rev-list -n 1 --before=\"2026-01-01\" origin/main)"
```
Then reinstall deps + restart:
```bash
pnpm install
pnpm build
2026-01-30 03:15:10 +01:00
openclaw gateway restart
2026-01-06 19:24:33 +01:00
```
If you want to go back to latest later:
```bash
git checkout main
git pull
```
## If youre stuck
2026-01-30 03:15:10 +01:00
- Run `openclaw doctor` again and read the output carefully (it often tells you the fix).
2026-01-07 02:04:02 +01:00
- Check: [Troubleshooting](/gateway/troubleshooting)
- Ask in Discord: [https://discord.gg/clawd](https://discord.gg/clawd)