zeekayandhanzo-dev
c7e744fb4f
point the registry at our verdaccio, which proxies and caches all of npm alongside our own scoped packages. lockfiles are untouched: npm and pnpm both honor .npmrc at fetch time, so no re-resolution is needed. Co-authored-by: Hanzo Dev <dev@hanzo.ai>
Hanzo Bot
Hanzo Bot is a personal AI assistant you run on your own machine. It sits behind a local gateway process and answers you on the chat apps you already use — WhatsApp, Telegram, Slack, Discord, Signal, iMessage, Matrix, IRC, Teams and about a dozen more — so the assistant is reachable from your phone without anything of yours leaving your machine.
Install
Node 22 or newer:
npm install -g @hanzo/bot
That gives you two names for the same program, bot and hanzo-bot. Then run the
onboarding wizard, which walks through the gateway, the workspace, your channels and
skills, and installs the gateway as a launchd/systemd user service so it stays up:
hanzo-bot onboard --install-daemon
First things to try
hanzo-bot status # channel health, recent sessions
hanzo-bot agent -m "ship checklist" # one agent turn
hanzo-bot message send --target +15555550123 --message "Hi"
hanzo-bot dashboard # open the control UI
hanzo-bot doctor # health checks and quick fixes
hanzo-bot --help lists every command; each one takes --help of its own. To run the
gateway in the foreground instead of as a service, hanzo-bot gateway run --port 18789.
A note on models: the assistant reads your messages and acts on them, so prompt injection
is a real risk. Use the strongest current model you have access to. hanzo-bot models
manages selection and auth.
From source
git clone https://github.com/hanzoai/bot.git
cd bot
pnpm install
pnpm ui:build
pnpm build
pnpm hanzo-bot onboard --install-daemon
pnpm gateway:watch is the dev loop. There are also Compose files (compose.yml) and
Dockerfiles in the repository if you would rather run it in a container.
Docs
The documentation lives in docs/ in this repository — it is not published to a
website yet, so read it here or with hanzo-bot docs.
- Getting started · Onboarding · Quickstart
- Channels — one page per chat app, including how to connect it
- Concepts — the agent loop, sessions, memory, models, model failover
- CLI reference · Gateway · Installing and updating
- FAQ
SECURITY.md— the trust model, and why DM access is closed by defaultLLM.md— the deep reference for anyone working on the code
Release channels
Stable releases are tagged vYYYY.M.D and published to npm as latest. Prereleases go to
beta, and the moving head of main to dev when published. Switch with
hanzo-bot update --channel stable|beta|dev.
License
MIT — see LICENSE.