bot/docs/start/onboarding-overview.md at replay/upstream-sync

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

Files

T

zooqueen 071e3f1082 rebrand: openclaw -> hanzo bot across entire codebase

Automated rebrand of all openclaw references to hanzo bot:
- Package: openclaw -> @hanzo/bot
- Binary: openclaw -> hanzo-bot
- Config: ~/.openclaw -> ~/.hanzo/bot
- Docker: ghcr.io/hanzoai/bot
- Env vars: OPENCLAW_* -> BOT_*
- Bundle IDs: ai.hanzo.bot.*
- Product name: Hanzo Bot

2026-03-19 13:52:32 -07:00

2.3 KiB

Raw Permalink Blame History

summary, read_when, title, sidebarTitle

summary

read_when

title

sidebarTitle

Overview of Hanzo Bot onboarding options and flows

Choosing an onboarding path

Setting up a new environment

Onboarding Overview

Hanzo Bot has two onboarding paths. Both configure auth, the Gateway, and optional channels — they just differ in how you interact with the setup.

Which path should I use?

	CLI onboarding	macOS app onboarding
Platforms	macOS, Linux, Windows (native or WSL2)	macOS only
Interface	Terminal wizard	Guided UI in the app
Best for	Servers, headless, full control	Desktop Mac, visual setup
Automation	`--non-interactive` for scripts	Manual only
Command	`hanzo-bot onboard`	Launch the app

Most users should start with CLI onboarding — it works everywhere and gives you the most control.

What onboarding configures

Regardless of which path you choose, onboarding sets up:

Model provider and auth — API key, OAuth, or setup token for your chosen provider
Workspace — directory for agent files, bootstrap templates, and memory
Gateway — port, bind address, auth mode
Channels (optional) — WhatsApp, Telegram, Discord, and more
Daemon (optional) — background service so the Gateway starts automatically

CLI onboarding

Run in any terminal:

openclaw onboard

Add --install-daemon to also install the background service in one step.

Full reference: Onboarding (CLI) CLI command docs: hanzo-bot onboard

macOS app onboarding

Open the Hanzo Bot app. The first-run wizard walks you through the same steps with a visual interface.

Full reference: Onboarding (macOS App)

Custom or unlisted providers

If your provider is not listed in onboarding, choose Custom Provider and enter:

API compatibility mode (OpenAI-compatible, Anthropic-compatible, or auto-detect)
Base URL and API key
Model ID and optional alias

Multiple custom endpoints can coexist — each gets its own endpoint ID.

2.3 KiB Raw Permalink Blame History