Skip to content

Commit 9dbdeed

Browse files
committed
update readme
1 parent ce28ca9 commit 9dbdeed

4 files changed

Lines changed: 19 additions & 168 deletions

File tree

README.md

Lines changed: 19 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<div align="center">
22

3-
# 🦀 Claw RS
3+
# 🦀 Claw CR
44

5-
**A modular agent runtime extracted from Claude Code, rebuilt in Rust, and still in active development.**
5+
**The open source coding agent, built in Rust. alternative of ClaudeCode**
66

77
[![Status](https://img.shields.io/badge/status-designing-blue?style=flat-square)](https://github.com/)
88
[![Language](https://img.shields.io/badge/language-Rust-E57324?style=flat-square&logo=rust&logoColor=white)](https://www.rust-lang.org/)
@@ -14,10 +14,15 @@
1414

1515
🚧Early-stage project under active development — not production-ready yet.
1616

17-
⭐ Star us to follow along — a usable version is coming within a month!
18-
19-
<img src="./docs/assets/overview.svg" alt="Project Overview" width="100%" />
17+
⭐ Star us to follow
2018

19+
<div style="text-align:center;">
20+
<img
21+
src="./docs/assets/screenshot_20260408.png"
22+
alt="Project Overview"
23+
width="100%"
24+
style="border-radius: 8px; box-shadow: 0 15px 40px rgba(0,0,0,0.25);object-fit:cover;"
25+
/>
2126
</div>
2227

2328
---
@@ -26,9 +31,7 @@
2631

2732
- [What is This](#-what-is-this)
2833
- [Quick Start](#-quick-start)
29-
- [Why Rebuild in Rust](#-why-rebuild-in-rust)
3034
- [Design Goals](#-design-goals)
31-
- [Roadmap](#-roadmap)
3235
- [Contributing](#-contributing)
3336
- [References](#-references)
3437
- [License](#-license)
@@ -49,96 +52,25 @@ Think of it as an **agent runtime skeleton**:
4952
5053
## 🚀 Quick Start
5154

52-
### Prerequisites
55+
<!-- ### Install -->
5356

54-
- **Rust** 1.75+ ([install](https://rustup.rs/))
55-
- **Model backend** — one of the following:
56-
- [Ollama](https://ollama.com/) (recommended for local development)
57-
- Anthropic API key
57+
No stable release yet — you can build the project from source using the instructions below.
5858

5959
### Build
6060

61-
```bash
62-
git clone <repo-url> && cd rust-clw
63-
cargo build
64-
```
65-
66-
### Run with Ollama (local, no API key needed)
67-
68-
Make sure Ollama is running and has a model pulled:
61+
Make sure you have Rust installed, 1.75+ recommended (via https://rustup.rs/).
6962

7063
```bash
71-
# Pull a model (only needed once)
72-
ollama pull qwen3.5:9b
73-
74-
# Single query
75-
cargo run -- --provider ollama -m "qwen3.5:9b" -q "list files in the current directory"
76-
77-
# Interactive REPL
78-
cargo run -- --provider ollama -m "qwen3.5:9b"
79-
```
80-
81-
Any model with tool-calling support works. Larger models produce better tool-use results:
82-
83-
```bash
84-
cargo run -- --provider ollama -m "qwen3.5:27b" -q "read Cargo.toml and summarize the workspace"
85-
```
86-
87-
### Run with Anthropic API
88-
89-
```bash
90-
export ANTHROPIC_API_KEY="sk-ant-..."
91-
cargo run -- -q "list files in the current directory"
92-
```
93-
94-
### CLI Options
64+
git clone https://github.com/claw-cli/claw-code-rust && cd claw-code-rust
65+
cargo build --release
9566

96-
```text
97-
Usage: clawcr [OPTIONS]
67+
# linux / macos
68+
./target/release/clawcr onboard
9869

99-
Options:
100-
-m, --model <MODEL> Model name (default: auto per provider)
101-
-s, --system <SYSTEM> System prompt
102-
-p, --permission <MODE> Permission mode: auto, interactive, deny
103-
-q, --query <QUERY> Single query (non-interactive), omit for REPL
104-
--provider <PROVIDER> Provider: anthropic, ollama, openai, stub
105-
--ollama-url <URL> Ollama server URL (default: http://localhost:11434)
106-
--max-turns <N> Max turns per conversation (default: 100)
70+
# windows
71+
.\target\release\clawcr onboard
10772
```
10873

109-
### Supported Providers
110-
111-
| Provider | Backend | How to activate |
112-
|----------|---------|-----------------|
113-
| `ollama` | Ollama (local) | `--provider ollama` or auto when no `ANTHROPIC_API_KEY` |
114-
| `anthropic` | Anthropic API | Set `ANTHROPIC_API_KEY` env var |
115-
| `openai` | Any OpenAI-compatible API | `--provider openai` + `OPENAI_BASE_URL` |
116-
| `stub` | No real model (for testing) | `--provider stub` |
117-
118-
## 🤔 Why Rebuild in Rust
119-
120-
Claude Code has excellent engineering quality, but it's a **complete product**, not a reusable runtime library. UI, runtime, tool systems, and state management are deeply intertwined. Reading the source teaches a lot, but extracting parts for reuse is nontrivial.
121-
122-
This project aims to:
123-
124-
- **Decompose** tightly coupled logic into single-responsibility crates
125-
- **Replace** runtime constraints with trait and enum boundaries
126-
- **Transform** "only works inside this project" implementations into **reusable agent components**
127-
128-
## 🎯 Design Goals
129-
130-
1. **Runtime first, product later.** Prioritize solid foundations for Agent loop, Tool, Task, and Permission.
131-
2. **Each crate should be self-explanatory.** Names reveal responsibility, interfaces reveal boundaries.
132-
3. **Make replacement natural.** Tools, model providers, permission policies, and compaction strategies should all be swappable.
133-
4. **Learn from Claude Code's experience** without replicating its UI or internal features.
134-
135-
## 🗺 Roadmap
136-
137-
<div align="center">
138-
<img src="./docs/assets/roadmap.svg" alt="Roadmap" width="100%" />
139-
</div>
140-
141-
14274
## 🤝 Contributing
14375

14476
Contributions are welcome! This project is in its early design phase, and there are many ways to help:
@@ -156,8 +88,4 @@ This project is licensed under the [MIT License](./LICENSE).
15688

15789
---
15890

159-
<div align="center">
160-
16191
**If you find this project useful, please consider giving it a ⭐**
162-
163-
</div>

docs/assets/overview.svg

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/assets/roadmap.svg

Lines changed: 0 additions & 49 deletions
This file was deleted.
151 KB
Loading

0 commit comments

Comments
 (0)