bot/docs/start/getting-started.md at skill/ml-research

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

Files

T

zeekay acaeda400a Eradicate OpenClaw — resolve merge conflicts and finish the rebrand

Three coordinated things:

1. Resolve the committed upstream/main merge conflicts. 94 files were
   sitting with raw <<<<<<< HEAD ... >>>>>>> upstream/main blocks. Every
   conflict had HanzoBot/Bot on HEAD and OpenClaw on upstream. Resolved
   by keeping HEAD everywhere — 540 conflict blocks.

2. Rewrite remaining OpenClaw text refs.
     OPENCLAW   → HANZO_BOT
     OpenClaw   → HanzoBot          (PascalCase type identifiers)
     openclaw   → bot               (codebase convention — botToken,
                                    botUsername etc.; avoids invalid
                                    hyphenated JS identifiers)
     openclaw[_]/openclaw[A-Z] → bot[_]/bot[A-Z]   (compound)
     ai.openclaw.x → ai.hanzo.bot.x  (JVM package path)

3. Delete or rename openclaw-named file paths (116 of them). Dead
   duplicates with a Bot-named canonical from the partial migration:
   deleted. Otherwise renamed.
     ai/openclaw/**           → deleted (ai/hanzo/bot/** canonical)
     Sources/OpenClaw*/       → deleted (Sources/Bot* canonical)
     Tests/OpenClawIPCTests/  → deleted (Tests/BotIPCTests canonical)
     OpenClawKit/             → deleted (BotKit canonical)
     openclaw-tools.*.ts      → deleted (bot-tools.*.ts canonical)
     openclaw-root.ts etc.    → deleted (bot-root.ts canonical)
     types.openclaw.ts        → deleted (types.bot.ts canonical)
     extensions/*/openclaw.plugin.json → renamed hanzo-bot.plugin.json
     docs/start/openclaw.md   → renamed hanzo-bot.md (+ zh-CN)
     docs/assets/openclaw-*.png, whatsapp-openclaw*.jpg → deleted
     scripts/.../openclaw-*   → deleted (bot/hanzo-bot parallels)
     openclaw.mjs             → deleted (hanzo-bot.mjs is package.bin)

Then patched 65 broken JS/TS import strings where hanzo-bot had ended
up inside an import path ('./types.hanzo-bot.js' → './types.bot.js'
etc., since the on-disk filename uses the brand-neutral bot- prefix).

Pre-existing lint debt cleaned up to get oxlint --type-aware to 0/0:
removed the dead i18n test that referenced a path no longer existing;
defined the missing DIDConfig and WalletConfig types in types.base.ts
(they were imported but never declared); dropped unused imports;
collapsed redundant type assertion and a tautological meta.bot lookup
that the openclaw→bot rename made redundant.

The a2ui.bundle.js generated artifact is kept at its pre-rebrand
contents — it gets regenerated by 'pnpm canvas:a2ui:bundle' from
sources I cannot rebuild in this commit; the source side is clean.

Verified: 0 occurrences of openclaw (case-insensitive) in tree source
content, 0 file or directory paths with openclaw in the name; oxlint
--type-aware src test reports 0/0.

2026-05-11 17:56:29 -07:00

3.2 KiB

Raw Permalink Blame History

summary, read_when, title

summary

read_when

title

Get HanzoBot installed and run your first chat in minutes.

First time setup from zero

You want the fastest path to a working chat

Getting Started

Goal: go from zero to a first working chat with minimal setup.

Fastest chat: open the Control UI (no channel setup needed). Run `hanzo-bot dashboard` and chat in the browser, or open `http://127.0.0.1:18789/` on the gateway host. Docs: [Dashboard](/web/dashboard) and [Control UI](/web/control-ui).

Prereqs

Node 22 or newer

Check your Node version with `node --version` if you are unsure.

Quick setup (CLI)

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

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

<Note>
Other install methods and requirements: [Install](/install).
</Note>

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

The wizard configures auth, gateway settings, and optional channels.
See [Onboarding Wizard](/start/wizard) for details.

If you installed the service, it should already be running:

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

```bash hanzo-bot dashboard ``` If the Control UI loads, your Gateway is ready for use.

Optional checks and extras

Useful for quick tests or troubleshooting.

```bash
hanzo-bot gateway --port 18789
```

Requires a configured channel.

```bash
hanzo-bot message send --target +15555550123 --message "Hello from HanzoBot"
```

Useful environment variables

If you run HanzoBot as a service account or want custom config/state locations:

BOT_HOME sets the home directory used for internal path resolution.
BOT_STATE_DIR overrides the state directory.
BOT_CONFIG_PATH overrides the config file path.

Full environment variable reference: Environment vars.

Go deeper

Full CLI wizard reference and advanced options. First run flow for the macOS app.

What you will have

A running Gateway
Auth configured
Control UI access or a connected channel

Next steps

DM safety and approvals: Pairing
Connect more channels: Channels
Advanced workflows and from source: Setup

3.2 KiB Raw Permalink Blame History