Skip to content

README.md

Latest commit

 

History

History
94 lines (68 loc) · 2.42 KB

README.md

File metadata and controls

94 lines (68 loc) · 2.42 KB
Raw

ClawCodex Rust Workspace

This directory contains the Rust implementation of the claw CLI and its supporting crates.

For the quickest onboarding path, use ../USAGE.md. That guide is the copy/paste setup surface for first-time users.

Quick Start

cd rust
cargo build --workspace
./target/debug/claw doctor
./target/debug/claw prompt "say hello"

On Windows PowerShell:

cd .\rust
cargo build --workspace
.\target\debug\claw.exe doctor
.\target\debug\claw.exe prompt "say hello"

What This Workspace Contains

  • api - provider clients, request types, streaming, and auth helpers
  • commands - slash-command registry and help rendering
  • compat-harness - upstream manifest extraction and compatibility surfaces
  • mock-anthropic-service - deterministic local Anthropic-compatible test service
  • plugins - plugin metadata and install/enable/disable flows
  • runtime - session runtime, permissions, config loading, MCP lifecycle, prompts
  • rusty-claude-cli - the claw binary crate
  • telemetry - usage and session telemetry types
  • tools - built-in tool definitions and execution layer

Representative Commands

cargo run -p rusty-claude-cli -- --help
cargo run -p rusty-claude-cli -- doctor
cargo run -p rusty-claude-cli -- prompt "explain this codebase"
cargo run -p rusty-claude-cli -- --output-format json prompt "summarize src/main.rs"

Authentication

Anthropic direct API:

export ANTHROPIC_API_KEY="YOUR_API_KEY_HERE"

Anthropic bearer token:

export ANTHROPIC_AUTH_TOKEN="anthropic-oauth-or-proxy-bearer-token"

OpenAI-compatible or OpenRouter:

export OPENAI_BASE_URL="https://openrouter.ai/api/v1"
export OPENAI_API_KEY="YOUR_API_KEY_HERE"

Mock Parity Harness

cd rust
./scripts/run_mock_parity_harness.sh

Manual mock service startup:

cargo run -p mock-anthropic-service -- --bind 127.0.0.1:0

Verification

This workspace pins Rust in rust-toolchain.toml; install with rustup so local builds and CI use the same compiler.

cargo fmt --all --check
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace

Current Notes

  • The live CLI help still mentions upstream ultraworkers/claw-code in a few places.
  • claw doctor is the best first stop for setup issues.
  • The packaged Windows binary in the repo root is rebuilt by ../build-claw.ps1.