Skip to content

Latest commit

 

History

History

README.md

HiClaw Installation

One-click installation script for HiClaw Manager and Worker Agents.

Requirements

  • Docker Desktop (Windows/macOS) or Docker Engine (Linux) must be installed and running
  • PowerShell 7+ (Windows only)

Quick Start

macOS / Linux

bash <(curl -fsSL https://raw.githubusercontent.com/higress-group/hiclaw/main/install/hiclaw-install.sh)

Windows (PowerShell 7+)

Set-ExecutionPolicy Bypass -Scope Process -Force; $wc=New-Object Net.WebClient; $wc.Encoding=[Text.Encoding]::UTF8; iex $wc.DownloadString('https://higress.ai/hiclaw/install.ps1')

Installation Modes

Quick Start (Recommended)

Fast installation with Alibaba Cloud Bailian as the default LLM provider. Just provide your API key and go!

Manual

Customize each option:

  • LLM Provider (Alibaba Cloud Bailian or OpenAI-compatible)
  • Admin credentials
  • Port configuration
  • Domain names
  • GitHub PAT (optional)
  • Data persistence options

Usage

Install Manager

macOS / Linux:

./hiclaw-install.sh manager
# or simply
./hiclaw-install.sh

Windows:

.\hiclaw-install.ps1 manager
# or simply
.\hiclaw-install.ps1

Interactive prompts will ask for:

  • LLM Provider and API Key
  • Admin credentials
  • Domain names (optional, defaults to *-local.hiclaw.io)
  • GitHub PAT (optional)

Install Worker

Workers are created by the Manager Agent through conversation. The Manager provides the exact command to run:

macOS / Linux:

./hiclaw-install.sh worker \
  --name alice \
  --fs http://fs-local.hiclaw.io:18080 \
  --fs-key <ACCESS_KEY> \
  --fs-secret <SECRET_KEY>

Windows:

.\hiclaw-install.ps1 worker `
  -Name alice `
  -Fs http://fs-local.hiclaw.io:18080 `
  -FsKey <ACCESS_KEY> `
  -FsSecret <SECRET_KEY>

Reset Worker

macOS / Linux:

./hiclaw-install.sh worker --reset --name alice \
  --fs http://fs-local.hiclaw.io:18080 \
  --fs-key <ACCESS_KEY> \
  --fs-secret <SECRET_KEY>

Windows:

.\hiclaw-install.ps1 worker -Reset `
  -Name alice `
  -Fs http://fs-local.hiclaw.io:18080 `
  -FsKey <ACCESS_KEY> `
  -FsSecret <SECRET_KEY>

Uninstall

macOS / Linux:

./hiclaw-install.sh uninstall

Windows:

.\hiclaw-install.ps1 uninstall

Non-Interactive Mode (Automation)

Set environment variables to skip prompts:

macOS / Linux:

export HICLAW_NON_INTERACTIVE=1
export HICLAW_LLM_API_KEY="your-api-key"
./hiclaw-install.sh

Windows:

$env:HICLAW_NON_INTERACTIVE = "1"
$env:HICLAW_LLM_API_KEY = "your-api-key"
.\hiclaw-install.ps1

Environment Variables

Variable Description Default
HICLAW_NON_INTERACTIVE Skip all prompts 0
HICLAW_LLM_PROVIDER LLM provider (qwen or openai-compat) qwen
HICLAW_DEFAULT_MODEL Default model ID qwen3.5-plus
HICLAW_LLM_API_KEY LLM API key (required)
HICLAW_ADMIN_USER Admin username admin
HICLAW_ADMIN_PASSWORD Admin password (auto-generated)
HICLAW_PORT_GATEWAY Gateway port 18080
HICLAW_PORT_CONSOLE Higress console port 18001
HICLAW_MATRIX_DOMAIN Matrix domain matrix-local.hiclaw.io:18080
HICLAW_DATA_DIR Data directory Docker volume
HICLAW_WORKSPACE_DIR Manager workspace ~/hiclaw-manager
HICLAW_VERSION Image tag latest
HICLAW_REGISTRY Image registry (auto-detected by timezone)

Platform Notes

Windows

  • Requires PowerShell 7+ (PowerShell Core)
  • Docker Desktop must be running with WSL 2 backend
  • The script uses named pipe (//var/run/docker.sock) for Docker socket mount

macOS

  • Docker Desktop must be running
  • Supports both Intel (amd64) and Apple Silicon (arm64)

Linux

  • Docker Engine or Docker Desktop required
  • Supports both amd64 and arm64 architectures

Post-Installation

After successful installation:

  1. Open the Element Web URL in your browser
  2. Login with your admin credentials
  3. Start chatting with the Manager agent

Mobile Access

You can also access HiClaw from mobile devices using FluffyChat or Element Mobile:

  1. Download FluffyChat or Element on your phone
  2. Set homeserver to: http://<your-lan-ip>:18080
  3. Login with your admin credentials