mirror of
https://github.com/instructkr/claude-code.git
synced 2026-04-04 02:38:49 +03:00
c0d30934e7
The release-prep docs still framed the workspace as a Rust variant, which understated the owner's current product position. This update rewrites the README title and positioning so Claw Code is presented as the current product surface, while keeping the legal framing clear: Claude Code inspired, implemented clean-room in Rust, and not a direct port or copy. The draft 0.1.0 release notes now mirror that language. Constraint: Docs must reflect the current owner positioning without introducing unsupported product claims Constraint: Legal framing must stay explicit that this is a clean-room Rust implementation, not a direct port or copy Rejected: Leave release notes unchanged | would keep product-positioning language inconsistent across release-facing docs Confidence: high Scope-risk: narrow Reversibility: clean Directive: Keep future release-facing docs aligned on product naming and clean-room positioning before tagging releases Tested: Reviewed README and docs/releases/0.1.0.md after edits; verified only intended docs files were staged Not-tested: cargo check and cargo test (docs-only pass; no code changes)
123 lines
3.9 KiB
Markdown
123 lines
3.9 KiB
Markdown
# Claw Code
|
|
|
|
Claw Code is a local coding-agent CLI implemented in safe Rust. It is **Claude Code inspired** and developed as a **clean-room implementation**: it aims for a strong local agent experience, but it is **not** a direct port or copy of Claude Code.
|
|
|
|
The Rust workspace is the current main product surface. The `claw` binary provides interactive sessions, one-shot prompts, workspace-aware tools, local agent workflows, and plugin-capable operation from a single workspace.
|
|
|
|
## Current status
|
|
|
|
- **Version:** `0.1.0`
|
|
- **Release stage:** initial public release, source-build distribution
|
|
- **Primary implementation:** Rust workspace in this repository
|
|
- **Platform focus:** macOS and Linux developer workstations
|
|
|
|
## Install, build, and run
|
|
|
|
### Prerequisites
|
|
|
|
- Rust stable toolchain
|
|
- Cargo
|
|
- Provider credentials for the model you want to use
|
|
|
|
### Authentication
|
|
|
|
Anthropic-compatible models:
|
|
|
|
```bash
|
|
export ANTHROPIC_API_KEY="..."
|
|
# Optional when using a compatible endpoint
|
|
export ANTHROPIC_BASE_URL="https://api.anthropic.com"
|
|
```
|
|
|
|
Grok models:
|
|
|
|
```bash
|
|
export XAI_API_KEY="..."
|
|
# Optional when using a compatible endpoint
|
|
export XAI_BASE_URL="https://api.x.ai"
|
|
```
|
|
|
|
OAuth login is also available:
|
|
|
|
```bash
|
|
cargo run --bin claw -- login
|
|
```
|
|
|
|
### Install locally
|
|
|
|
```bash
|
|
cargo install --path crates/claw-cli --locked
|
|
```
|
|
|
|
### Build from source
|
|
|
|
```bash
|
|
cargo build --release -p claw-cli
|
|
```
|
|
|
|
### Run
|
|
|
|
From the workspace:
|
|
|
|
```bash
|
|
cargo run --bin claw -- --help
|
|
cargo run --bin claw --
|
|
cargo run --bin claw -- prompt "summarize this workspace"
|
|
cargo run --bin claw -- --model sonnet "review the latest changes"
|
|
```
|
|
|
|
From the release build:
|
|
|
|
```bash
|
|
./target/release/claw
|
|
./target/release/claw prompt "explain crates/runtime"
|
|
```
|
|
|
|
## Supported capabilities
|
|
|
|
- Interactive REPL and one-shot prompt execution
|
|
- Saved-session inspection and resume flows
|
|
- Built-in workspace tools for shell, file read/write/edit, search, web fetch/search, todos, and notebook updates
|
|
- Slash commands for status, compaction, config inspection, diff, export, session management, and version reporting
|
|
- Local agent and skill discovery with `claw agents` and `claw skills`
|
|
- Plugin discovery and management through the CLI and slash-command surfaces
|
|
- OAuth login/logout plus model/provider selection from the command line
|
|
- Workspace-aware instruction/config loading (`CLAW.md`, config files, permissions, plugin settings)
|
|
|
|
## Current limitations
|
|
|
|
- Public distribution is **source-build only** today; this workspace is not set up for crates.io publishing
|
|
- GitHub CI verifies `cargo check`, `cargo test`, and release builds, but automated release packaging is not yet present
|
|
- Current CI targets Ubuntu and macOS; Windows release readiness is still to be established
|
|
- Some live-provider integration coverage is opt-in because it requires external credentials and network access
|
|
- The command surface may continue to evolve during the `0.x` series
|
|
|
|
## Implementation
|
|
|
|
The Rust workspace is the active product implementation. It currently includes these crates:
|
|
|
|
- `claw-cli` — user-facing binary
|
|
- `api` — provider clients and streaming
|
|
- `runtime` — sessions, config, permissions, prompts, and runtime loop
|
|
- `tools` — built-in tool implementations
|
|
- `commands` — slash-command registry and handlers
|
|
- `plugins` — plugin discovery, registry, and lifecycle support
|
|
- `lsp` — language-server protocol support types and process helpers
|
|
- `server` and `compat-harness` — supporting services and compatibility tooling
|
|
|
|
## Roadmap
|
|
|
|
- Publish packaged release artifacts for public installs
|
|
- Add a repeatable release workflow and longer-lived changelog discipline
|
|
- Expand platform verification beyond the current CI matrix
|
|
- Add more task-focused examples and operator documentation
|
|
- Continue tightening feature coverage and UX polish across the Rust implementation
|
|
|
|
## Release notes
|
|
|
|
- Draft 0.1.0 release notes: [`docs/releases/0.1.0.md`](docs/releases/0.1.0.md)
|
|
|
|
## License
|
|
|
|
See the repository root for licensing details.
|