mirror of
https://github.com/instructkr/claw-code.git
synced 2026-04-07 00:24:50 +08:00
ac9005bc95
Replace the stale Python-first README narrative, old community links, and leftover branded metadata with the current Rust-first repo guidance. Also align funding handles and asset naming so the public docs point at the canonical ultraworkers/claw-code surface.\n\nConstraint: Scope limited to docs/metadata and branding residue; no runtime behavior changes\nRejected: Add a new CI lint in this pass | outside the requested docs-and-config cleanup scope\nConfidence: medium\nScope-risk: narrow\nReversibility: clean\nDirective: Keep README, funding metadata, and community links aligned with ultraworkers/claw-code and the current UltraWorkers Discord invite\nTested: stale-branding grep across markdown/.github; root doc-link existence checks; cargo fmt --all --check; cargo check --workspace; cargo test --workspace\nNot-tested: cargo clippy --workspace --all-targets -- -D warnings | fails on pre-existing runtime lint debt unrelated to these doc changes
94 lines
3.4 KiB
Markdown
94 lines
3.4 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. Use [`rust/README.md`](./rust/README.md) for crate-level details and [`PARITY.md`](./PARITY.md) for the current Rust-port checkpoint.
|
|
|
|
## 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
|
|
|
|
```bash
|
|
cd rust
|
|
cargo build --workspace
|
|
./target/debug/claw --help
|
|
./target/debug/claw prompt "summarize this repository"
|
|
```
|
|
|
|
Authenticate with either an API key or the built-in OAuth flow:
|
|
|
|
```bash
|
|
export ANTHROPIC_API_KEY="sk-ant-..."
|
|
# or
|
|
cd rust
|
|
./target/debug/claw login
|
|
```
|
|
|
|
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**.
|