Skip to content

build.md

Latest commit

 

History

History
105 lines (74 loc) · 3.51 KB

build.md

File metadata and controls

105 lines (74 loc) · 3.51 KB
Raw

Build and release

This document describes the repository build, test, and release commands.

Default build

make
# same as: make build

The default build:

  1. Builds the Web UI into web/static-dist/.
  2. Builds bin/csgclaw and the host-platform bin/csgclaw-cli.
  3. Builds a static Linux csgclaw-cli for the current CPU architecture into ~/.csgclaw/sandbox-tools/csgclaw-cli.

make build-all is retained as an alias of make build. CSGClaw no longer builds derived PicoClaw/OpenClaw images locally.

Useful targets:

Target Description
make build-server-bin Build bin/csgclaw and host-platform bin/csgclaw-cli
make install-sandbox-cli Build Linux csgclaw-cli into ~/.csgclaw/sandbox-tools
make run Build and run csgclaw serve
make fmt Format Go sources
make test Run go test ./...

Override the sandbox CLI destination with SANDBOX_TOOLS_DIR=/path make install-sandbox-cli.

Windows without make

On Windows hosts that do not have make, use the PowerShell build script:

.\scripts\build.cmd build
.\scripts\build.cmd build-server-bin
.\scripts\build.cmd install-sandbox-cli
.\scripts\build.cmd test

The build.cmd wrapper runs scripts/build.ps1 with -ExecutionPolicy Bypass for the current process only, avoiding machine-wide PowerShell policy changes. If you call the PowerShell script directly, use:

powershell -NoProfile -ExecutionPolicy Bypass -File scripts/build.ps1 build

The default build target mirrors make build:

  1. Builds the Web UI into web/static-dist/.
  2. Builds bin/csgclaw.exe and the host-platform bin/csgclaw-cli.exe.
  3. Builds a Linux csgclaw-cli into ~/.csgclaw/sandbox-tools/csgclaw-cli.

Runtime images

Manager and worker templates have different embedded workspaces but share one image per runtime:

Runtime Fixed image
OpenClaw opencsg-registry.cn-beijing.cr.aliyuncs.com/opencsghq/openclaw:20260610.2-csgclaw
PicoClaw opencsg-registry.cn-beijing.cr.aliyuncs.com/opencsghq/picoclaw:2026.6.10

These refs are stored directly in the builtin agent.toml files. They have no template version field, no generated tag, and no CSGClaw CI image-build workflow.

Web UI

Target Description
make web-install Install dependencies with the pinned pnpm toolchain
make web-dev Start the Vite development server
make build-web Build assets into web/static-dist/

See web development before changing the Vite application.

Packaging and release

Every official csgclaw bundle contains:

csgclaw/
  bin/
    csgclaw[.exe]
    boxlite[.exe]                 # supported platforms only
    csgclaw_dir/
      csgclaw-cli                # Linux, same CPU architecture as the release

The installer copies the sandbox CLI to ~/.csgclaw/sandbox-tools/csgclaw-cli. Runtime startup also synchronizes it from the installed bundle for upgrade compatibility.

Target Description
make package Package the current platform
make package-all Build and package the current platform artifacts
make release Build the configured cross-platform release bundles

Release CI uses .github/workflows/release.yml and .gitlab/ci.yml. GitLab CI publishes CSGClaw release artifacts and the CSGClaw product image; it does not build PicoClaw/OpenClaw runtime images.

Related docs