mirror of
https://github.com/instructkr/claw-code.git
synced 2026-04-10 01:54:49 +08:00
47086c1c14
The previous quick start jumped from 'cargo build' to 'claw prompt' without showing the required auth step or the health-check command. A user following it linearly would fail because the prompt needs an API key. Changes: - Numbered steps: build -> set ANTHROPIC_API_KEY -> claw doctor -> prompt - Windows note updated to show cargo run form as alternative - Added explicit NOTE that Claude subscription login is not supported (pre-empts #claw-code FAQ) Source: cold-start friction observed from mezz/mukduk and kapcomunica in #claw-code 2026-04-09.
103 lines
4.1 KiB
Markdown
103 lines
4.1 KiB
Markdown
# Claw Code
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/ultraworkers/claw-code">ultraworkers/claw-code</a>
|
|
·
|
|
<a href="./USAGE.md">Usage</a>
|
|
·
|
|
<a href="./rust/README.md">Rust workspace</a>
|
|
·
|
|
<a href="./PARITY.md">Parity</a>
|
|
·
|
|
<a href="./ROADMAP.md">Roadmap</a>
|
|
·
|
|
<a href="https://discord.gg/5TUQKqFWd">UltraWorkers Discord</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://star-history.com/#ultraworkers/claw-code&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=ultraworkers/claw-code&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=ultraworkers/claw-code&type=Date" />
|
|
<img alt="Star history for ultraworkers/claw-code" src="https://api.star-history.com/svg?repos=ultraworkers/claw-code&type=Date" width="600" />
|
|
</picture>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="assets/claw-hero.jpeg" alt="Claw Code" width="300" />
|
|
</p>
|
|
|
|
Claw Code is the public Rust implementation of the `claw` CLI agent harness.
|
|
The canonical implementation lives in [`rust/`](./rust), and the current source of truth for this repository is **ultraworkers/claw-code**.
|
|
|
|
> [!IMPORTANT]
|
|
> Start with [`USAGE.md`](./USAGE.md) for build, auth, CLI, session, and parity-harness workflows. Make `claw doctor` your first health check after building, use [`rust/README.md`](./rust/README.md) for crate-level details, read [`PARITY.md`](./PARITY.md) for the current Rust-port checkpoint, and see [`docs/container.md`](./docs/container.md) for the container-first workflow.
|
|
|
|
## Current repository shape
|
|
|
|
- **`rust/`** — canonical Rust workspace and the `claw` CLI binary
|
|
- **`USAGE.md`** — task-oriented usage guide for the current product surface
|
|
- **`PARITY.md`** — Rust-port parity status and migration notes
|
|
- **`ROADMAP.md`** — active roadmap and cleanup backlog
|
|
- **`PHILOSOPHY.md`** — project intent and system-design framing
|
|
- **`src/` + `tests/`** — companion Python/reference workspace and audit helpers; not the primary runtime surface
|
|
|
|
## Quick start
|
|
|
|
> [!NOTE]
|
|
> **`cargo install clawcode` will not work** — this package is not published on crates.io. Build from source as shown below.
|
|
|
|
```bash
|
|
# 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"
|
|
```
|
|
|
|
> [!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.
|
|
|
|
> [!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:
|
|
|
|
```bash
|
|
cd rust
|
|
cargo test --workspace
|
|
```
|
|
|
|
## Documentation map
|
|
|
|
- [`USAGE.md`](./USAGE.md) — quick commands, auth, sessions, config, parity harness
|
|
- [`rust/README.md`](./rust/README.md) — crate map, CLI surface, features, workspace layout
|
|
- [`PARITY.md`](./PARITY.md) — parity status for the Rust port
|
|
- [`rust/MOCK_PARITY_HARNESS.md`](./rust/MOCK_PARITY_HARNESS.md) — deterministic mock-service harness details
|
|
- [`ROADMAP.md`](./ROADMAP.md) — active roadmap and open cleanup work
|
|
- [`PHILOSOPHY.md`](./PHILOSOPHY.md) — why the project exists and how it is operated
|
|
|
|
## Ecosystem
|
|
|
|
Claw Code is built in the open alongside the broader UltraWorkers toolchain:
|
|
|
|
- [clawhip](https://github.com/Yeachan-Heo/clawhip)
|
|
- [oh-my-openagent](https://github.com/code-yeongyu/oh-my-openagent)
|
|
- [oh-my-claudecode](https://github.com/Yeachan-Heo/oh-my-claudecode)
|
|
- [oh-my-codex](https://github.com/Yeachan-Heo/oh-my-codex)
|
|
- [UltraWorkers Discord](https://discord.gg/5TUQKqFWd)
|
|
|
|
## Ownership / affiliation disclaimer
|
|
|
|
- This repository does **not** claim ownership of the original Claude Code source material.
|
|
- This repository is **not affiliated with, endorsed by, or maintained by Anthropic**.
|