claw-code README

The project's README from github.com/ultraworkers/claw-code. As one markdown file: README.md.

Claw Code

LazyCodex banner Gajae-Code banner

LazyCodex GitHub card Gajae-Code GitHub card

start with the real crab-powered harnesses

github.com/code-yeongyu/lazycodex
github.com/Yeachan-Heo/gajae-code

Open LazyCodex on GitHub Open Gajae-Code on GitHub

Join the harness lab on Discord Join the crab tank on Discord

Join the Discords: ultraworkers discord · gajae-code discord

[!IMPORTANT] Claw Code is not the serious production project here. This repository is closer to a museum exhibit than a product pitch, a crustacean-run artifact kept alive by clawed gajaes, swept and labeled by agents, and automatically maintained according to the harnesses above.

As already described in the project philosophy, this is not meant to be hand-operated like a normal product repo. It is an agent-managed exhibit: the harnesses plan, execute, verify, label, and preserve the artifact while the crabs keep the tank running.

If you want to actually run work, start with LazyCodex or Gajae-Code. If you want to inspect the strange little fossil of the Claw Code moment, continue below.

For the longer public explanation behind this philosophy, see here.

ultraworkers/claw-code · Usage · Rust workspace · Parity · Roadmap · Contributing · Security · UltraWorkers Discord

Star history for ultraworkers/claw-code

Claw Code

Claw Code is the public Rust implementation of the claw CLI agent harness. The canonical implementation lives in rust/, and the current source of truth for this repository is ultraworkers/claw-code.

[!IMPORTANT] Start with USAGE.md for build, auth, CLI, session, and parity-harness workflows. For file submission/navigation questions, see Navigation and file context. For local OpenAI-compatible models and offline skill installs, see Local OpenAI-compatible providers and skills setup. Windows users can jump to the PowerShell-first Windows install and release quickstart. Make claw doctor your first health check after building, use rust/README.md for crate-level details, read PARITY.md for the current Rust-port checkpoint, and see docs/container.md for the container-first workflow.

ACP / Zed status: claw-code does not ship an ACP/Zed daemon or JSON-RPC entrypoint yet. Run claw acp (or claw --acp) for the current status instead of guessing from source layout; claw acp serve is currently a discoverability alias only, returns status with exit code 0, and real ACP support remains tracked separately in ROADMAP.md. For the public JSON contract, see docs/g011-acp-json-rpc-status-contract.md.

Current repository shape

Quick start

[!NOTE] [!WARNING] cargo install claw-code installs the wrong thing. The claw-code crate on crates.io is a deprecated stub that places claw-code-deprecated.exe — not claw. Running it only prints "claw-code has been renamed to agent-code". Do not use cargo install claw-code. Either build from source (this repo) or install the upstream binary:

cargo install agent-code   # upstream binary — installs 'agent.exe' (Windows) / 'agent' (Unix), NOT 'agent-code'

This repo (ultraworkers/claw-code) is build-from-source only — follow the steps below.

# 1. Clone and build
git clone https://github.com/ultraworkers/claw-code
cd claw-code/rust
cargo build --workspace

# 2. Set your API key (Anthropic API key — not a Claude subscription)
export ANTHROPIC_API_KEY="sk-ant-..."

# 3. Verify everything is wired correctly
./target/debug/claw doctor

# 4. Run a prompt
./target/debug/claw prompt "say hello"

# 5. Start an interactive session
./target/debug/claw

[!NOTE] Windows (PowerShell): the binary is claw.exe, not claw. Use .\target\debug\claw.exe or run cargo run -- prompt "say hello" to skip the path lookup.

Windows setup

PowerShell is a supported Windows path. Use whichever shell works for you. The common onboarding issues on Windows are:

  1. Install Rust first — download from https://rustup.rs/ and run the installer. Close and reopen your terminal when it finishes.
  2. Verify Rust is on PATH:
    cargo --version
    
    If this fails, reopen your terminal or run the PATH setup from the Rust installer output, then retry.
  3. Clone and build (works in PowerShell, Git Bash, or WSL):
    git clone https://github.com/ultraworkers/claw-code
    cd claw-code/rust
    cargo build --workspace
    
  4. Run (PowerShell — note .exe and backslash):
    $env:ANTHROPIC_API_KEY = "sk-ant-..."
    .\target\debug\claw.exe prompt "say hello"
    

For release ZIPs, PATH setup, provider switching, and notification smoke checks, see docs/windows-install-release.md.

Git Bash / WSL are optional alternatives, not requirements. If you prefer bash-style paths (/c/Users/you/... instead of C:\Users\you\...), Git Bash (ships with Git for Windows) works well. In Git Bash, the MINGW64 prompt is expected and normal — not a broken install.

Post-build: locate the binary and verify

After running cargo build --workspace, the claw binary is built but not automatically installed to your system. Here's where to find it and how to verify the build succeeded.

Binary location

After cargo build --workspace in claw-code/rust/:

Debug build (default, faster compile):

Release build (optimized, slower compile):

