Skip to content

Commit f09e03a

Browse files
Yeachan-HeoYeachan-Heo
committed
docs: sync Rust README with current implementation status
1 parent c3b0e12 commit f09e03a

1 file changed

Lines changed: 76 additions & 66 deletions

File tree

‎rust/README.md‎

Lines changed: 76 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -79,28 +79,29 @@ Primary artifacts:
7979

8080
| Feature | Status |
8181
|---------|--------|
82-
| Anthropic API + streaming | ✅ |
82+
| Anthropic / OpenAI-compatible provider flows + streaming | ✅ |
8383
| OAuth login/logout | ✅ |
8484
| Interactive REPL (rustyline) | ✅ |
8585
| Tool system (bash, read, write, edit, grep, glob) | ✅ |
8686
| Web tools (search, fetch) | ✅ |
87-
| Sub-agent orchestration | ✅ |
87+
| Sub-agent / agent surfaces | ✅ |
8888
| Todo tracking | ✅ |
8989
| Notebook editing | ✅ |
9090
| CLAUDE.md / project memory | ✅ |
91-
| Config file hierarchy (.claude.json) | ✅ |
91+
| Config file hierarchy (`.claw.json` + merged config sections) | ✅ |
9292
| Permission system | ✅ |
93-
| MCP server lifecycle | ✅ |
93+
| MCP server lifecycle + inspection | ✅ |
9494
| Session persistence + resume | ✅ |
95-
| Extended thinking (thinking blocks) | ✅ |
96-
| Cost tracking + usage display | ✅ |
95+
| Cost / usage / stats surfaces | ✅ |
9796
| Git integration | ✅ |
9897
| Markdown terminal rendering (ANSI) | ✅ |
9998
| Model aliases (opus/sonnet/haiku) | ✅ |
100-
| Slash commands (/status, /compact, /clear, etc.) | ✅ |
101-
| Hooks (PreToolUse/PostToolUse) | 🔧 Config only |
102-
| Plugin system | 📋 Planned |
103-
| Skills registry | 📋 Planned |
99+
| Direct CLI subcommands (`status`, `sandbox`, `agents`, `mcp`, `skills`, `doctor`) | ✅ |
100+
| Slash commands (including `/skills`, `/agents`, `/mcp`, `/doctor`, `/plugin`, `/subagent`) | ✅ |
101+
| Hooks (`/hooks`, config-backed lifecycle hooks) | ✅ |
102+
| Plugin management surfaces | ✅ |
103+
| Skills inventory / install surfaces | ✅ |
104+
| Machine-readable JSON output across core CLI surfaces | ✅ |
104105

105106
## Model Aliases
106107

@@ -112,87 +113,96 @@ Short names resolve to the latest model versions:
112113
| `sonnet` | `claude-sonnet-4-6` |
113114
| `haiku` | `claude-haiku-4-5-20251213` |
114115

115-
## CLI Flags
116+
## CLI Flags and Commands
116117

