bot/docs/start/setup.md at fix/iam-audience-retry

mirror of https://github.com/hanzoai/bot.git synced 2026-10-30 17:24:26 +00:00

Files

T

zeekay 6e661b15d3 rebrand: complete OpenClaw→Hanzo Bot cleanup across 424 files

- Rename lobster extension → flow (dir, types, env vars, docs)
- LOBSTER_* env vars → BOT_FLOW_* / BOT_*
- 🦞 → 🤖 everywhere (src, docs, skills, zh-CN)
- docs.bot.ai → docs.hanzo.bot
- github.com/bot/bot → github.com/hanzoai/bot
- @bot/* → @hanzo/bot-* (npm scope)
- ~/.bot/ → ~/.hanzo/bot/ (config paths)
- discord.gg/hanzo → discord.gg/XthHQQj (real Hanzo Discord)
- clawhub.com → skills.hanzo.bot
- ClawDock → BotDock in shell helpers
- EXFOLIATE lore → Hanzo Bot branding in all locales
- LOBSTER_PALETTE → BOT_PALETTE, LOBSTER_ASCII → BOT_ASCII

2026-02-13 13:22:53 -08:00

4.7 KiB

Raw Permalink Blame History

summary, read_when, title

summary

read_when

title

Advanced setup and development workflows for Hanzo Bot

Setting up a new machine

You want “latest + greatest” without breaking your personal setup

Setup

If you are setting up for the first time, start with [Getting Started](/start/getting-started). For wizard details, see [Onboarding Wizard](/start/wizard).

Last updated: 2026-01-01

TL;DR

Tailoring lives outside the repo: ~/.hanzo/bot/workspace (workspace) + ~/.hanzo/bot/bot.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: ~/.hanzo/bot/bot.json (JSON/JSON5-ish)
Workspace: ~/.hanzo/bot/workspace (skills, prompts, memories; make it a private git repo)

Bootstrap once:

hanzo-bot setup

From inside this repo, use the local CLI entry:

hanzo-bot setup

If you don’t have a global install yet, run it via pnpm hanzo-bot setup.

Run the Gateway from this repo

After pnpm build, you can run the packaged CLI directly:

node bot.mjs gateway --port 18789 --verbose

Stable workflow (macOS app first)

Install + launch Hanzo Bot.app (menu bar).
Complete the onboarding/permissions checklist (TCC prompts).
Ensure Gateway is Local and running (the app manages it).
Link surfaces (example: WhatsApp):

hanzo-bot channels login

Sanity check:

hanzo-bot health

If onboarding is not available in your build:

Run hanzo-bot setup, then hanzo-bot channels login, then start the Gateway manually (hanzo-bot 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 Hanzo Bot.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:

hanzo-bot 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: ~/.hanzo/bot/credentials/
- Sessions: ~/.hanzo/bot/agents/<agentId>/sessions/
- Logs: /tmp/bot/

Credential storage map

Use this when debugging auth or deciding what to back up:

WhatsApp: ~/.hanzo/bot/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: ~/.hanzo/bot/credentials/<channel>-allowFrom.json
Model auth profiles: ~/.hanzo/bot/agents/<agentId>/agent/auth-profiles.json
Legacy OAuth import: ~/.hanzo/bot/credentials/oauth.json More detail: Security.

Updating (without wrecking your setup)

Keep ~/.hanzo/bot/workspace and ~/.hanzo/bot/ as “your stuff”; don’t put personal prompts/config into the bot repo.
Updating source: git pull + pnpm install (when lockfile changed) + keep using pnpm 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.

Gateway runbook (flags, supervision, ports)
Gateway configuration (config schema + examples)
Discord and Telegram (reply tags + replyToMode settings)
Hanzo Bot assistant setup
macOS app (gateway lifecycle)

4.7 KiB Raw Permalink Blame History Unescape Escape