6.3 KiB
summary, read_when
| summary | read_when | ||
|---|---|---|---|
| Updating Clawdbot safely (global install or source), plus rollback strategy |
|
Updating
Clawdbot is moving fast (pre “1.0”). Treat updates like shipping infra: update → run checks → restart → verify.
Recommended: re-run the website installer (upgrade in place)
The preferred update path is to re-run the installer from the website. It
detects existing installs, upgrades in place, and runs clawdbot doctor when
needed.
curl -fsSL https://clawd.bot/install.sh | bash
Notes:
- Add
--no-onboardif you don’t want the onboarding wizard to run again. - For source installs, use:
The installer will
curl -fsSL https://clawd.bot/install.sh | bash -s -- --install-method git --no-onboardgit pull --rebaseonly if the repo is clean. - For global installs, the script uses
npm install -g clawdbot@latestunder the hood.
Before you update
- 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).
- Snapshot your tailoring:
- Config:
~/.clawdbot/clawdbot.json - Credentials:
~/.clawdbot/credentials/ - Workspace:
~/clawd
- Config:
Update (global install)
Global install (pick one):
npm i -g clawdbot@latest
pnpm add -g clawdbot@latest
We do not recommend Bun for the Gateway runtime (WhatsApp/Telegram bugs).
To switch update channels (git + npm installs):
clawdbot update --channel beta
clawdbot update --channel dev
clawdbot update --channel stable
Use --tag <dist-tag|version> for a one-off install tag/version.
See 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.
Then:
clawdbot doctor
clawdbot gateway restart
clawdbot health
Notes:
- If your Gateway runs as a service,
clawdbot gateway restartis preferred over killing PIDs. - If you’re pinned to a specific version, see “Rollback / pinning” below.
Update (clawdbot update)
For source installs (git checkout), prefer:
clawdbot update --restart
It runs a safe-ish update flow:
- Requires a clean worktree.
- Switches to the selected channel (tag or branch).
- Fetches + rebases against the configured upstream (dev channel).
- Installs deps, builds, builds the Control UI, and runs
clawdbot doctor.
If you installed via npm/pnpm (no git metadata), clawdbot update will try to update via your package manager. If it can’t detect the install, use “Update (global install)” instead.
Update (Control UI / RPC)
The Control UI has Update & Restart (RPC: update.run). It:
- Runs the same source-update flow as
clawdbot update(git checkout only). - Writes a restart sentinel with a structured report (stdout/stderr tail).
- 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.
Update (from source)
From the repo checkout:
Preferred:
clawdbot update
Manual (equivalent-ish):
git pull
pnpm install
pnpm build
pnpm ui:build # auto-installs UI deps on first run
clawdbot doctor
clawdbot health
Notes:
pnpm buildmatters when you run the packagedclawdbotbinary (dist/entry.js) or use Node to rundist/.- If you run from a repo checkout without a global install, use
pnpm clawdbot ...for CLI commands. - If you run directly from TypeScript (
pnpm clawdbot ...), 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
clawdbot doctorso the gateway service entrypoint is rewritten to the current install.
Always run: clawdbot doctor
Doctor is the “safe update” command. It’s intentionally boring: repair + migrate + warn.
Note: if you’re on a source install (git checkout), clawdbot doctor will offer to run clawdbot update first.
Typical things it does:
- 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.
- Detect and migrate older gateway services (launchd/systemd; legacy schtasks) to current Clawdbot services.
- On Linux, ensure systemd user lingering (so the Gateway survives logout).
Details: Doctor
Start / stop / restart the Gateway
CLI (works regardless of OS):
clawdbot gateway status
clawdbot gateway stop
clawdbot gateway restart
clawdbot gateway --port 18789
clawdbot logs --follow
If you’re supervised:
- macOS launchd (app-bundled LaunchAgent):
launchctl kickstart -k gui/$UID/com.clawdbot.gateway(usecom.clawdbot.<profile>if set) - Linux systemd user service:
systemctl --user restart clawdbot-gateway[-<profile>].service - Windows (WSL2):
systemctl --user restart clawdbot-gateway[-<profile>].servicelaunchctl/systemctlonly work if the service is installed; otherwise runclawdbot gateway install.
Runbook + exact service labels: Gateway runbook
Rollback / pinning (when something breaks)
Pin (global install)
Install a known-good version (replace <version> with the last working one):
npm i -g clawdbot@<version>
pnpm add -g clawdbot@<version>
Tip: to see the current published version, run npm view clawdbot version.
Then restart + re-run doctor:
clawdbot doctor
clawdbot gateway restart
Pin (source) by date
Pick a commit from a date (example: “state of main as of 2026-01-01”):
git fetch origin
git checkout "$(git rev-list -n 1 --before=\"2026-01-01\" origin/main)"
Then reinstall deps + restart:
pnpm install
pnpm build
clawdbot gateway restart
If you want to go back to latest later:
git checkout main
git pull
If you’re stuck
- Run
clawdbot doctoragain and read the output carefully (it often tells you the fix). - Check: Troubleshooting
- Ask in Discord: https://channels.discord.gg/clawd