Quick Start

Project Positioning

ClawGo is an agent runtime written in Go. The codebase is centered around:

• pkg/agent: main loop, task planning, context building, routing, and recovery
• pkg/tools: built-in tool system
• pkg/api: Gateway HTTP API and WebUI API
• pkg/channels: Telegram, Discord, Feishu, DingTalk, WhatsApp, QQ, and MaixCam
• pkg/cron: scheduled tasks
• pkg/nodes: remote nodes and relay/router logic
• webui: React + Vite operations console

Installation

Option 1: Install Script

curl -fsSL https://raw.githubusercontent.com/YspCoder/clawgo/main/install.sh | bash

The script:

• detects OS and architecture
• downloads the latest release binary
• downloads webui.tar.gz
• installs the WebUI into ~/.clawgo/workspace/webui
• optionally migrates from OpenClaw

Option 2: Build From Source

git clone https://github.com/YspCoder/clawgo.git
cd clawgo
make build

The default binary output is build/clawgo-<platform>-<arch>.

Onboarding

Run this once:

clawgo onboard

It will:

• create ~/.clawgo/config.json
• generate gateway.token
• copy the default workspace template into ~/.clawgo/workspace

Configure A Provider

The most important part is configuring providers and agents.defaults.proxy.

Interactive setup:

clawgo provider

A minimal working example usually looks like:

{
  "agents": {
    "defaults": {
      "proxy": "proxy"
    }
  },
  "providers": {
    "proxy": {
      "api_key": "YOUR_KEY",
      "api_base": "http://localhost:8080/v1",
      "models": ["glm-4.7"],
      "auth": "bearer",
      "timeout_sec": 90
    }
  }
}

Startup Modes

Interactive Agent

clawgo agent

Direct one-shot message:

clawgo agent -m "Hello"

Gateway Mode

clawgo gateway run

This starts the fuller runtime surface:

• Gateway HTTP server
• WebUI API
• Channel manager
• Cron service
• Heartbeat service
• Sentinel

Development Mode

make dev

WebUI

Default URL:

http://<host>:<port>/webui?token=<gateway.token>

The default port is 18790.

First Checks

After startup, run:

clawgo status
clawgo config check

Those two commands give the fastest signal on:

• config availability
• workspace availability
• provider configuration
• log, heartbeat, cron, and node state