Install & update
Use the Download page (it detects your OS). After install: Overview.
Which one?
| I want… | Install |
|---|---|
| A chat window | Client — and Agent if the chat runs on this computer |
xiaohe in a terminal, or a local server | Agent |
Local desktop or browser chat needs both. Client alone has no engine; Agent alone has no desktop window.
Client (the window)
- Download page → Xiaohe Client → your platform.
- macOS: open the
.dmg, drag Xiaohe to Applications. First launch may need right-click → Open. - Linux:
sudo dpkg -i Xiaohe_*_amd64.deb. - Windows: run
Xiaohe_*_x64-setup.exe. If SmartScreen appears: More info → Run anyway.
No account is required to install. Pro license (optional) is Settings → Authorization. Usage: Client.
The app updates itself (Settings → Updates). That does not update Agent — use xiaohe upgrade for the engine.
Agent (the engine)
macOS Apple Silicon, Linux x86_64, Windows x86_64.
Windows (easiest)
- Download xiaohe-installer.exe and double-click.
- Walk the wizard: language → runtime → Node.js → Claude (CLI + SDK, ~250MB) → DeepSeek API key → desktop Client (install +
server install/start/pair) → review → Install. Node.js, Claude CLI, Claude SDK, Client, and pairing are checked by default. DeepSeek needs an API key (or uncheck to skip). Uncheck the SDK to fetch it on the first Claude turn instead. - Confirm UAC. If SmartScreen appears: More info → Run anyway.
- Open a new terminal (PATH only applies to new windows).
xiaoheis ready; workspace is%USERPROFILE%\workspace. Reopen the desktop Xiaohe app so it picks up the Session key.
Or paste this in PowerShell (downloads the same exe and starts the wizard):
irm https://download.xiaohe.team/xiaohe-agent/install.ps1 | iex
macOS / Linux
curl -fsSL https://download.xiaohe.team/xiaohe-agent/install.sh | bash
Then open a new terminal if xiaohe is not found.
Finish setup
The Windows wizard already writes PATH, scaffolds ~/workspace, and (if you pasted a key) sets DeepSeek. After that, open a new terminal and run xiaohe.
If you used the PowerShell one-liner, skipped DeepSeek, or an earlier step failed:
xiaohe init
That continues PATH / Node / agent CLI / provider. Interrupted? Run it again. Check with xiaohe doctor.
macOS may need right-click → Open the first time (Gatekeeper).
Update / remove Agent
xiaohe upgrade # public
xiaohe upgrade --beta # soak channel
xiaohe uninstall
After Agent is on PATH
| Goal | Next |
|---|---|
| Terminal chat | xiaohe — Agent CLI |
| Desktop or browser on this computer | Overview (server install → start → pair → paste xh_ses_…) |
| HTTP API | Session API |