If you ran cargo build without --release, the binary is in the debug/ folder.

Verify the build succeeded

Test the binary directly using its path:

# macOS/Linux (debug build)
./rust/target/debug/claw --help
./rust/target/debug/claw doctor

# Windows PowerShell (debug build)
.\rust\target\debug\claw.exe --help
.\rust\target\debug\claw.exe doctor

PowerShell smoke commands that do not require live credentials:

$env:CLAW_CONFIG_HOME = Join-Path $env:TEMP "claw config home"
New-Item -ItemType Directory -Force -Path $env:CLAW_CONFIG_HOME | Out-Null
Remove-Item Env:\ANTHROPIC_API_KEY, Env:\ANTHROPIC_AUTH_TOKEN, Env:\OPENAI_API_KEY -ErrorAction SilentlyContinue
.\rust\target\debug\claw.exe help
.\rust\target\debug\claw.exe status
.\rust\target\debug\claw.exe config env
.\rust\target\debug\claw.exe doctor

If these commands succeed, the build is working. claw doctor is your first health check — it validates your API key, model access, and tool configuration.

Optional: Add to PATH

If you want to run claw from any directory without the full path, choose one of these approaches:

Option 1: Symlink (macOS/Linux)

ln -s $(pwd)/rust/target/debug/claw /usr/local/bin/claw

Then reload your shell and test:

claw --help

Option 2: Use cargo install (all platforms)

Build and install to Cargo's default location (~/.cargo/bin/, which is usually on PATH):

# From the claw-code/rust/ directory
cargo install --path . --force

# Then from anywhere
claw --help

Option 3: Update shell profile (bash/zsh)

Add this line to ~/.bashrc or ~/.zshrc:

export PATH="$(pwd)/rust/target/debug:$PATH"

Reload your shell:

source ~/.bashrc  # or source ~/.zshrc
claw --help

Troubleshooting

[!NOTE] Auth: claw requires an API key (ANTHROPIC_API_KEY, OPENAI_API_KEY, etc.) — Claude subscription login is not a supported auth path.

Run the workspace test suite after verifying the binary works:

cd rust
cargo test --workspace

Documentation map

Ecosystem

Claw Code is built in the open alongside the broader UltraWorkers toolchain:

Ownership / affiliation disclaimer

claw-code (ultraworkers/claw-code)

Searching Database…

194.9K ·GitHub
这是什么?Claw Code 是 'claw' 的公开 Rust 实现,claw 是一个命令行编程智能体框架。根据其自述文件,它与其说是一款正式的生产工具,不如说是一件由智能体管理的博物馆展品,全程由 AI 智能体和框架维护,没有人工干预。其理念参考了 Claude Code,但与其没有关联。
这是一个真正用于生产的编程工具吗?不是。自述文件本身说明这并非认真的生产项目,并告诉用户如果真想完成工作,应从 LazyCodex 或 Gajae-Code 入手。本仓库则作为一个标明性质、持续维护的产物保留下来。
我该如何安装并运行 claw?仅支持从源代码构建:先安装 Rust,然后构建 rust/ 工作区,生成 claw 二进制文件(Windows 上为 claw.exe)。请勿运行 'cargo install claw-code',那样安装的是已弃用的占位包,而不是真正的命令行工具。
使用它需要 API 密钥吗?需要。claw 要求提供 API 密钥,例如 ANTHROPIC_API_KEY 或 OPENAI_API_KEY;明确不支持使用 Claude 订阅账号登录。
它现在支持 ACP/Zed 集成了吗?暂不支持。claw-code 没有提供 ACP/Zed 守护进程或 JSON-RPC 入口;运行 'claw acp' 目前只会返回一个占位状态,真正的支持仍在路线图中。
这个项目是由人类维护的吗?不是。根据自述文件,LazyCodex 和 Gajae-Code 这些框架会自行规划、执行、验证、标注并保存本仓库,没有人像运营普通产品那样操作它。
它能在 Windows 上运行吗?可以。项目为 Windows 提供了专门的、以 PowerShell 为主的安装和发布快速入门指南,编译后的二进制文件为 claw.exe。
我能用本地模型代替云端 API 吗?可以。文档介绍了如何配置 Ollama、llama.cpp 和 vLLM 等本地 OpenAI 兼容服务提供方,还包括离线安装技能的方法。
LazyCodex 和 Gajae-Code 是什么?它们是更广泛的 UltraWorkers 工具链中正在积极使用的框架,负责真正运行编程智能体的工作。自述文件引导用户去那里,而不是这个展品仓库。
'claw doctor' 是做什么的?这是构建二进制文件后推荐首先运行的健康检查命令,用于在使用命令行工具之前确认安装正常。
UltraWorkers 生态系统还包括哪些内容?与 claw-code 一同开发的相关项目包括 clawhip、oh-my-openagent、oh-my-claudecode、oh-my-codex 和 gajae-code。
Size
26.2 MB
Stars
194.9K
Age
6mo
Commits · 90 Days