117-
```
118+
Representative current surface:
119+
120+
```text
118121
claw [OPTIONS] [COMMAND]
119122
120-
Options:
121-
--model MODEL Override the active model
122-
--dangerously-skip-permissions Skip all permission checks
123-
--permission-mode MODE Set read-only, workspace-write, or danger-full-access
124-
--allowedTools TOOLS Restrict enabled tools
125-
--output-format FORMAT Non-interactive output format (text or json)
126-
--resume SESSION Re-open a saved session or inspect it with slash commands
127-
--version, -V Print version and build information locally
128-
129-
Commands:
130-
prompt <text> One-shot prompt (non-interactive)
131-
login Authenticate via OAuth
132-
logout Clear stored credentials
133-
init Initialize project config
134-
status Show the current workspace status snapshot
135-
sandbox Show the current sandbox isolation snapshot
136-
agents Inspect agent definitions
137-
mcp Inspect configured MCP servers
138-
skills Inspect installed skills
139-
system-prompt Render the assembled system prompt
123+
Flags:
124+
--model MODEL
125+
--output-format text|json
126+
--permission-mode MODE
127+
--dangerously-skip-permissions
128+
--allowedTools TOOLS
129+
--resume [SESSION.jsonl|session-id|latest]
130+
--version, -V
131+
132+
Top-level commands:
133+
prompt <text>
134+
help
135+
version
136+
status
137+
sandbox
138+
dump-manifests
139+
bootstrap-plan
140+
agents
141+
mcp
142+
skills
143+
system-prompt
144+
login
145+
logout
146+
init
140147
```
141148

142-
For the current canonical help text, run `cargo run -p rusty-claude-cli -- --help`.
149+
The command surface is moving quickly. For the canonical live help text, run:
150+
151+
```bash
152+
cargo run -p rusty-claude-cli -- --help
153+
```
143154

144155
## Slash Commands (REPL)
145156

146157
Tab completion expands slash commands, model aliases, permission modes, and recent session IDs.
147158

148-
| Command | Description |
149-
|---------|-------------|
150-
| `/help` | Show help |
151-
| `/status` | Show session status (model, tokens, cost) |
152-
| `/cost` | Show cost breakdown |
153-
| `/compact` | Compact conversation history |
154-
| `/clear` | Clear conversation |
155-
| `/model [name]` | Show or switch model |
156-
| `/permissions` | Show or switch permission mode |
157-
| `/config [section]` | Show config (env, hooks, model) |
158-
| `/memory` | Show CLAUDE.md contents |
159-
| `/diff` | Show git diff |
160-
| `/export [path]` | Export conversation |
161-
| `/resume [id]` | Resume a saved conversation |
162-
| `/session [id]` | Resume a previous session |
163-
| `/version` | Show version |
164-
165-
See [`../USAGE.md`](../USAGE.md) for examples covering interactive use, JSON automation, sessions, permissions, and the mock parity harness.
159+
The REPL now exposes a much broader surface than the original minimal shell:
160+
161+
- session / visibility: `/help`, `/status`, `/sandbox`, `/cost`, `/resume`, `/session`, `/version`, `/usage`, `/stats`
162+
- workspace / git: `/compact`, `/clear`, `/config`, `/memory`, `/init`, `/diff`, `/commit`, `/pr`, `/issue`, `/export`, `/hooks`, `/files`, `/branch`, `/release-notes`, `/add-dir`
163+
- discovery / debugging: `/mcp`, `/agents`, `/skills`, `/doctor`, `/tasks`, `/context`, `/desktop`, `/ide`
164+
- automation / analysis: `/review`, `/advisor`, `/insights`, `/security-review`, `/subagent`, `/team`, `/telemetry`, `/providers`, `/cron`, and more
165+
- plugin management: `/plugin` (with aliases `/plugins`, `/marketplace`)
166+
167+
Notable claw-first surfaces now available directly in slash form:
168+
- `/skills [list|install <path>|help]`
169+
- `/agents [list|help]`
170+
- `/mcp [list|show <server>|help]`
171+
- `/doctor`
172+
- `/plugin [list|install <path>|enable <name>|disable <name>|uninstall <id>|update <id>]`
173+
- `/subagent [list|steer <target> <msg>|kill <id>]`
174+
175+
See [`../USAGE.md`](../USAGE.md) for usage examples and run `cargo run -p rusty-claude-cli -- --help` for the live canonical command list.
166176

167177
## Workspace Layout
168178

169-
```
179+
```text
170180
rust/
171181
├── Cargo.toml # Workspace root
172182
├── Cargo.lock
173183
└── crates/
174-
├── api/ # Anthropic API client + SSE streaming
175-
├── commands/ # Shared slash-command registry
184+
├── api/ # Provider clients + streaming + request preflight
185+
├── commands/ # Shared slash-command registry + help rendering
176186
├── compat-harness/ # TS manifest extraction harness
177187
├── mock-anthropic-service/ # Deterministic local Anthropic-compatible mock
178-
├── plugins/ # Plugin registry and hook wiring primitives
179-
├── runtime/ # Session, config, permissions, MCP, prompts
188+
├── plugins/ # Plugin metadata, manager, install/enable/disable surfaces
189+
├── runtime/ # Session, config, permissions, MCP, prompts, auth/runtime loop
180190
├── rusty-claude-cli/ # Main CLI binary (`claw`)
181191
├── telemetry/ # Session tracing and usage telemetry types
182-
└── tools/ # Built-in tool implementations
192+
└── tools/ # Built-in tools, skill resolution, tool search, agent runtime surfaces
183193
```
184194

185195
### Crate Responsibilities
186196

187-
- **api** — HTTP client, SSE stream parser, request/response types, auth (API key + OAuth bearer)
188-
- **commands** — Slash command definitions and help text generation
189-
- **compat-harness** — Extracts tool/prompt manifests from upstream TS source
190-
- **mock-anthropic-service** — Deterministic `/v1/messages` mock for CLI parity tests and local harness runs
191-
- **plugins** — Plugin metadata, registries, and hook integration surfaces
192-
- **runtime** — `ConversationRuntime` agentic loop, `ConfigLoader` hierarchy, `Session` persistence, permission policy, MCP client, system prompt assembly, usage tracking
193-
- **rusty-claude-cli** — REPL, one-shot prompt, streaming display, tool call rendering, CLI argument parsing
194-
- **telemetry** — Session trace events and supporting telemetry payloads
195-
- **tools** — Tool specs + execution: Bash, ReadFile, WriteFile, EditFile, GlobSearch, GrepSearch, WebSearch, WebFetch, Agent, TodoWrite, NotebookEdit, Skill, ToolSearch, REPL runtimes
197+
- **api** — provider clients, SSE streaming, request/response types, auth (API key + OAuth bearer), request-size/context-window preflight
198+
- **commands** — slash command definitions, parsing, help text generation, JSON/text command rendering
199+
- **compat-harness** — extracts tool/prompt manifests from upstream TS source
200+
- **mock-anthropic-service** — deterministic `/v1/messages` mock for CLI parity tests and local harness runs
201+
- **plugins** — plugin metadata, install/enable/disable/update flows, plugin tool definitions, hook integration surfaces
202+
- **runtime** — `ConversationRuntime`, config loading, session persistence, permission policy, MCP client lifecycle, system prompt assembly, usage tracking
203+
- **rusty-claude-cli** — REPL, one-shot prompt, direct CLI subcommands, streaming display, tool call rendering, CLI argument parsing
204+
- **telemetry** — session trace events and supporting telemetry payloads
205+
- **tools** — tool specs + execution: Bash, ReadFile, WriteFile, EditFile, GlobSearch, GrepSearch, WebSearch, WebFetch, Agent, TodoWrite, NotebookEdit, Skill, ToolSearch, and runtime-facing tool discovery
196206

197207
## Stats
198208

0 commit comments

Comments
 (0)