4.3 KiB
summary, read_when
| summary | read_when | ||
|---|---|---|---|
| Setup guide: keep your Moltbot setup tailored while staying up-to-date |
|
Setup
Last updated: 2026-01-01
TL;DR
- Tailoring lives outside the repo:
~/clawd(workspace) +~/.clawdbot/moltbot.json(config). - Stable workflow: install the macOS app; let it run the bundled Gateway.
- Bleeding edge workflow: run the Gateway yourself via
pnpm gateway:watch, then let the macOS app attach in Local mode.
Prereqs (from source)
- Node
>=22 pnpm- Docker (optional; only for containerized setup/e2e — see Docker)
Tailoring strategy (so updates don’t hurt)
If you want “100% tailored to me” and easy updates, keep your customization in:
- Config:
~/.clawdbot/moltbot.json(JSON/JSON5-ish) - Workspace:
~/clawd(skills, prompts, memories; make it a private git repo)
Bootstrap once:
moltbot setup
From inside this repo, use the local CLI entry:
moltbot setup
If you don’t have a global install yet, run it via pnpm moltbot setup.
Stable workflow (macOS app first)
- Install + launch Moltbot.app (menu bar).
- Complete the onboarding/permissions checklist (TCC prompts).
- Ensure Gateway is Local and running (the app manages it).
- Link surfaces (example: WhatsApp):
moltbot channels login
- Sanity check:
moltbot health
If onboarding is not available in your build:
- Run
moltbot setup, thenmoltbot channels login, then start the Gateway manually (moltbot gateway).
Bleeding edge workflow (Gateway in a terminal)
Goal: work on the TypeScript Gateway, get hot reload, keep the macOS app UI attached.
0) (Optional) Run the macOS app from source too
If you also want the macOS app on the bleeding edge:
./scripts/restart-mac.sh
1) Start the dev Gateway
pnpm install
pnpm gateway:watch
gateway:watch runs the gateway in watch mode and reloads on TypeScript changes.
2) Point the macOS app at your running Gateway
In Moltbot.app:
- Connection Mode: Local The app will attach to the running gateway on the configured port.
3) Verify
- In-app Gateway status should read “Using existing gateway …”
- Or via CLI:
moltbot health
Common footguns
- Wrong port: Gateway WS defaults to
ws://127.0.0.1:18789; keep app + CLI on the same port. - Where state lives:
- Credentials:
~/.clawdbot/credentials/ - Sessions:
~/.clawdbot/agents/<agentId>/sessions/ - Logs:
/tmp/moltbot/
- Credentials:
Credential storage map
Use this when debugging auth or deciding what to back up:
- WhatsApp:
~/.clawdbot/credentials/whatsapp/<accountId>/creds.json - Telegram bot token: config/env or
channels.telegram.tokenFile - Discord bot token: config/env (token file not yet supported)
- Slack tokens: config/env (
channels.slack.*) - Pairing allowlists:
~/.clawdbot/credentials/<channel>-allowFrom.json - Model auth profiles:
~/.clawdbot/agents/<agentId>/agent/auth-profiles.json - Legacy OAuth import:
~/.clawdbot/credentials/oauth.jsonMore detail: Security.
Updating (without wrecking your setup)
- Keep
~/clawdand~/.clawdbot/as “your stuff”; don’t put personal prompts/config into themoltbotrepo. - Updating source:
git pull+pnpm install(when lockfile changed) + keep usingpnpm gateway:watch.
Linux (systemd user service)
Linux installs use a systemd user service. By default, systemd stops user services on logout/idle, which kills the Gateway. Onboarding attempts to enable lingering for you (may prompt for sudo). If it’s still off, run:
sudo loginctl enable-linger $USER
For always-on or multi-user servers, consider a system service instead of a user service (no lingering needed). See Gateway runbook for the systemd notes.
Related docs
- Gateway runbook (flags, supervision, ports)
- Gateway configuration (config schema + examples)
- Discord and Telegram (reply tags + replyToMode settings)
- Moltbot assistant setup
- macOS app (gateway lifecycle)