bot/docs/start/getting-started.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

3.2 KiB

Raw Permalink Blame History

summary, read_when, title

summary

read_when

title

Get Hanzo Bot installed and run your first chat in minutes.

First time setup from zero

You want the fastest path to a working chat

Getting Started

Install Hanzo Bot, run onboarding, and chat with your AI assistant — all in about 5 minutes. By the end you will have a running Gateway, configured auth, and a working chat session.

What you need

Node.js — Node 24 recommended (Node 22.16+ also supported)
An API key from a model provider (Anthropic, OpenAI, Google, etc.) — onboarding will prompt you

Check your Node version with `node --version`. **Windows users:** both native Windows and WSL2 are supported. WSL2 is more stable and recommended for the full experience. See [Windows](/platforms/windows). Need to install Node? See [Node setup](/install/node).

Quick setup

```bash curl -fsSL https://hanzo.bot/install.sh | bash ```

```powershell iwr -useb https://hanzo.bot/install.ps1 | iex ```

<Note>
Other install methods (Docker, Nix, npm): [Install](/install).
</Note>

```bash hanzo-bot onboard --install-daemon ```

The wizard walks you through choosing a model provider, setting an API key,
and configuring the Gateway. It takes about 2 minutes.

See [Onboarding (CLI)](/start/wizard) for the full reference.

```bash hanzo-bot gateway status ```

You should see the Gateway listening on port 18789.

```bash hanzo-bot dashboard ```

This opens the Control UI in your browser. If it loads, everything is working.

Type a message in the Control UI chat and you should get an AI reply.

Want to chat from your phone instead? The fastest channel to set up is
[Telegram](/channels/telegram) (just a bot token). See [Channels](/channels)
for all options.

What to do next

WhatsApp, Telegram, Discord, iMessage, and more. Control who can message your agent. Models, tools, sandbox, and advanced settings. Browser, exec, web search, skills, and plugins. If you run Hanzo Bot as a service account or want custom paths:

BOT_HOME — home directory for internal path resolution
BOT_STATE_DIR — override the state directory
BOT_CONFIG_PATH — override the config file path

Full reference: Environment variables.

3.2 KiB Raw Permalink Blame History

Getting Started

What you need

Quick setup

What to do next

3.2 KiB

Raw Permalink Blame History