ClawGo 文档

Appearance

开发与构建 ​

仓库结构 ​

核心目录建议按下面理解：

  • cmd/clawgo: CLI 与程序入口
  • pkg: 核心业务实现
  • webui: React 控制台
  • workspace: 初始化时复制给用户的默认工作区模版
  • docs: 主仓库自带的说明资源

Go 构建 ​

常用命令：

bash
make build
make build-all
make build-linux-slim
make test

默认构建会把版本与构建时间写入二进制：

  • main.version
  • main.buildTime

WebUI 构建 ​

bash
make build-webui

Makefile 会：

  1. 在 webui/ 下安装依赖
  2. 执行前端 build
  3. 生成 webui/dist

嵌入式资源同步 ​

ClawGo 发布时依赖 Go embed 打包 workspace 模版与 WebUI 静态资源。

相关目标：

bash
make sync-embed-workspace
make sync-embed-workspace-base
make sync-embed-webui
make cleanup-embed-workspace

同步目标目录是：

text
cmd/clawgo/workspace

开发模式 ​

bash
make dev

Makefile 中默认开发参数会偏向：

  • 使用本地 config.json 或 ~/.clawgo/config.json
  • 启动 gateway run
  • 使用工作区和本地 WebUI 目录

发布打包 ​

bash
make package-all

会生成：

  • 各平台二进制压缩包
  • webui.tar.gz
  • checksums.txt

install.sh 的发布约定 ​

安装脚本默认从 GitHub Release 拉取：

  • clawgo-<os>-<arch>.tar.gz
  • webui.tar.gz

因此 release 发布时，二进制和 WebUI 产物必须同时上传。

测试 ​

仓库中已有较多测试，主要覆盖：

  • config 校验
  • channels 去重
  • provider/tool call 协议
  • session planner
  • subagent 配置与路由
  • task watchdog
  • shell timeout
  • memory namespace

建议最少执行：

bash
go test ./...

文档维护建议 ​

如果后续你继续演进项目，建议文档优先跟着这些变更同步：

  • config.go 的 schema 变化
  • cmd/clawgo 新增命令
  • pkg/api/server.go 新增 API
  • pkg/tools 新增内置工具
  • webui/src/pages 新增页面