docs: add updating guide
This commit is contained in:
@@ -20,7 +20,7 @@ It answers you on the surfaces you already use (WhatsApp, Telegram, Slack, Disco
|
|||||||
|
|
||||||
If you want a personal, single-user assistant that feels local, fast, and always-on, this is it.
|
If you want a personal, single-user assistant that feels local, fast, and always-on, this is it.
|
||||||
|
|
||||||
[Website](https://clawdbot.com) · [Docs](https://docs.clawd.bot) · Showcase: [https://docs.clawd.bot/showcase](https://docs.clawd.bot/showcase) · FAQ: [https://docs.clawd.bot/faq](https://docs.clawd.bot/faq) · Wizard: [https://docs.clawd.bot/wizard](https://docs.clawd.bot/wizard) · Nix: [https://github.com/clawdbot/nix-clawdbot](https://github.com/clawdbot/nix-clawdbot) · Docker: [https://docs.clawd.bot/docker](https://docs.clawd.bot/docker) · Discord: [https://discord.gg/clawd](https://discord.gg/clawd)
|
[Website](https://clawdbot.com) · [Docs](https://docs.clawd.bot) · Updating: [https://docs.clawd.bot/updating](https://docs.clawd.bot/updating) · Showcase: [https://docs.clawd.bot/showcase](https://docs.clawd.bot/showcase) · FAQ: [https://docs.clawd.bot/faq](https://docs.clawd.bot/faq) · Wizard: [https://docs.clawd.bot/wizard](https://docs.clawd.bot/wizard) · Nix: [https://github.com/clawdbot/nix-clawdbot](https://github.com/clawdbot/nix-clawdbot) · Docker: [https://docs.clawd.bot/docker](https://docs.clawd.bot/docker) · Discord: [https://discord.gg/clawd](https://discord.gg/clawd)
|
||||||
|
|
||||||
Preferred setup: run the onboarding wizard (`clawdbot onboard`). It walks through gateway, workspace, providers, and skills. The CLI wizard is the recommended path and works on **macOS, Windows, and Linux**.
|
Preferred setup: run the onboarding wizard (`clawdbot onboard`). It walks through gateway, workspace, providers, and skills. The CLI wizard is the recommended path and works on **macOS, Windows, and Linux**.
|
||||||
Works with npm, pnpm, or bun.
|
Works with npm, pnpm, or bun.
|
||||||
@@ -84,7 +84,7 @@ bun run clawdbot send --to +1234567890 --message "Hello from Clawdbot"
|
|||||||
bun run clawdbot agent --message "Ship checklist" --thinking high
|
bun run clawdbot agent --message "Ship checklist" --thinking high
|
||||||
```
|
```
|
||||||
|
|
||||||
Upgrading? `clawdbot doctor`.
|
Upgrading? https://docs.clawd.bot/updating (and run `clawdbot doctor`).
|
||||||
|
|
||||||
If you run from source, prefer `bun run clawdbot …` or `pnpm clawdbot …` (not global `clawdbot`).
|
If you run from source, prefer `bun run clawdbot …` or `pnpm clawdbot …` (not global `clawdbot`).
|
||||||
|
|
||||||
|
|||||||
@@ -131,6 +131,7 @@ Example:
|
|||||||
- [Docs hubs (all pages linked)](https://docs.clawd.bot/hubs)
|
- [Docs hubs (all pages linked)](https://docs.clawd.bot/hubs)
|
||||||
- [FAQ](https://docs.clawd.bot/faq) ← *common questions answered*
|
- [FAQ](https://docs.clawd.bot/faq) ← *common questions answered*
|
||||||
- [Configuration](https://docs.clawd.bot/configuration)
|
- [Configuration](https://docs.clawd.bot/configuration)
|
||||||
|
- [Updating / rollback](https://docs.clawd.bot/updating)
|
||||||
- [Nix mode](https://docs.clawd.bot/nix)
|
- [Nix mode](https://docs.clawd.bot/nix)
|
||||||
- [Clawd personal assistant setup](https://docs.clawd.bot/clawd)
|
- [Clawd personal assistant setup](https://docs.clawd.bot/clawd)
|
||||||
- [Skills](https://docs.clawd.bot/skills)
|
- [Skills](https://docs.clawd.bot/skills)
|
||||||
|
|||||||
138
docs/updating.md
Normal file
138
docs/updating.md
Normal file
@@ -0,0 +1,138 @@
|
|||||||
|
---
|
||||||
|
summary: "Updating Clawdbot safely (npm or source), plus rollback strategy"
|
||||||
|
read_when:
|
||||||
|
- Updating Clawdbot
|
||||||
|
- Something breaks after an update
|
||||||
|
---
|
||||||
|
|
||||||
|
# Updating
|
||||||
|
|
||||||
|
Clawdbot is moving fast (pre “1.0”). Treat updates like shipping infra: update → run checks → restart → verify.
|
||||||
|
|
||||||
|
## Before you update
|
||||||
|
|
||||||
|
- Know how you installed: **npm** (global) vs **from source** (git clone).
|
||||||
|
- Know how your Gateway is running: **foreground terminal** vs **supervised service** (launchd/systemd/Scheduled Task).
|
||||||
|
- Snapshot your tailoring:
|
||||||
|
- Config: `~/.clawdbot/clawdbot.json`
|
||||||
|
- Credentials: `~/.clawdbot/credentials/`
|
||||||
|
- Workspace: `~/clawd`
|
||||||
|
|
||||||
|
## Update (npm install)
|
||||||
|
|
||||||
|
Global install (pick one):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm i -g clawdbot@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm add -g clawdbot@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Then:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
clawdbot doctor
|
||||||
|
clawdbot gateway restart
|
||||||
|
clawdbot health
|
||||||
|
```
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- If your Gateway runs as a service, `clawdbot gateway restart` is preferred over killing PIDs.
|
||||||
|
- If you’re pinned to a specific version, see “Rollback / pinning” below.
|
||||||
|
|
||||||
|
## Update (from source)
|
||||||
|
|
||||||
|
From the repo checkout:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git pull
|
||||||
|
pnpm install
|
||||||
|
pnpm build
|
||||||
|
pnpm ui:install
|
||||||
|
pnpm ui:build
|
||||||
|
pnpm clawdbot doctor
|
||||||
|
pnpm clawdbot health
|
||||||
|
```
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- `pnpm build` matters when you run the packaged `clawdbot` binary (`dist/entry.js`) or use Node to run `dist/`.
|
||||||
|
- If you run directly from TypeScript (`pnpm clawdbot ...` / `bun run clawdbot ...`), a rebuild is usually unnecessary, but **config migrations still apply** → run doctor.
|
||||||
|
|
||||||
|
## Always run: `clawdbot doctor`
|
||||||
|
|
||||||
|
Doctor is the “safe update” command. It’s intentionally boring: repair + migrate + warn.
|
||||||
|
|
||||||
|
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/schtasks) to current Clawdbot services.
|
||||||
|
- On Linux, ensure systemd user lingering (so the Gateway survives logout).
|
||||||
|
|
||||||
|
Details: https://docs.clawd.bot/doctor
|
||||||
|
|
||||||
|
## Start / stop / restart the Gateway
|
||||||
|
|
||||||
|
CLI (works regardless of OS):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
clawdbot gateway stop
|
||||||
|
clawdbot gateway restart
|
||||||
|
clawdbot gateway --port 18789
|
||||||
|
```
|
||||||
|
|
||||||
|
If you’re supervised:
|
||||||
|
- macOS launchd (app-bundled LaunchAgent): `launchctl kickstart -k gui/$UID/com.clawdbot.gateway`
|
||||||
|
- Linux systemd user service: `systemctl --user restart clawdbot-gateway.service`
|
||||||
|
- Windows: restart the `Clawdbot Gateway` Scheduled Task (Task Scheduler)
|
||||||
|
|
||||||
|
Runbook + exact service labels: https://docs.clawd.bot/gateway
|
||||||
|
|
||||||
|
## Rollback / pinning (when something breaks)
|
||||||
|
|
||||||
|
### Pin (npm)
|
||||||
|
|
||||||
|
Install a known-good version:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm i -g clawdbot@2026.1.5-3
|
||||||
|
```
|
||||||
|
|
||||||
|
Then restart + re-run doctor:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
clawdbot doctor
|
||||||
|
clawdbot gateway restart
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
||||||
|
pnpm clawdbot gateway restart
|
||||||
|
```
|
||||||
|
|
||||||
|
If you want to go back to latest later:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git checkout main
|
||||||
|
git pull
|
||||||
|
```
|
||||||
|
|
||||||
|
## If you’re stuck
|
||||||
|
|
||||||
|
- Run `clawdbot doctor` again and read the output carefully (it often tells you the fix).
|
||||||
|
- Check: https://docs.clawd.bot/troubleshooting
|
||||||
|
- Ask in Discord: https://discord.gg/clawd
|
||||||
Reference in New Issue
Block a user