bot/docs/install/updating.md

summary, read_when, title

summary	read_when	title
Updating HanzoBot safely (global install or source), plus rollback strategy	Updating HanzoBot Something breaks after an update	Updating

Updating

HanzoBot is moving fast (pre “1.0”). Treat updates like shipping infra: update → run checks → restart (or use hanzo-bot update, which restarts) → 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 hanzo-bot doctor when needed.

curl -fsSL https://hanzo-bot.ai/install.sh | bash

Notes:

• Add --no-onboard if you don’t want the onboarding wizard to run again.

• For source installs, use:

  curl -fsSL https://hanzo-bot.ai/install.sh | bash -s -- --install-method git --no-onboard
  

  The installer will git pull --rebase only if the repo is clean.

• For global installs, the script uses npm install -g hanzo-bot@latest under the hood.

• Legacy note: clawdbot remains available as a compatibility shim.

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: ~/.bot/bot.json
  • Credentials: ~/.bot/credentials/
  • Workspace: ~/.bot/workspace

Update (global install)

Global install (pick one):

npm i -g hanzo-bot@latest

pnpm add -g hanzo-bot@latest

We do not recommend Bun for the Gateway runtime (WhatsApp/Telegram bugs).

To switch update channels (git + npm installs):

hanzo-bot update --channel beta
hanzo-bot update --channel dev
hanzo-bot 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.

Core auto-updater (optional)

Auto-updater is off by default and is a core Gateway feature (not a plugin).

{
  "update": {
    "channel": "stable",
    "auto": {
      "enabled": true,
      "stableDelayHours": 6,
      "stableJitterHours": 12,
      "betaCheckIntervalHours": 1
    }
  }
}

Behavior:

• stable: when a new version is seen, HanzoBot 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 hanzo-bot update.

Use hanzo-bot update --dry-run to preview update actions before enabling automation.

Then:

hanzo-bot doctor
hanzo-bot gateway restart
hanzo-bot health

Notes:

• If your Gateway runs as a service, hanzo-bot gateway restart is preferred over killing PIDs.
• If you’re pinned to a specific version, see “Rollback / pinning” below.

Update (hanzo-bot update)

For source installs (git checkout), prefer:

hanzo-bot update

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 hanzo-bot doctor.
• Restarts the gateway by default (use --no-restart to skip).

If you installed via npm/pnpm (no git metadata), hanzo-bot 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:

1. Runs the same source-update flow as hanzo-bot 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.

Update (from source)

From the repo checkout:

Preferred:

hanzo-bot update

Manual (equivalent-ish):

git pull
pnpm install
pnpm build
pnpm ui:build # auto-installs UI deps on first run
hanzo-bot doctor
hanzo-bot health

Notes:

• pnpm build matters when you run the packaged hanzo-bot binary (hanzo-bot.mjs) or use Node to run dist/.
• If you run from a repo checkout without a global install, use pnpm hanzo-bot ... for CLI commands.
• If you run directly from TypeScript (pnpm hanzo-bot ...), 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 hanzo-bot doctor so the gateway service entrypoint is rewritten to the current install.

Always Run: hanzo-bot doctor

Doctor is the “safe update” command. It’s intentionally boring: repair + migrate + warn.

Note: if you’re on a source install (git checkout), hanzo-bot doctor will offer to run hanzo-bot 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 HanzoBot services.
• On Linux, ensure systemd user lingering (so the Gateway survives logout).

Details: Doctor

Start / stop / restart the Gateway

CLI (works regardless of OS):

hanzo-bot gateway status
hanzo-bot gateway stop
hanzo-bot gateway restart
hanzo-bot gateway --port 18789
hanzo-bot logs --follow

If you’re supervised:

• macOS launchd (app-bundled LaunchAgent): launchctl kickstart -k gui/$UID/ai.hanzo.bot.gateway (use ai.hanzo.bot.<profile>; legacy com.hanzo-bot.* still works)
• Linux systemd user service: systemctl --user restart hanzo-bot-gateway[-<profile>].service
• Windows (WSL2): systemctl --user restart hanzo-bot-gateway[-<profile>].service
  • launchctl/systemctl only work if the service is installed; otherwise run hanzo-bot 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 hanzo-bot@<version>

pnpm add -g hanzo-bot@<version>

Tip: to see the current published version, run npm view hanzo-bot version.

Then restart + re-run doctor:

hanzo-bot doctor
hanzo-bot 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
hanzo-bot gateway restart

If you want to go back to latest later:

git checkout main
git pull

If you’re stuck

• Run hanzo-bot doctor again and read the output carefully (it often tells you the fix).
• Check: Troubleshooting
• Ask in Discord: https://discord.gg/clawd