mirror of
https://github.com/instructkr/claw-code.git
synced 2026-04-03 18:24:48 +08:00
Compare commits
46 Commits
rcc/subage
...
a9efc734d5
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a9efc734d5 | ||
|
|
f509d569ae | ||
|
|
8ae96376a2 | ||
|
|
486fccfa3e | ||
|
|
7464302fd3 | ||
|
|
0755a36811 | ||
|
|
7f33569f3a | ||
|
|
24fea5db9e | ||
|
|
782d9cea71 | ||
|
|
97d725d5e5 | ||
|
|
d794acd3f4 | ||
|
|
4c1eaa16e0 | ||
|
|
13851d800f | ||
|
|
9e717192f8 | ||
|
|
6584ed1ad7 | ||
|
|
46abf52143 | ||
|
|
28be7b3e24 | ||
|
|
a10bbaf8de | ||
|
|
f967484b9a | ||
|
|
6520cf8c3f | ||
|
|
5f66392f45 | ||
|
|
123a7f4013 | ||
|
|
0db9660727 | ||
|
|
e488e94307 | ||
|
|
f8d4da3e68 | ||
|
|
8f6d8db958 | ||
|
|
7b17b037cb | ||
|
|
b905b611f0 | ||
|
|
c38eac7a90 | ||
|
|
197065bfc8 | ||
|
|
555a245456 | ||
|
|
9efd029e26 | ||
|
|
eb89fc95e7 | ||
|
|
94199beabb | ||
|
|
9ade3a70d7 | ||
|
|
91ab8ea9d9 | ||
|
|
992681c4fd | ||
|
|
77427245c1 | ||
|
|
ac6c5d00a8 | ||
|
|
a94ef61b01 | ||
|
|
a9ac7e5bb8 | ||
|
|
0175ee0a90 | ||
|
|
705c62257c | ||
|
|
1bd0eef368 | ||
|
|
04b1f1e85d | ||
|
|
ac95f0387c |
5
.claude.json
Normal file
5
.claude.json
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"permissions": {
|
||||||
|
"defaultMode": "dontAsk"
|
||||||
|
}
|
||||||
|
}
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -2,3 +2,6 @@ __pycache__/
|
|||||||
archive/
|
archive/
|
||||||
.omx/
|
.omx/
|
||||||
.clawd-agents/
|
.clawd-agents/
|
||||||
|
# Claude Code local artifacts
|
||||||
|
.claude/settings.local.json
|
||||||
|
.claude/sessions/
|
||||||
|
|||||||
21
CLAUDE.md
Normal file
21
CLAUDE.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# CLAUDE.md
|
||||||
|
|
||||||
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||||
|
|
||||||
|
## Detected stack
|
||||||
|
- Languages: Rust.
|
||||||
|
- Frameworks: none detected from the supported starter markers.
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
- Run Rust verification from `rust/`: `cargo fmt`, `cargo clippy --workspace --all-targets -- -D warnings`, `cargo test --workspace`
|
||||||
|
- `src/` and `tests/` are both present; update both surfaces together when behavior changes.
|
||||||
|
|
||||||
|
## Repository shape
|
||||||
|
- `rust/` contains the Rust workspace and active CLI/runtime implementation.
|
||||||
|
- `src/` contains source files that should stay consistent with generated guidance and tests.
|
||||||
|
- `tests/` contains validation surfaces that should be reviewed alongside code changes.
|
||||||
|
|
||||||
|
## Working agreement
|
||||||
|
- Prefer small, reviewable changes and keep generated bootstrap files aligned with actual repo workflows.
|
||||||
|
- Keep shared defaults in `.claude.json`; reserve `.claude/settings.local.json` for machine-local overrides.
|
||||||
|
- Do not overwrite existing `CLAUDE.md` content automatically; update it intentionally when repo workflows change.
|
||||||
1
rust/.claude/sessions/session-1775010333630.json
Normal file
1
rust/.claude/sessions/session-1775010333630.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"messages":[{"blocks":[{"text":"hello use bash tool for testing","type":"text"}],"role":"user"},{"blocks":[{"text":"\n\nHello! I'm ready to help. Let me run a quick bash command to confirm everything is working:","type":"text"},{"id":"toolu_01EuTzVfUK7iPRBvjZAovzfV","input":"{\"command\": \"echo \\\"Hello! Bash tool is working. 🎉\\\" && date && pwd\"}","name":"bash","type":"tool_use"}],"role":"assistant","usage":{"cache_creation_input_tokens":0,"cache_read_input_tokens":0,"input_tokens":4277,"output_tokens":92}},{"blocks":[{"is_error":false,"output":"{\n \"stdout\": \"Hello! Bash tool is working. 🎉\\nWed Apr 1 02:25:46 AM UTC 2026\\n/home/bellman/Workspace/clawd-code/rust\\n\",\n \"stderr\": \"\",\n \"rawOutputPath\": null,\n \"interrupted\": false,\n \"isImage\": null,\n \"backgroundTaskId\": null,\n \"backgroundedByUser\": null,\n \"assistantAutoBackgrounded\": null,\n \"dangerouslyDisableSandbox\": null,\n \"returnCodeInterpretation\": null,\n \"noOutputExpected\": false,\n \"structuredContent\": null,\n \"persistedOutputPath\": null,\n \"persistedOutputSize\": null,\n \"sandboxStatus\": {\n \"enabled\": true,\n \"requested\": {\n \"enabled\": true,\n \"namespace_restrictions\": true,\n \"network_isolation\": false,\n \"filesystem_mode\": \"workspace-only\",\n \"allowed_mounts\": []\n },\n \"supported\": true,\n \"active\": true,\n \"namespace_supported\": true,\n \"namespace_active\": true,\n \"network_supported\": true,\n \"network_active\": false,\n \"filesystem_mode\": \"workspace-only\",\n \"filesystem_active\": true,\n \"allowed_mounts\": [],\n \"in_container\": false,\n \"container_markers\": [],\n \"fallback_reason\": null\n }\n}","tool_name":"bash","tool_use_id":"toolu_01EuTzVfUK7iPRBvjZAovzfV","type":"tool_result"}],"role":"tool"},{"blocks":[{"text":"Bash tool is working perfectly! ✅\n\nHere's a quick summary:\n- **Status**: Operational 🎉\n- **Date**: Wed Apr 1, 2026\n- **Working directory**: `/home/bellman/Workspace/clawd-code/rust`\n- **Sandbox**: Enabled and active\n\nHow can I help you today?","type":"text"}],"role":"assistant","usage":{"cache_creation_input_tokens":0,"cache_read_input_tokens":0,"input_tokens":4746,"output_tokens":84}}],"version":1}
|
||||||
1
rust/.claude/sessions/session-1775010384918.json
Normal file
1
rust/.claude/sessions/session-1775010384918.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"messages":[{"blocks":[{"text":"who are you?","type":"text"}],"role":"user"},{"blocks":[{"text":"I'm **Claude**, an AI assistant built by Anthropic, currently running as a **Claude Code agent** (Claude Opus 4.6). I'm set up in your workspace at `/home/bellman/Workspace/clawd-code/rust` with the **oh-my-claudecode (OMC)** orchestration layer active.\n\nHere's what I can help you with:\n\n- **Software engineering tasks** — reading, writing, and refactoring code\n- **Debugging** — diagnosing issues, running tests, tracing errors\n- **Research & planning** — exploring codebases, understanding architecture, planning changes\n- **Shell commands** — building, testing, running tools in your environment\n- **Multi-agent workflows** — delegating specialized work (reviews, deep analysis, etc.) via OMC\n\nI have access to your local filesystem, can execute shell commands, search the web, and coordinate specialized sub-agents for complex tasks.\n\nWhat can I help you with today?","type":"text"}],"role":"assistant","usage":{"cache_creation_input_tokens":0,"cache_read_input_tokens":0,"input_tokens":4292,"output_tokens":220}}],"version":1}
|
||||||
1
rust/.claude/sessions/session-1775010909274.json
Normal file
1
rust/.claude/sessions/session-1775010909274.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"messages":[],"version":1}
|
||||||
1
rust/.claude/sessions/session-1775011146355.json
Normal file
1
rust/.claude/sessions/session-1775011146355.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"messages":[],"version":1}
|
||||||
1
rust/.claude/sessions/session-1775011562247.json
Normal file
1
rust/.claude/sessions/session-1775011562247.json
Normal file
File diff suppressed because one or more lines are too long
1
rust/.claude/sessions/session-1775012674485.json
Normal file
1
rust/.claude/sessions/session-1775012674485.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"messages":[{"blocks":[{"text":"clear","type":"text"}],"role":"user"},{"blocks":[{"text":"\n\nI've cleared the conversation. How can I help you today?","type":"text"}],"role":"assistant","usage":{"cache_creation_input_tokens":0,"cache_read_input_tokens":0,"input_tokens":4272,"output_tokens":17}}],"version":1}
|
||||||
1
rust/.claude/sessions/session-1775012687059.json
Normal file
1
rust/.claude/sessions/session-1775012687059.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"messages":[{"blocks":[{"text":"exit","type":"text"}],"role":"user"},{"blocks":[{"text":"\n\nGoodbye! 👋","type":"text"}],"role":"assistant","usage":{"cache_creation_input_tokens":0,"cache_read_input_tokens":0,"input_tokens":4272,"output_tokens":10}}],"version":1}
|
||||||
1
rust/.claude/sessions/session-1775013221875.json
Normal file
1
rust/.claude/sessions/session-1775013221875.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"messages":[],"version":1}
|
||||||
27
rust/.clawd-todos.json
Normal file
27
rust/.clawd-todos.json
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
[
|
||||||
|
{
|
||||||
|
"content": "Architecture & dependency analysis",
|
||||||
|
"activeForm": "Complete",
|
||||||
|
"status": "completed"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"content": "Runtime crate deep analysis",
|
||||||
|
"activeForm": "Complete",
|
||||||
|
"status": "completed"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"content": "CLI & Tools analysis",
|
||||||
|
"activeForm": "Complete",
|
||||||
|
"status": "completed"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"content": "Code quality verification",
|
||||||
|
"activeForm": "Complete",
|
||||||
|
"status": "completed"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"content": "Synthesize findings into unified report",
|
||||||
|
"activeForm": "Writing report",
|
||||||
|
"status": "in_progress"
|
||||||
|
}
|
||||||
|
]
|
||||||
221
rust/.omc/plans/tui-enhancement-plan.md
Normal file
221
rust/.omc/plans/tui-enhancement-plan.md
Normal file
@@ -0,0 +1,221 @@
|
|||||||
|
# TUI Enhancement Plan — Claw Code (`rusty-claude-cli`)
|
||||||
|
|
||||||
|
## Executive Summary
|
||||||
|
|
||||||
|
This plan covers a comprehensive analysis of the current terminal user interface and proposes phased enhancements that will transform the existing REPL/prompt CLI into a polished, modern TUI experience — while preserving the existing clean architecture and test coverage.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. Current Architecture Analysis
|
||||||
|
|
||||||
|
### Crate Map
|
||||||
|
|
||||||
|
| Crate | Purpose | Lines | TUI Relevance |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `rusty-claude-cli` | Main binary: REPL loop, arg parsing, rendering, API bridge | ~3,600 | **Primary TUI surface** |
|
||||||
|
| `runtime` | Session, conversation loop, config, permissions, compaction | ~5,300 | Provides data/state |
|
||||||
|
| `api` | Anthropic HTTP client + SSE streaming | ~1,500 | Provides stream events |
|
||||||
|
| `commands` | Slash command metadata/parsing/help | ~470 | Drives command dispatch |
|
||||||
|
| `tools` | 18 built-in tool implementations | ~3,500 | Tool execution display |
|
||||||
|
|
||||||
|
### Current TUI Components
|
||||||
|
|
||||||
|
| Component | File | What It Does Today | Quality |
|
||||||
|
|---|---|---|---|
|
||||||
|
| **Input** | `input.rs` (269 lines) | `rustyline`-based line editor with slash-command tab completion, Shift+Enter newline, history | ✅ Solid |
|
||||||
|
| **Rendering** | `render.rs` (641 lines) | Markdown→terminal rendering (headings, lists, tables, code blocks with syntect highlighting, blockquotes), spinner widget | ✅ Good |
|
||||||
|
| **App/REPL loop** | `main.rs` (3,159 lines) | The monolithic `LiveCli` struct: REPL loop, all slash command handlers, streaming output, tool call display, permission prompting, session management | ⚠️ Monolithic |
|
||||||
|
| **Alt App** | `app.rs` (398 lines) | An earlier `CliApp` prototype with `ConversationClient`, stream event handling, `TerminalRenderer`, output format support | ⚠️ Appears unused/legacy |
|
||||||
|
|
||||||
|
### Key Dependencies
|
||||||
|
|
||||||
|
- **crossterm 0.28** — terminal control (cursor, colors, clear)
|
||||||
|
- **pulldown-cmark 0.13** — Markdown parsing
|
||||||
|
- **syntect 5** — syntax highlighting
|
||||||
|
- **rustyline 15** — line editing with completion
|
||||||
|
- **serde_json** — tool I/O formatting
|
||||||
|
|
||||||
|
### Strengths
|
||||||
|
|
||||||
|
1. **Clean rendering pipeline**: Markdown rendering is well-structured with state tracking, table rendering, code highlighting
|
||||||
|
2. **Rich tool display**: Tool calls get box-drawing borders (`╭─ name ─╮`), results show ✓/✗ icons
|
||||||
|
3. **Comprehensive slash commands**: 15 commands covering model switching, permissions, sessions, config, diff, export
|
||||||
|
4. **Session management**: Full persistence, resume, list, switch, compaction
|
||||||
|
5. **Permission prompting**: Interactive Y/N approval for restricted tool calls
|
||||||
|
6. **Thorough tests**: Every formatting function, every parse path has unit tests
|
||||||
|
|
||||||
|
### Weaknesses & Gaps
|
||||||
|
|
||||||
|
1. **`main.rs` is a 3,159-line monolith** — all REPL logic, formatting, API bridging, session management, and tests in one file
|
||||||
|
2. **No alternate-screen / full-screen layout** — everything is inline scrolling output
|
||||||
|
3. **No progress bars** — only a single braille spinner; no indication of streaming progress or token counts during generation
|
||||||
|
4. **No visual diff rendering** — `/diff` just dumps raw git diff text
|
||||||
|
5. **No syntax highlighting in streamed output** — markdown rendering only applies to tool results, not to the main assistant response stream
|
||||||
|
6. **No status bar / HUD** — model, tokens, session info not visible during interaction
|
||||||
|
7. **No image/attachment preview** — `SendUserMessage` resolves attachments but never displays them
|
||||||
|
8. **Streaming is char-by-char with artificial delay** — `stream_markdown` sleeps 8ms per whitespace-delimited chunk
|
||||||
|
9. **No color theme customization** — hardcoded `ColorTheme::default()`
|
||||||
|
10. **No resize handling** — no terminal size awareness for wrapping, truncation, or layout
|
||||||
|
11. **Dual app structs** — `app.rs` has a separate `CliApp` that duplicates `LiveCli` from `main.rs`
|
||||||
|
12. **No pager for long outputs** — `/status`, `/config`, `/memory` can overflow the viewport
|
||||||
|
13. **Tool results not collapsible** — large bash outputs flood the screen
|
||||||
|
14. **No thinking/reasoning indicator** — when the model is in "thinking" mode, no visual distinction
|
||||||
|
15. **No auto-complete for tool arguments** — only slash command names complete
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. Enhancement Plan
|
||||||
|
|
||||||
|
### Phase 0: Structural Cleanup (Foundation)
|
||||||
|
|
||||||
|
**Goal**: Break the monolith, remove dead code, establish the module structure for TUI work.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 0.1 | **Extract `LiveCli` into `app.rs`** — Move the entire `LiveCli` struct, its impl, and helpers (`format_*`, `render_*`, session management) out of `main.rs` into focused modules: `app.rs` (core), `format.rs` (report formatting), `session_manager.rs` (session CRUD) | M |
|
||||||
|
| 0.2 | **Remove or merge the legacy `CliApp`** — The existing `app.rs` has an unused `CliApp` with its own `ConversationClient`-based rendering. Either delete it or merge its unique features (stream event handler pattern) into the active `LiveCli` | S |
|
||||||
|
| 0.3 | **Extract `main.rs` arg parsing** — The current `parse_args()` is a hand-rolled parser that duplicates the clap-based `args.rs`. Consolidate on the hand-rolled parser (it's more feature-complete) and move it to `args.rs`, or adopt clap fully | S |
|
||||||
|
| 0.4 | **Create a `tui/` module** — Introduce `crates/rusty-claude-cli/src/tui/mod.rs` as the namespace for all new TUI components: `status_bar.rs`, `layout.rs`, `tool_panel.rs`, etc. | S |
|
||||||
|
|
||||||
|
### Phase 1: Status Bar & Live HUD
|
||||||
|
|
||||||
|
**Goal**: Persistent information display during interaction.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 1.1 | **Terminal-size-aware status line** — Use `crossterm::terminal::size()` to render a bottom-pinned status bar showing: model name, permission mode, session ID, cumulative token count, estimated cost | M |
|
||||||
|
| 1.2 | **Live token counter** — Update the status bar in real-time as `AssistantEvent::Usage` and `AssistantEvent::TextDelta` events arrive during streaming | M |
|
||||||
|
| 1.3 | **Turn duration timer** — Show elapsed time for the current turn (the `showTurnDuration` config already exists in Config tool but isn't wired up) | S |
|
||||||
|
| 1.4 | **Git branch indicator** — Display the current git branch in the status bar (already parsed via `parse_git_status_metadata`) | S |
|
||||||
|
|
||||||
|
### Phase 2: Enhanced Streaming Output
|
||||||
|
|
||||||
|
**Goal**: Make the main response stream visually rich and responsive.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 2.1 | **Live markdown rendering** — Instead of raw text streaming, buffer text deltas and incrementally render Markdown as it arrives (heading detection, bold/italic, inline code). The existing `TerminalRenderer::render_markdown` can be adapted for incremental use | L |
|
||||||
|
| 2.2 | **Thinking indicator** — When extended thinking/reasoning is active, show a distinct animated indicator (e.g., `🧠 Reasoning...` with pulsing dots or a different spinner) instead of the generic `🦀 Thinking...` | S |
|
||||||
|
| 2.3 | **Streaming progress bar** — Add an optional horizontal progress indicator below the spinner showing approximate completion (based on max_tokens vs. output_tokens so far) | M |
|
||||||
|
| 2.4 | **Remove artificial stream delay** — The current `stream_markdown` sleeps 8ms per chunk. For tool results this is fine, but for the main response stream it should be immediate or configurable | S |
|
||||||
|
|
||||||
|
### Phase 3: Tool Call Visualization
|
||||||
|
|
||||||
|
**Goal**: Make tool execution legible and navigable.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 3.1 | **Collapsible tool output** — For tool results longer than N lines (configurable, default 15), show a summary with `[+] Expand` hint; pressing a key reveals the full output. Initially implement as truncation with a "full output saved to file" fallback | M |
|
||||||
|
| 3.2 | **Syntax-highlighted tool results** — When tool results contain code (detected by tool name — `bash` stdout, `read_file` content, `REPL` output), apply syntect highlighting rather than rendering as plain text | M |
|
||||||
|
| 3.3 | **Tool call timeline** — For multi-tool turns, show a compact summary: `🔧 bash → ✓ | read_file → ✓ | edit_file → ✓ (3 tools, 1.2s)` after all tool calls complete | S |
|
||||||
|
| 3.4 | **Diff-aware edit_file display** — When `edit_file` succeeds, show a colored unified diff of the change instead of just `✓ edit_file: path` | M |
|
||||||
|
| 3.5 | **Permission prompt enhancement** — Style the approval prompt with box drawing, color the tool name, show a one-line summary of what the tool will do | S |
|
||||||
|
|
||||||
|
### Phase 4: Enhanced Slash Commands & Navigation
|
||||||
|
|
||||||
|
**Goal**: Improve information display and add missing features.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 4.1 | **Colored `/diff` output** — Parse the git diff and render it with red/green coloring for removals/additions, similar to `delta` or `diff-so-fancy` | M |
|
||||||
|
| 4.2 | **Pager for long outputs** — When `/status`, `/config`, `/memory`, or `/diff` produce output longer than the terminal height, pipe through an internal pager (scroll with j/k/q) or external `$PAGER` | M |
|
||||||
|
| 4.3 | **`/search` command** — Add a new command to search conversation history by keyword | M |
|
||||||
|
| 4.4 | **`/undo` command** — Undo the last file edit by restoring from the `originalFile` data in `write_file`/`edit_file` tool results | M |
|
||||||
|
| 4.5 | **Interactive session picker** — Replace the text-based `/session list` with an interactive fuzzy-filterable list (up/down arrows to select, enter to switch) | L |
|
||||||
|
| 4.6 | **Tab completion for tool arguments** — Extend `SlashCommandHelper` to complete file paths after `/export`, model names after `/model`, session IDs after `/session switch` | M |
|
||||||
|
|
||||||
|
### Phase 5: Color Themes & Configuration
|
||||||
|
|
||||||
|
**Goal**: User-customizable visual appearance.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 5.1 | **Named color themes** — Add `dark` (current default), `light`, `solarized`, `catppuccin` themes. Wire to the existing `Config` tool's `theme` setting | M |
|
||||||
|
| 5.2 | **ANSI-256 / truecolor detection** — Detect terminal capabilities and fall back gracefully (no colors → 16 colors → 256 → truecolor) | M |
|
||||||
|
| 5.3 | **Configurable spinner style** — Allow choosing between braille dots, bar, moon phases, etc. | S |
|
||||||
|
| 5.4 | **Banner customization** — Make the ASCII art banner optional or configurable via settings | S |
|
||||||
|
|
||||||
|
### Phase 6: Full-Screen TUI Mode (Stretch)
|
||||||
|
|
||||||
|
**Goal**: Optional alternate-screen layout for power users.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 6.1 | **Add `ratatui` dependency** — Introduce `ratatui` (terminal UI framework) as an optional dependency for the full-screen mode | S |
|
||||||
|
| 6.2 | **Split-pane layout** — Top pane: conversation with scrollback; Bottom pane: input area; Right sidebar (optional): tool status/todo list | XL |
|
||||||
|
| 6.3 | **Scrollable conversation view** — Navigate past messages with PgUp/PgDn, search within conversation | L |
|
||||||
|
| 6.4 | **Keyboard shortcuts panel** — Show `?` help overlay with all keybindings | M |
|
||||||
|
| 6.5 | **Mouse support** — Click to expand tool results, scroll conversation, select text for copy | L |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Priority Recommendation
|
||||||
|
|
||||||
|
### Immediate (High Impact, Moderate Effort)
|
||||||
|
|
||||||
|
1. **Phase 0** — Essential cleanup. The 3,159-line `main.rs` is the #1 maintenance risk and blocks clean TUI additions.
|
||||||
|
2. **Phase 1.1–1.2** — Status bar with live tokens. Highest-impact UX win: users constantly want to know token usage.
|
||||||
|
3. **Phase 2.4** — Remove artificial delay. Low effort, immediately noticeable improvement.
|
||||||
|
4. **Phase 3.1** — Collapsible tool output. Large bash outputs currently wreck readability.
|
||||||
|
|
||||||
|
### Near-Term (Next Sprint)
|
||||||
|
|
||||||
|
5. **Phase 2.1** — Live markdown rendering. Makes the core interaction feel polished.
|
||||||
|
6. **Phase 3.2** — Syntax-highlighted tool results.
|
||||||
|
7. **Phase 3.4** — Diff-aware edit display.
|
||||||
|
8. **Phase 4.1** — Colored diff for `/diff`.
|
||||||
|
|
||||||
|
### Longer-Term
|
||||||
|
|
||||||
|
9. **Phase 5** — Color themes (user demand-driven).
|
||||||
|
10. **Phase 4.2–4.6** — Enhanced navigation and commands.
|
||||||
|
11. **Phase 6** — Full-screen mode (major undertaking, evaluate after earlier phases ship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. Architecture Recommendations
|
||||||
|
|
||||||
|
### Module Structure After Phase 0
|
||||||
|
|
||||||
|
```
|
||||||
|
crates/rusty-claude-cli/src/
|
||||||
|
├── main.rs # Entrypoint, arg dispatch only (~100 lines)
|
||||||
|
├── args.rs # CLI argument parsing (consolidate existing two parsers)
|
||||||
|
├── app.rs # LiveCli struct, REPL loop, turn execution
|
||||||
|
├── format.rs # All report formatting (status, cost, model, permissions, etc.)
|
||||||
|
├── session_mgr.rs # Session CRUD: create, resume, list, switch, persist
|
||||||
|
├── init.rs # Repo initialization (unchanged)
|
||||||
|
├── input.rs # Line editor (unchanged, minor extensions)
|
||||||
|
├── render.rs # TerminalRenderer, Spinner (extended)
|
||||||
|
└── tui/
|
||||||
|
├── mod.rs # TUI module root
|
||||||
|
├── status_bar.rs # Persistent bottom status line
|
||||||
|
├── tool_panel.rs # Tool call visualization (boxes, timelines, collapsible)
|
||||||
|
├── diff_view.rs # Colored diff rendering
|
||||||
|
├── pager.rs # Internal pager for long outputs
|
||||||
|
└── theme.rs # Color theme definitions and selection
|
||||||
|
```
|
||||||
|
|
||||||
|
### Key Design Principles
|
||||||
|
|
||||||
|
1. **Keep the inline REPL as the default** — Full-screen TUI should be opt-in (`--tui` flag)
|
||||||
|
2. **Everything testable without a terminal** — All formatting functions take `&mut impl Write`, never assume stdout directly
|
||||||
|
3. **Streaming-first** — Rendering should work incrementally, not buffering the entire response
|
||||||
|
4. **Respect `crossterm` for all terminal control** — Don't mix raw ANSI escape codes with crossterm (the current codebase does this in the startup banner)
|
||||||
|
5. **Feature-gate heavy dependencies** — `ratatui` should be behind a `full-tui` feature flag
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. Risk Assessment
|
||||||
|
|
||||||
|
| Risk | Mitigation |
|
||||||
|
|---|---|
|
||||||
|
| Breaking the working REPL during refactor | Phase 0 is pure restructuring with existing test coverage as safety net |
|
||||||
|
| Terminal compatibility issues (tmux, SSH, Windows) | Rely on crossterm's abstraction; test in degraded environments |
|
||||||
|
| Performance regression with rich rendering | Profile before/after; keep the fast path (raw streaming) always available |
|
||||||
|
| Scope creep into Phase 6 | Ship Phases 0–3 as a coherent release before starting Phase 6 |
|
||||||
|
| `app.rs` vs `main.rs` confusion | Phase 0.2 explicitly resolves this by removing the legacy `CliApp` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Generated: 2026-03-31 | Workspace: `rust/` | Branch: `dev/rust`*
|
||||||
3
rust/.sandbox-home/.rustup/settings.toml
Normal file
3
rust/.sandbox-home/.rustup/settings.toml
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version = "12"
|
||||||
|
|
||||||
|
[overrides]
|
||||||
12
rust/Cargo.lock
generated
12
rust/Cargo.lock
generated
@@ -111,6 +111,7 @@ dependencies = [
|
|||||||
name = "commands"
|
name = "commands"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
|
"plugins",
|
||||||
"runtime",
|
"runtime",
|
||||||
]
|
]
|
||||||
|
|
||||||
@@ -825,6 +826,14 @@ dependencies = [
|
|||||||
"time",
|
"time",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "plugins"
|
||||||
|
version = "0.1.0"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
"serde_json",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "potential_utf"
|
name = "potential_utf"
|
||||||
version = "0.1.4"
|
version = "0.1.4"
|
||||||
@@ -1092,6 +1101,7 @@ name = "runtime"
|
|||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"glob",
|
"glob",
|
||||||
|
"plugins",
|
||||||
"regex",
|
"regex",
|
||||||
"serde",
|
"serde",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
@@ -1181,6 +1191,7 @@ dependencies = [
|
|||||||
"commands",
|
"commands",
|
||||||
"compat-harness",
|
"compat-harness",
|
||||||
"crossterm",
|
"crossterm",
|
||||||
|
"plugins",
|
||||||
"pulldown-cmark",
|
"pulldown-cmark",
|
||||||
"runtime",
|
"runtime",
|
||||||
"rustyline",
|
"rustyline",
|
||||||
@@ -1546,6 +1557,7 @@ name = "tools"
|
|||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"api",
|
"api",
|
||||||
|
"plugins",
|
||||||
"reqwest",
|
"reqwest",
|
||||||
"runtime",
|
"runtime",
|
||||||
"serde",
|
"serde",
|
||||||
|
|||||||
353
rust/README.md
353
rust/README.md
@@ -1,230 +1,149 @@
|
|||||||
# Rusty Claude CLI
|
# 🦞 Claw Code — Rust Implementation
|
||||||
|
|
||||||
`rust/` contains the Rust workspace for the integrated `rusty-claude-cli` deliverable.
|
A high-performance Rust rewrite of the Claw Code CLI agent harness. Built for speed, safety, and native tool execution.
|
||||||
It is intended to be something you can clone, build, and run directly.
|
|
||||||
|
|
||||||
## Workspace layout
|
## Quick Start
|
||||||
|
|
||||||
```text
|
```bash
|
||||||
|
# Build
|
||||||
|
cd rust/
|
||||||
|
cargo build --release
|
||||||
|
|
||||||
|
# Run interactive REPL
|
||||||
|
./target/release/claw
|
||||||
|
|
||||||
|
# One-shot prompt
|
||||||
|
./target/release/claw prompt "explain this codebase"
|
||||||
|
|
||||||
|
# With specific model
|
||||||
|
./target/release/claw --model sonnet prompt "fix the bug in main.rs"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Set your API credentials:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export ANTHROPIC_API_KEY="sk-ant-..."
|
||||||
|
# Or use a proxy
|
||||||
|
export ANTHROPIC_BASE_URL="https://your-proxy.com"
|
||||||
|
```
|
||||||
|
|
||||||
|
Or authenticate via OAuth:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
claw login
|
||||||
|
```
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
| Feature | Status |
|
||||||
|
|---------|--------|
|
||||||
|
| Anthropic API + streaming | ✅ |
|
||||||
|
| OAuth login/logout | ✅ |
|
||||||
|
| Interactive REPL (rustyline) | ✅ |
|
||||||
|
| Tool system (bash, read, write, edit, grep, glob) | ✅ |
|
||||||
|
| Web tools (search, fetch) | ✅ |
|
||||||
|
| Sub-agent orchestration | ✅ |
|
||||||
|
| Todo tracking | ✅ |
|
||||||
|
| Notebook editing | ✅ |
|
||||||
|
| CLAUDE.md / project memory | ✅ |
|
||||||
|
| Config file hierarchy (.claude.json) | ✅ |
|
||||||
|
| Permission system | ✅ |
|
||||||
|
| MCP server lifecycle | ✅ |
|
||||||
|
| Session persistence + resume | ✅ |
|
||||||
|
| Extended thinking (thinking blocks) | ✅ |
|
||||||
|
| Cost tracking + usage display | ✅ |
|
||||||
|
| Git integration | ✅ |
|
||||||
|
| Markdown terminal rendering (ANSI) | ✅ |
|
||||||
|
| Model aliases (opus/sonnet/haiku) | ✅ |
|
||||||
|
| Slash commands (/status, /compact, /clear, etc.) | ✅ |
|
||||||
|
| Hooks (PreToolUse/PostToolUse) | 🔧 Config only |
|
||||||
|
| Plugin system | 📋 Planned |
|
||||||
|
| Skills registry | 📋 Planned |
|
||||||
|
|
||||||
|
## Model Aliases
|
||||||
|
|
||||||
|
Short names resolve to the latest model versions:
|
||||||
|
|
||||||
|
| Alias | Resolves To |
|
||||||
|
|-------|------------|
|
||||||
|
| `opus` | `claude-opus-4-6` |
|
||||||
|
| `sonnet` | `claude-sonnet-4-6` |
|
||||||
|
| `haiku` | `claude-haiku-4-5-20251213` |
|
||||||
|
|
||||||
|
## CLI Flags
|
||||||
|
|
||||||
|
```
|
||||||
|
claw [OPTIONS] [COMMAND]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--model MODEL Set the model (alias or full name)
|
||||||
|
--dangerously-skip-permissions Skip all permission checks
|
||||||
|
--permission-mode MODE Set read-only, workspace-write, or danger-full-access
|
||||||
|
--allowedTools TOOLS Restrict enabled tools
|
||||||
|
--output-format FORMAT Output format (text or json)
|
||||||
|
--version, -V Print version info
|
||||||
|
|
||||||
|
Commands:
|
||||||
|
prompt <text> One-shot prompt (non-interactive)
|
||||||
|
login Authenticate via OAuth
|
||||||
|
logout Clear stored credentials
|
||||||
|
init Initialize project config
|
||||||
|
doctor Check environment health
|
||||||
|
self-update Update to latest version
|
||||||
|
```
|
||||||
|
|
||||||
|
## Slash Commands (REPL)
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
|---------|-------------|
|
||||||
|
| `/help` | Show help |
|
||||||
|
| `/status` | Show session status (model, tokens, cost) |
|
||||||
|
| `/cost` | Show cost breakdown |
|
||||||
|
| `/compact` | Compact conversation history |
|
||||||
|
| `/clear` | Clear conversation |
|
||||||
|
| `/model [name]` | Show or switch model |
|
||||||
|
| `/permissions` | Show or switch permission mode |
|
||||||
|
| `/config [section]` | Show config (env, hooks, model) |
|
||||||
|
| `/memory` | Show CLAUDE.md contents |
|
||||||
|
| `/diff` | Show git diff |
|
||||||
|
| `/export [path]` | Export conversation |
|
||||||
|
| `/session [id]` | Resume a previous session |
|
||||||
|
| `/version` | Show version |
|
||||||
|
|
||||||
|
## Workspace Layout
|
||||||
|
|
||||||
|
```
|
||||||
rust/
|
rust/
|
||||||
├── Cargo.toml
|
├── Cargo.toml # Workspace root
|
||||||
├── Cargo.lock
|
├── Cargo.lock
|
||||||
├── README.md
|
|
||||||
└── crates/
|
└── crates/
|
||||||
├── api/ # Anthropic API client + SSE streaming support
|
├── api/ # Anthropic API client + SSE streaming
|
||||||
├── commands/ # Shared slash-command metadata/help surfaces
|
├── commands/ # Shared slash-command registry
|
||||||
├── compat-harness/ # Upstream TS manifest extraction harness
|
├── compat-harness/ # TS manifest extraction harness
|
||||||
├── runtime/ # Session/runtime/config/prompt orchestration
|
├── runtime/ # Session, config, permissions, MCP, prompts
|
||||||
├── rusty-claude-cli/ # Main CLI binary
|
├── rusty-claude-cli/ # Main CLI binary (`claw`)
|
||||||
└── tools/ # Built-in tool implementations
|
└── tools/ # Built-in tool implementations
|
||||||
```
|
```
|
||||||
|
|
||||||
## Prerequisites
|
### Crate Responsibilities
|
||||||
|
|
||||||
- Rust toolchain installed (`rustup`, stable toolchain)
|
- **api** — HTTP client, SSE stream parser, request/response types, auth (API key + OAuth bearer)
|
||||||
- Network access and Anthropic credentials for live prompt/REPL usage
|
- **commands** — Slash command definitions and help text generation
|
||||||
|
- **compat-harness** — Extracts tool/prompt manifests from upstream TS source
|
||||||
|
- **runtime** — `ConversationRuntime` agentic loop, `ConfigLoader` hierarchy, `Session` persistence, permission policy, MCP client, system prompt assembly, usage tracking
|
||||||
|
- **rusty-claude-cli** — REPL, one-shot prompt, streaming display, tool call rendering, CLI argument parsing
|
||||||
|
- **tools** — Tool specs + execution: Bash, ReadFile, WriteFile, EditFile, GlobSearch, GrepSearch, WebSearch, WebFetch, Agent, TodoWrite, NotebookEdit, Skill, ToolSearch, REPL runtimes
|
||||||
|
|
||||||
## Build
|
## Stats
|
||||||
|
|
||||||
From the repository root:
|
- **~20K lines** of Rust
|
||||||
|
- **6 crates** in workspace
|
||||||
|
- **Binary name:** `claw`
|
||||||
|
- **Default model:** `claude-opus-4-6`
|
||||||
|
- **Default permissions:** `danger-full-access`
|
||||||
|
|
||||||
```bash
|
## License
|
||||||
cd rust
|
|
||||||
cargo build --release -p rusty-claude-cli
|
|
||||||
```
|
|
||||||
|
|
||||||
The optimized binary will be written to:
|
See repository root.
|
||||||
|
|
||||||
```bash
|
|
||||||
./target/release/rusty-claude-cli
|
|
||||||
```
|
|
||||||
|
|
||||||
## Test
|
|
||||||
|
|
||||||
Run the verified workspace test suite used for release-readiness:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo test --workspace --exclude compat-harness
|
|
||||||
```
|
|
||||||
|
|
||||||
## Quick start
|
|
||||||
|
|
||||||
### Show help
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- --help
|
|
||||||
```
|
|
||||||
|
|
||||||
### Print version
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- --version
|
|
||||||
```
|
|
||||||
|
|
||||||
### Login with OAuth
|
|
||||||
|
|
||||||
Configure `settings.json` with an `oauth` block containing `clientId`, `authorizeUrl`, `tokenUrl`, optional `callbackPort`, and optional `scopes`, then run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- login
|
|
||||||
```
|
|
||||||
|
|
||||||
This opens the browser, listens on the configured localhost callback, exchanges the auth code for tokens, and stores OAuth credentials in `~/.claude/credentials.json` (or `$CLAUDE_CONFIG_HOME/credentials.json`).
|
|
||||||
|
|
||||||
### Logout
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- logout
|
|
||||||
```
|
|
||||||
|
|
||||||
This removes only the stored OAuth credentials and preserves unrelated JSON fields in `credentials.json`.
|
|
||||||
|
|
||||||
### Self-update
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- self-update
|
|
||||||
```
|
|
||||||
|
|
||||||
The command checks the latest GitHub release for `instructkr/clawd-code`, compares it to the current binary version, downloads the matching binary asset plus checksum manifest, verifies SHA-256, replaces the current executable, and prints the release changelog. If no published release or matching asset exists, it exits safely with an explanatory message.
|
|
||||||
|
|
||||||
## Usage examples
|
|
||||||
|
|
||||||
### 1) Prompt mode
|
|
||||||
|
|
||||||
Send one prompt, stream the answer, then exit:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- prompt "Summarize the architecture of this repository"
|
|
||||||
```
|
|
||||||
|
|
||||||
Use a specific model:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- --model claude-sonnet-4-20250514 prompt "List the key crates in this workspace"
|
|
||||||
```
|
|
||||||
|
|
||||||
Restrict enabled tools in an interactive session:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- --allowedTools read,glob
|
|
||||||
```
|
|
||||||
|
|
||||||
Bootstrap Claude project files for the current repo:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- init
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2) REPL mode
|
|
||||||
|
|
||||||
Start the interactive shell:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli --
|
|
||||||
```
|
|
||||||
|
|
||||||
Inside the REPL, useful commands include:
|
|
||||||
|
|
||||||
```text
|
|
||||||
/help
|
|
||||||
/status
|
|
||||||
/model claude-sonnet-4-20250514
|
|
||||||
/permissions workspace-write
|
|
||||||
/cost
|
|
||||||
/compact
|
|
||||||
/memory
|
|
||||||
/config
|
|
||||||
/init
|
|
||||||
/diff
|
|
||||||
/version
|
|
||||||
/export notes.txt
|
|
||||||
/sessions
|
|
||||||
/session list
|
|
||||||
/exit
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3) Resume an existing session
|
|
||||||
|
|
||||||
Inspect or maintain a saved session file without entering the REPL:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- --resume session-123456 /status /compact /cost
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also inspect memory/config state for a restored session:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd rust
|
|
||||||
cargo run -p rusty-claude-cli -- --resume ~/.claude/sessions/session-123456.json /memory /config
|
|
||||||
```
|
|
||||||
|
|
||||||
## Available commands
|
|
||||||
|
|
||||||
### Top-level CLI commands
|
|
||||||
|
|
||||||
- `prompt <text...>` — run one prompt non-interactively
|
|
||||||
- `--resume <session-id-or-path> [/commands...]` — inspect or maintain a saved session stored under `~/.claude/sessions/`
|
|
||||||
- `dump-manifests` — print extracted upstream manifest counts
|
|
||||||
- `bootstrap-plan` — print the current bootstrap skeleton
|
|
||||||
- `system-prompt [--cwd PATH] [--date YYYY-MM-DD]` — render the synthesized system prompt
|
|
||||||
- `self-update` — update the installed binary from the latest GitHub release when a matching asset is available
|
|
||||||
- `--help` / `-h` — show CLI help
|
|
||||||
- `--version` / `-V` — print the CLI version and build info locally (no API call)
|
|
||||||
- `--output-format text|json` — choose non-interactive prompt output rendering
|
|
||||||
- `--allowedTools <tool[,tool...]>` — restrict enabled tools for interactive sessions and prompt-mode tool use
|
|
||||||
|
|
||||||
### Interactive slash commands
|
|
||||||
|
|
||||||
- `/help` — show command help
|
|
||||||
- `/status` — show current session status
|
|
||||||
- `/compact` — compact local session history
|
|
||||||
- `/model [model]` — inspect or switch the active model
|
|
||||||
- `/permissions [read-only|workspace-write|danger-full-access]` — inspect or switch permissions
|
|
||||||
- `/clear [--confirm]` — clear the current local session
|
|
||||||
- `/cost` — show token usage totals
|
|
||||||
- `/resume <session-id-or-path>` — load a saved session into the REPL
|
|
||||||
- `/config [env|hooks|model]` — inspect discovered Claude config
|
|
||||||
- `/memory` — inspect loaded instruction memory files
|
|
||||||
- `/init` — bootstrap `.claude.json`, `.claude/`, `CLAUDE.md`, and local ignore rules
|
|
||||||
- `/diff` — show the current git diff for the workspace
|
|
||||||
- `/version` — print version and build metadata locally
|
|
||||||
- `/export [file]` — export the current conversation transcript
|
|
||||||
- `/sessions` — list recent managed local sessions from `~/.claude/sessions/`
|
|
||||||
- `/session [list|switch <session-id>]` — inspect or switch managed local sessions
|
|
||||||
- `/exit` — leave the REPL
|
|
||||||
|
|
||||||
## Environment variables
|
|
||||||
|
|
||||||
### Anthropic/API
|
|
||||||
|
|
||||||
- `ANTHROPIC_API_KEY` — highest-precedence API credential
|
|
||||||
- `ANTHROPIC_AUTH_TOKEN` — bearer-token override used when no API key is set
|
|
||||||
- Persisted OAuth credentials in `~/.claude/credentials.json` — used when neither env var is set
|
|
||||||
- `ANTHROPIC_BASE_URL` — override the Anthropic API base URL
|
|
||||||
- `ANTHROPIC_MODEL` — default model used by selected live integration tests
|
|
||||||
|
|
||||||
### CLI/runtime
|
|
||||||
|
|
||||||
- `RUSTY_CLAUDE_PERMISSION_MODE` — default REPL permission mode (`read-only`, `workspace-write`, or `danger-full-access`)
|
|
||||||
- `CLAUDE_CONFIG_HOME` — override Claude config discovery root
|
|
||||||
- `CLAUDE_CODE_REMOTE` — enable remote-session bootstrap handling when supported
|
|
||||||
- `CLAUDE_CODE_REMOTE_SESSION_ID` — remote session identifier when using remote mode
|
|
||||||
- `CLAUDE_CODE_UPSTREAM` — override the upstream TS source path for compat-harness extraction
|
|
||||||
- `CLAWD_WEB_SEARCH_BASE_URL` — override the built-in web search service endpoint used by tooling
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
- `compat-harness` exists to compare the Rust port against the upstream TypeScript codebase and is intentionally excluded from the requested release test run.
|
|
||||||
- The CLI currently focuses on a practical integrated workflow: prompt execution, REPL operation, session inspection/resume, config discovery, and tool/runtime plumbing.
|
|
||||||
|
|||||||
221
rust/TUI-ENHANCEMENT-PLAN.md
Normal file
221
rust/TUI-ENHANCEMENT-PLAN.md
Normal file
@@ -0,0 +1,221 @@
|
|||||||
|
# TUI Enhancement Plan — Claw Code (`rusty-claude-cli`)
|
||||||
|
|
||||||
|
## Executive Summary
|
||||||
|
|
||||||
|
This plan covers a comprehensive analysis of the current terminal user interface and proposes phased enhancements that will transform the existing REPL/prompt CLI into a polished, modern TUI experience — while preserving the existing clean architecture and test coverage.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. Current Architecture Analysis
|
||||||
|
|
||||||
|
### Crate Map
|
||||||
|
|
||||||
|
| Crate | Purpose | Lines | TUI Relevance |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `rusty-claude-cli` | Main binary: REPL loop, arg parsing, rendering, API bridge | ~3,600 | **Primary TUI surface** |
|
||||||
|
| `runtime` | Session, conversation loop, config, permissions, compaction | ~5,300 | Provides data/state |
|
||||||
|
| `api` | Anthropic HTTP client + SSE streaming | ~1,500 | Provides stream events |
|
||||||
|
| `commands` | Slash command metadata/parsing/help | ~470 | Drives command dispatch |
|
||||||
|
| `tools` | 18 built-in tool implementations | ~3,500 | Tool execution display |
|
||||||
|
|
||||||
|
### Current TUI Components
|
||||||
|
|
||||||
|
| Component | File | What It Does Today | Quality |
|
||||||
|
|---|---|---|---|
|
||||||
|
| **Input** | `input.rs` (269 lines) | `rustyline`-based line editor with slash-command tab completion, Shift+Enter newline, history | ✅ Solid |
|
||||||
|
| **Rendering** | `render.rs` (641 lines) | Markdown→terminal rendering (headings, lists, tables, code blocks with syntect highlighting, blockquotes), spinner widget | ✅ Good |
|
||||||
|
| **App/REPL loop** | `main.rs` (3,159 lines) | The monolithic `LiveCli` struct: REPL loop, all slash command handlers, streaming output, tool call display, permission prompting, session management | ⚠️ Monolithic |
|
||||||
|
| **Alt App** | `app.rs` (398 lines) | An earlier `CliApp` prototype with `ConversationClient`, stream event handling, `TerminalRenderer`, output format support | ⚠️ Appears unused/legacy |
|
||||||
|
|
||||||
|
### Key Dependencies
|
||||||
|
|
||||||
|
- **crossterm 0.28** — terminal control (cursor, colors, clear)
|
||||||
|
- **pulldown-cmark 0.13** — Markdown parsing
|
||||||
|
- **syntect 5** — syntax highlighting
|
||||||
|
- **rustyline 15** — line editing with completion
|
||||||
|
- **serde_json** — tool I/O formatting
|
||||||
|
|
||||||
|
### Strengths
|
||||||
|
|
||||||
|
1. **Clean rendering pipeline**: Markdown rendering is well-structured with state tracking, table rendering, code highlighting
|
||||||
|
2. **Rich tool display**: Tool calls get box-drawing borders (`╭─ name ─╮`), results show ✓/✗ icons
|
||||||
|
3. **Comprehensive slash commands**: 15 commands covering model switching, permissions, sessions, config, diff, export
|
||||||
|
4. **Session management**: Full persistence, resume, list, switch, compaction
|
||||||
|
5. **Permission prompting**: Interactive Y/N approval for restricted tool calls
|
||||||
|
6. **Thorough tests**: Every formatting function, every parse path has unit tests
|
||||||
|
|
||||||
|
### Weaknesses & Gaps
|
||||||
|
|
||||||
|
1. **`main.rs` is a 3,159-line monolith** — all REPL logic, formatting, API bridging, session management, and tests in one file
|
||||||
|
2. **No alternate-screen / full-screen layout** — everything is inline scrolling output
|
||||||
|
3. **No progress bars** — only a single braille spinner; no indication of streaming progress or token counts during generation
|
||||||
|
4. **No visual diff rendering** — `/diff` just dumps raw git diff text
|
||||||
|
5. **No syntax highlighting in streamed output** — markdown rendering only applies to tool results, not to the main assistant response stream
|
||||||
|
6. **No status bar / HUD** — model, tokens, session info not visible during interaction
|
||||||
|
7. **No image/attachment preview** — `SendUserMessage` resolves attachments but never displays them
|
||||||
|
8. **Streaming is char-by-char with artificial delay** — `stream_markdown` sleeps 8ms per whitespace-delimited chunk
|
||||||
|
9. **No color theme customization** — hardcoded `ColorTheme::default()`
|
||||||
|
10. **No resize handling** — no terminal size awareness for wrapping, truncation, or layout
|
||||||
|
11. **Dual app structs** — `app.rs` has a separate `CliApp` that duplicates `LiveCli` from `main.rs`
|
||||||
|
12. **No pager for long outputs** — `/status`, `/config`, `/memory` can overflow the viewport
|
||||||
|
13. **Tool results not collapsible** — large bash outputs flood the screen
|
||||||
|
14. **No thinking/reasoning indicator** — when the model is in "thinking" mode, no visual distinction
|
||||||
|
15. **No auto-complete for tool arguments** — only slash command names complete
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. Enhancement Plan
|
||||||
|
|
||||||
|
### Phase 0: Structural Cleanup (Foundation)
|
||||||
|
|
||||||
|
**Goal**: Break the monolith, remove dead code, establish the module structure for TUI work.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 0.1 | **Extract `LiveCli` into `app.rs`** — Move the entire `LiveCli` struct, its impl, and helpers (`format_*`, `render_*`, session management) out of `main.rs` into focused modules: `app.rs` (core), `format.rs` (report formatting), `session_manager.rs` (session CRUD) | M |
|
||||||
|
| 0.2 | **Remove or merge the legacy `CliApp`** — The existing `app.rs` has an unused `CliApp` with its own `ConversationClient`-based rendering. Either delete it or merge its unique features (stream event handler pattern) into the active `LiveCli` | S |
|
||||||
|
| 0.3 | **Extract `main.rs` arg parsing** — The current `parse_args()` is a hand-rolled parser that duplicates the clap-based `args.rs`. Consolidate on the hand-rolled parser (it's more feature-complete) and move it to `args.rs`, or adopt clap fully | S |
|
||||||
|
| 0.4 | **Create a `tui/` module** — Introduce `crates/rusty-claude-cli/src/tui/mod.rs` as the namespace for all new TUI components: `status_bar.rs`, `layout.rs`, `tool_panel.rs`, etc. | S |
|
||||||
|
|
||||||
|
### Phase 1: Status Bar & Live HUD
|
||||||
|
|
||||||
|
**Goal**: Persistent information display during interaction.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 1.1 | **Terminal-size-aware status line** — Use `crossterm::terminal::size()` to render a bottom-pinned status bar showing: model name, permission mode, session ID, cumulative token count, estimated cost | M |
|
||||||
|
| 1.2 | **Live token counter** — Update the status bar in real-time as `AssistantEvent::Usage` and `AssistantEvent::TextDelta` events arrive during streaming | M |
|
||||||
|
| 1.3 | **Turn duration timer** — Show elapsed time for the current turn (the `showTurnDuration` config already exists in Config tool but isn't wired up) | S |
|
||||||
|
| 1.4 | **Git branch indicator** — Display the current git branch in the status bar (already parsed via `parse_git_status_metadata`) | S |
|
||||||
|
|
||||||
|
### Phase 2: Enhanced Streaming Output
|
||||||
|
|
||||||
|
**Goal**: Make the main response stream visually rich and responsive.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 2.1 | **Live markdown rendering** — Instead of raw text streaming, buffer text deltas and incrementally render Markdown as it arrives (heading detection, bold/italic, inline code). The existing `TerminalRenderer::render_markdown` can be adapted for incremental use | L |
|
||||||
|
| 2.2 | **Thinking indicator** — When extended thinking/reasoning is active, show a distinct animated indicator (e.g., `🧠 Reasoning...` with pulsing dots or a different spinner) instead of the generic `🦀 Thinking...` | S |
|
||||||
|
| 2.3 | **Streaming progress bar** — Add an optional horizontal progress indicator below the spinner showing approximate completion (based on max_tokens vs. output_tokens so far) | M |
|
||||||
|
| 2.4 | **Remove artificial stream delay** — The current `stream_markdown` sleeps 8ms per chunk. For tool results this is fine, but for the main response stream it should be immediate or configurable | S |
|
||||||
|
|
||||||
|
### Phase 3: Tool Call Visualization
|
||||||
|
|
||||||
|
**Goal**: Make tool execution legible and navigable.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 3.1 | **Collapsible tool output** — For tool results longer than N lines (configurable, default 15), show a summary with `[+] Expand` hint; pressing a key reveals the full output. Initially implement as truncation with a "full output saved to file" fallback | M |
|
||||||
|
| 3.2 | **Syntax-highlighted tool results** — When tool results contain code (detected by tool name — `bash` stdout, `read_file` content, `REPL` output), apply syntect highlighting rather than rendering as plain text | M |
|
||||||
|
| 3.3 | **Tool call timeline** — For multi-tool turns, show a compact summary: `🔧 bash → ✓ | read_file → ✓ | edit_file → ✓ (3 tools, 1.2s)` after all tool calls complete | S |
|
||||||
|
| 3.4 | **Diff-aware edit_file display** — When `edit_file` succeeds, show a colored unified diff of the change instead of just `✓ edit_file: path` | M |
|
||||||
|
| 3.5 | **Permission prompt enhancement** — Style the approval prompt with box drawing, color the tool name, show a one-line summary of what the tool will do | S |
|
||||||
|
|
||||||
|
### Phase 4: Enhanced Slash Commands & Navigation
|
||||||
|
|
||||||
|
**Goal**: Improve information display and add missing features.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 4.1 | **Colored `/diff` output** — Parse the git diff and render it with red/green coloring for removals/additions, similar to `delta` or `diff-so-fancy` | M |
|
||||||
|
| 4.2 | **Pager for long outputs** — When `/status`, `/config`, `/memory`, or `/diff` produce output longer than the terminal height, pipe through an internal pager (scroll with j/k/q) or external `$PAGER` | M |
|
||||||
|
| 4.3 | **`/search` command** — Add a new command to search conversation history by keyword | M |
|
||||||
|
| 4.4 | **`/undo` command** — Undo the last file edit by restoring from the `originalFile` data in `write_file`/`edit_file` tool results | M |
|
||||||
|
| 4.5 | **Interactive session picker** — Replace the text-based `/session list` with an interactive fuzzy-filterable list (up/down arrows to select, enter to switch) | L |
|
||||||
|
| 4.6 | **Tab completion for tool arguments** — Extend `SlashCommandHelper` to complete file paths after `/export`, model names after `/model`, session IDs after `/session switch` | M |
|
||||||
|
|
||||||
|
### Phase 5: Color Themes & Configuration
|
||||||
|
|
||||||
|
**Goal**: User-customizable visual appearance.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 5.1 | **Named color themes** — Add `dark` (current default), `light`, `solarized`, `catppuccin` themes. Wire to the existing `Config` tool's `theme` setting | M |
|
||||||
|
| 5.2 | **ANSI-256 / truecolor detection** — Detect terminal capabilities and fall back gracefully (no colors → 16 colors → 256 → truecolor) | M |
|
||||||
|
| 5.3 | **Configurable spinner style** — Allow choosing between braille dots, bar, moon phases, etc. | S |
|
||||||
|
| 5.4 | **Banner customization** — Make the ASCII art banner optional or configurable via settings | S |
|
||||||
|
|
||||||
|
### Phase 6: Full-Screen TUI Mode (Stretch)
|
||||||
|
|
||||||
|
**Goal**: Optional alternate-screen layout for power users.
|
||||||
|
|
||||||
|
| Task | Description | Effort |
|
||||||
|
|---|---|---|
|
||||||
|
| 6.1 | **Add `ratatui` dependency** — Introduce `ratatui` (terminal UI framework) as an optional dependency for the full-screen mode | S |
|
||||||
|
| 6.2 | **Split-pane layout** — Top pane: conversation with scrollback; Bottom pane: input area; Right sidebar (optional): tool status/todo list | XL |
|
||||||
|
| 6.3 | **Scrollable conversation view** — Navigate past messages with PgUp/PgDn, search within conversation | L |
|
||||||
|
| 6.4 | **Keyboard shortcuts panel** — Show `?` help overlay with all keybindings | M |
|
||||||
|
| 6.5 | **Mouse support** — Click to expand tool results, scroll conversation, select text for copy | L |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Priority Recommendation
|
||||||
|
|
||||||
|
### Immediate (High Impact, Moderate Effort)
|
||||||
|
|
||||||
|
1. **Phase 0** — Essential cleanup. The 3,159-line `main.rs` is the #1 maintenance risk and blocks clean TUI additions.
|
||||||
|
2. **Phase 1.1–1.2** — Status bar with live tokens. Highest-impact UX win: users constantly want to know token usage.
|
||||||
|
3. **Phase 2.4** — Remove artificial delay. Low effort, immediately noticeable improvement.
|
||||||
|
4. **Phase 3.1** — Collapsible tool output. Large bash outputs currently wreck readability.
|
||||||
|
|
||||||
|
### Near-Term (Next Sprint)
|
||||||
|
|
||||||
|
5. **Phase 2.1** — Live markdown rendering. Makes the core interaction feel polished.
|
||||||
|
6. **Phase 3.2** — Syntax-highlighted tool results.
|
||||||
|
7. **Phase 3.4** — Diff-aware edit display.
|
||||||
|
8. **Phase 4.1** — Colored diff for `/diff`.
|
||||||
|
|
||||||
|
### Longer-Term
|
||||||
|
|
||||||
|
9. **Phase 5** — Color themes (user demand-driven).
|
||||||
|
10. **Phase 4.2–4.6** — Enhanced navigation and commands.
|
||||||
|
11. **Phase 6** — Full-screen mode (major undertaking, evaluate after earlier phases ship).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. Architecture Recommendations
|
||||||
|
|
||||||
|
### Module Structure After Phase 0
|
||||||
|
|
||||||
|
```
|
||||||
|
crates/rusty-claude-cli/src/
|
||||||
|
├── main.rs # Entrypoint, arg dispatch only (~100 lines)
|
||||||
|
├── args.rs # CLI argument parsing (consolidate existing two parsers)
|
||||||
|
├── app.rs # LiveCli struct, REPL loop, turn execution
|
||||||
|
├── format.rs # All report formatting (status, cost, model, permissions, etc.)
|
||||||
|
├── session_mgr.rs # Session CRUD: create, resume, list, switch, persist
|
||||||
|
├── init.rs # Repo initialization (unchanged)
|
||||||
|
├── input.rs # Line editor (unchanged, minor extensions)
|
||||||
|
├── render.rs # TerminalRenderer, Spinner (extended)
|
||||||
|
└── tui/
|
||||||
|
├── mod.rs # TUI module root
|
||||||
|
├── status_bar.rs # Persistent bottom status line
|
||||||
|
├── tool_panel.rs # Tool call visualization (boxes, timelines, collapsible)
|
||||||
|
├── diff_view.rs # Colored diff rendering
|
||||||
|
├── pager.rs # Internal pager for long outputs
|
||||||
|
└── theme.rs # Color theme definitions and selection
|
||||||
|
```
|
||||||
|
|
||||||
|
### Key Design Principles
|
||||||
|
|
||||||
|
1. **Keep the inline REPL as the default** — Full-screen TUI should be opt-in (`--tui` flag)
|
||||||
|
2. **Everything testable without a terminal** — All formatting functions take `&mut impl Write`, never assume stdout directly
|
||||||
|
3. **Streaming-first** — Rendering should work incrementally, not buffering the entire response
|
||||||
|
4. **Respect `crossterm` for all terminal control** — Don't mix raw ANSI escape codes with crossterm (the current codebase does this in the startup banner)
|
||||||
|
5. **Feature-gate heavy dependencies** — `ratatui` should be behind a `full-tui` feature flag
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. Risk Assessment
|
||||||
|
|
||||||
|
| Risk | Mitigation |
|
||||||
|
|---|---|
|
||||||
|
| Breaking the working REPL during refactor | Phase 0 is pure restructuring with existing test coverage as safety net |
|
||||||
|
| Terminal compatibility issues (tmux, SSH, Windows) | Rely on crossterm's abstraction; test in degraded environments |
|
||||||
|
| Performance regression with rich rendering | Profile before/after; keep the fast path (raw streaming) always available |
|
||||||
|
| Scope creep into Phase 6 | Ship Phases 0–3 as a coherent release before starting Phase 6 |
|
||||||
|
| `app.rs` vs `main.rs` confusion | Phase 0.2 explicitly resolves this by removing the legacy `CliApp` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Generated: 2026-03-31 | Workspace: `rust/` | Branch: `dev/rust`*
|
||||||
@@ -216,4 +216,64 @@ mod tests {
|
|||||||
))
|
))
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn parses_thinking_content_block_start() {
|
||||||
|
let frame = concat!(
|
||||||
|
"event: content_block_start\n",
|
||||||
|
"data: {\"type\":\"content_block_start\",\"index\":0,\"content_block\":{\"type\":\"thinking\",\"thinking\":\"\",\"signature\":null}}\n\n"
|
||||||
|
);
|
||||||
|
|
||||||
|
let event = parse_frame(frame).expect("frame should parse");
|
||||||
|
assert_eq!(
|
||||||
|
event,
|
||||||
|
Some(StreamEvent::ContentBlockStart(
|
||||||
|
crate::types::ContentBlockStartEvent {
|
||||||
|
index: 0,
|
||||||
|
content_block: OutputContentBlock::Thinking {
|
||||||
|
thinking: String::new(),
|
||||||
|
signature: None,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn parses_thinking_related_deltas() {
|
||||||
|
let thinking = concat!(
|
||||||
|
"event: content_block_delta\n",
|
||||||
|
"data: {\"type\":\"content_block_delta\",\"index\":0,\"delta\":{\"type\":\"thinking_delta\",\"thinking\":\"step 1\"}}\n\n"
|
||||||
|
);
|
||||||
|
let signature = concat!(
|
||||||
|
"event: content_block_delta\n",
|
||||||
|
"data: {\"type\":\"content_block_delta\",\"index\":0,\"delta\":{\"type\":\"signature_delta\",\"signature\":\"sig_123\"}}\n\n"
|
||||||
|
);
|
||||||
|
|
||||||
|
let thinking_event = parse_frame(thinking).expect("thinking delta should parse");
|
||||||
|
let signature_event = parse_frame(signature).expect("signature delta should parse");
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
thinking_event,
|
||||||
|
Some(StreamEvent::ContentBlockDelta(
|
||||||
|
crate::types::ContentBlockDeltaEvent {
|
||||||
|
index: 0,
|
||||||
|
delta: ContentBlockDelta::ThinkingDelta {
|
||||||
|
thinking: "step 1".to_string(),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
))
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
signature_event,
|
||||||
|
Some(StreamEvent::ContentBlockDelta(
|
||||||
|
crate::types::ContentBlockDeltaEvent {
|
||||||
|
index: 0,
|
||||||
|
delta: ContentBlockDelta::SignatureDelta {
|
||||||
|
signature: "sig_123".to_string(),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
))
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -135,6 +135,15 @@ pub enum OutputContentBlock {
|
|||||||
name: String,
|
name: String,
|
||||||
input: Value,
|
input: Value,
|
||||||
},
|
},
|
||||||
|
Thinking {
|
||||||
|
#[serde(default)]
|
||||||
|
thinking: String,
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
signature: Option<String>,
|
||||||
|
},
|
||||||
|
RedactedThinking {
|
||||||
|
data: Value,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||||
@@ -190,6 +199,8 @@ pub struct ContentBlockDeltaEvent {
|
|||||||
pub enum ContentBlockDelta {
|
pub enum ContentBlockDelta {
|
||||||
TextDelta { text: String },
|
TextDelta { text: String },
|
||||||
InputJsonDelta { partial_json: String },
|
InputJsonDelta { partial_json: String },
|
||||||
|
ThinkingDelta { thinking: String },
|
||||||
|
SignatureDelta { signature: String },
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||||
|
|||||||
@@ -75,6 +75,48 @@ async fn send_message_posts_json_and_parses_response() {
|
|||||||
assert_eq!(body["tool_choice"]["type"], json!("auto"));
|
assert_eq!(body["tool_choice"]["type"], json!("auto"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn send_message_parses_response_with_thinking_blocks() {
|
||||||
|
let state = Arc::new(Mutex::new(Vec::<CapturedRequest>::new()));
|
||||||
|
let body = concat!(
|
||||||
|
"{",
|
||||||
|
"\"id\":\"msg_thinking\",",
|
||||||
|
"\"type\":\"message\",",
|
||||||
|
"\"role\":\"assistant\",",
|
||||||
|
"\"content\":[",
|
||||||
|
"{\"type\":\"thinking\",\"thinking\":\"step 1\",\"signature\":\"sig_123\"},",
|
||||||
|
"{\"type\":\"text\",\"text\":\"Final answer\"}",
|
||||||
|
"],",
|
||||||
|
"\"model\":\"claude-3-7-sonnet-latest\",",
|
||||||
|
"\"stop_reason\":\"end_turn\",",
|
||||||
|
"\"stop_sequence\":null,",
|
||||||
|
"\"usage\":{\"input_tokens\":12,\"output_tokens\":4}",
|
||||||
|
"}"
|
||||||
|
);
|
||||||
|
let server = spawn_server(
|
||||||
|
state,
|
||||||
|
vec![http_response("200 OK", "application/json", body)],
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
let client = AnthropicClient::new("test-key").with_base_url(server.base_url());
|
||||||
|
let response = client
|
||||||
|
.send_message(&sample_request(false))
|
||||||
|
.await
|
||||||
|
.expect("request should succeed");
|
||||||
|
|
||||||
|
assert_eq!(response.content.len(), 2);
|
||||||
|
assert!(matches!(
|
||||||
|
&response.content[0],
|
||||||
|
OutputContentBlock::Thinking { thinking, signature }
|
||||||
|
if thinking == "step 1" && signature.as_deref() == Some("sig_123")
|
||||||
|
));
|
||||||
|
assert!(matches!(
|
||||||
|
&response.content[1],
|
||||||
|
OutputContentBlock::Text { text } if text == "Final answer"
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn stream_message_parses_sse_events_with_tool_use() {
|
async fn stream_message_parses_sse_events_with_tool_use() {
|
||||||
let state = Arc::new(Mutex::new(Vec::<CapturedRequest>::new()));
|
let state = Arc::new(Mutex::new(Vec::<CapturedRequest>::new()));
|
||||||
@@ -162,6 +204,85 @@ async fn stream_message_parses_sse_events_with_tool_use() {
|
|||||||
assert!(request.body.contains("\"stream\":true"));
|
assert!(request.body.contains("\"stream\":true"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn stream_message_parses_sse_events_with_thinking_blocks() {
|
||||||
|
let state = Arc::new(Mutex::new(Vec::<CapturedRequest>::new()));
|
||||||
|
let sse = concat!(
|
||||||
|
"event: message_start\n",
|
||||||
|
"data: {\"type\":\"message_start\",\"message\":{\"id\":\"msg_stream_thinking\",\"type\":\"message\",\"role\":\"assistant\",\"content\":[],\"model\":\"claude-3-7-sonnet-latest\",\"stop_reason\":null,\"stop_sequence\":null,\"usage\":{\"input_tokens\":8,\"output_tokens\":0}}}\n\n",
|
||||||
|
"event: content_block_start\n",
|
||||||
|
"data: {\"type\":\"content_block_start\",\"index\":0,\"content_block\":{\"type\":\"thinking\",\"thinking\":\"\"}}\n\n",
|
||||||
|
"event: content_block_delta\n",
|
||||||
|
"data: {\"type\":\"content_block_delta\",\"index\":0,\"delta\":{\"type\":\"thinking_delta\",\"thinking\":\"step 1\"}}\n\n",
|
||||||
|
"event: content_block_delta\n",
|
||||||
|
"data: {\"type\":\"content_block_delta\",\"index\":0,\"delta\":{\"type\":\"signature_delta\",\"signature\":\"sig_123\"}}\n\n",
|
||||||
|
"event: content_block_stop\n",
|
||||||
|
"data: {\"type\":\"content_block_stop\",\"index\":0}\n\n",
|
||||||
|
"event: content_block_start\n",
|
||||||
|
"data: {\"type\":\"content_block_start\",\"index\":1,\"content_block\":{\"type\":\"text\",\"text\":\"Final answer\"}}\n\n",
|
||||||
|
"event: content_block_stop\n",
|
||||||
|
"data: {\"type\":\"content_block_stop\",\"index\":1}\n\n",
|
||||||
|
"event: message_delta\n",
|
||||||
|
"data: {\"type\":\"message_delta\",\"delta\":{\"stop_reason\":\"end_turn\",\"stop_sequence\":null},\"usage\":{\"input_tokens\":8,\"output_tokens\":1}}\n\n",
|
||||||
|
"event: message_stop\n",
|
||||||
|
"data: {\"type\":\"message_stop\"}\n\n",
|
||||||
|
"data: [DONE]\n\n"
|
||||||
|
);
|
||||||
|
let server = spawn_server(
|
||||||
|
state,
|
||||||
|
vec![http_response("200 OK", "text/event-stream", sse)],
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
let client = AnthropicClient::new("test-key").with_base_url(server.base_url());
|
||||||
|
let mut stream = client
|
||||||
|
.stream_message(&sample_request(false))
|
||||||
|
.await
|
||||||
|
.expect("stream should start");
|
||||||
|
|
||||||
|
let mut events = Vec::new();
|
||||||
|
while let Some(event) = stream
|
||||||
|
.next_event()
|
||||||
|
.await
|
||||||
|
.expect("stream event should parse")
|
||||||
|
{
|
||||||
|
events.push(event);
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_eq!(events.len(), 9);
|
||||||
|
assert!(matches!(
|
||||||
|
&events[1],
|
||||||
|
StreamEvent::ContentBlockStart(ContentBlockStartEvent {
|
||||||
|
content_block: OutputContentBlock::Thinking { thinking, signature },
|
||||||
|
..
|
||||||
|
}) if thinking.is_empty() && signature.is_none()
|
||||||
|
));
|
||||||
|
assert!(matches!(
|
||||||
|
&events[2],
|
||||||
|
StreamEvent::ContentBlockDelta(ContentBlockDeltaEvent {
|
||||||
|
delta: ContentBlockDelta::ThinkingDelta { thinking },
|
||||||
|
..
|
||||||
|
}) if thinking == "step 1"
|
||||||
|
));
|
||||||
|
assert!(matches!(
|
||||||
|
&events[3],
|
||||||
|
StreamEvent::ContentBlockDelta(ContentBlockDeltaEvent {
|
||||||
|
delta: ContentBlockDelta::SignatureDelta { signature },
|
||||||
|
..
|
||||||
|
}) if signature == "sig_123"
|
||||||
|
));
|
||||||
|
assert!(matches!(
|
||||||
|
&events[5],
|
||||||
|
StreamEvent::ContentBlockStart(ContentBlockStartEvent {
|
||||||
|
content_block: OutputContentBlock::Text { text },
|
||||||
|
..
|
||||||
|
}) if text == "Final answer"
|
||||||
|
));
|
||||||
|
assert!(matches!(events[6], StreamEvent::ContentBlockStop(_)));
|
||||||
|
assert!(matches!(events[7], StreamEvent::MessageDelta(_)));
|
||||||
|
assert!(matches!(events[8], StreamEvent::MessageStop(_)));
|
||||||
|
}
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn retries_retryable_failures_before_succeeding() {
|
async fn retries_retryable_failures_before_succeeding() {
|
||||||
let state = Arc::new(Mutex::new(Vec::<CapturedRequest>::new()));
|
let state = Arc::new(Mutex::new(Vec::<CapturedRequest>::new()));
|
||||||
|
|||||||
@@ -9,4 +9,5 @@ publish.workspace = true
|
|||||||
workspace = true
|
workspace = true
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
plugins = { path = "../plugins" }
|
||||||
runtime = { path = "../runtime" }
|
runtime = { path = "../runtime" }
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -70,16 +70,12 @@ fn upstream_repo_candidates(primary_repo_root: &Path) -> Vec<PathBuf> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for ancestor in primary_repo_root.ancestors().take(4) {
|
for ancestor in primary_repo_root.ancestors().take(4) {
|
||||||
candidates.push(ancestor.join("claude-code"));
|
candidates.push(ancestor.join("claw-code"));
|
||||||
candidates.push(ancestor.join("clawd-code"));
|
candidates.push(ancestor.join("clawd-code"));
|
||||||
}
|
}
|
||||||
|
|
||||||
candidates.push(
|
candidates.push(primary_repo_root.join("reference-source").join("claw-code"));
|
||||||
primary_repo_root
|
candidates.push(primary_repo_root.join("vendor").join("claw-code"));
|
||||||
.join("reference-source")
|
|
||||||
.join("claude-code"),
|
|
||||||
);
|
|
||||||
candidates.push(primary_repo_root.join("vendor").join("claude-code"));
|
|
||||||
|
|
||||||
let mut deduped = Vec::new();
|
let mut deduped = Vec::new();
|
||||||
for candidate in candidates {
|
for candidate in candidates {
|
||||||
|
|||||||
13
rust/crates/plugins/Cargo.toml
Normal file
13
rust/crates/plugins/Cargo.toml
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
[package]
|
||||||
|
name = "plugins"
|
||||||
|
version.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
publish.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
serde = { version = "1", features = ["derive"] }
|
||||||
|
serde_json = "1"
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"name": "example-bundled",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Example bundled plugin scaffold for the Rust plugin system",
|
||||||
|
"defaultEnabled": false,
|
||||||
|
"hooks": {
|
||||||
|
"PreToolUse": ["./hooks/pre.sh"],
|
||||||
|
"PostToolUse": ["./hooks/post.sh"]
|
||||||
|
}
|
||||||
|
}
|
||||||
2
rust/crates/plugins/bundled/example-bundled/hooks/post.sh
Executable file
2
rust/crates/plugins/bundled/example-bundled/hooks/post.sh
Executable file
@@ -0,0 +1,2 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
printf '%s\n' 'example bundled post hook'
|
||||||
2
rust/crates/plugins/bundled/example-bundled/hooks/pre.sh
Executable file
2
rust/crates/plugins/bundled/example-bundled/hooks/pre.sh
Executable file
@@ -0,0 +1,2 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
printf '%s\n' 'example bundled pre hook'
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"name": "sample-hooks",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Bundled sample plugin scaffold for hook integration tests.",
|
||||||
|
"defaultEnabled": false,
|
||||||
|
"hooks": {
|
||||||
|
"PreToolUse": ["./hooks/pre.sh"],
|
||||||
|
"PostToolUse": ["./hooks/post.sh"]
|
||||||
|
}
|
||||||
|
}
|
||||||
2
rust/crates/plugins/bundled/sample-hooks/hooks/post.sh
Executable file
2
rust/crates/plugins/bundled/sample-hooks/hooks/post.sh
Executable file
@@ -0,0 +1,2 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
printf 'sample bundled post hook'
|
||||||
2
rust/crates/plugins/bundled/sample-hooks/hooks/pre.sh
Executable file
2
rust/crates/plugins/bundled/sample-hooks/hooks/pre.sh
Executable file
@@ -0,0 +1,2 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
printf 'sample bundled pre hook'
|
||||||
395
rust/crates/plugins/src/hooks.rs
Normal file
395
rust/crates/plugins/src/hooks.rs
Normal file
@@ -0,0 +1,395 @@
|
|||||||
|
use std::ffi::OsStr;
|
||||||
|
use std::path::Path;
|
||||||
|
use std::process::Command;
|
||||||
|
|
||||||
|
use serde_json::json;
|
||||||
|
|
||||||
|
use crate::{PluginError, PluginHooks, PluginRegistry};
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
|
pub enum HookEvent {
|
||||||
|
PreToolUse,
|
||||||
|
PostToolUse,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookEvent {
|
||||||
|
fn as_str(self) -> &'static str {
|
||||||
|
match self {
|
||||||
|
Self::PreToolUse => "PreToolUse",
|
||||||
|
Self::PostToolUse => "PostToolUse",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct HookRunResult {
|
||||||
|
denied: bool,
|
||||||
|
messages: Vec<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookRunResult {
|
||||||
|
#[must_use]
|
||||||
|
pub fn allow(messages: Vec<String>) -> Self {
|
||||||
|
Self {
|
||||||
|
denied: false,
|
||||||
|
messages,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn is_denied(&self) -> bool {
|
||||||
|
self.denied
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn messages(&self) -> &[String] {
|
||||||
|
&self.messages
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
pub struct HookRunner {
|
||||||
|
hooks: PluginHooks,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookRunner {
|
||||||
|
#[must_use]
|
||||||
|
pub fn new(hooks: PluginHooks) -> Self {
|
||||||
|
Self { hooks }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn from_registry(plugin_registry: &PluginRegistry) -> Result<Self, PluginError> {
|
||||||
|
Ok(Self::new(plugin_registry.aggregated_hooks()?))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_pre_tool_use(&self, tool_name: &str, tool_input: &str) -> HookRunResult {
|
||||||
|
self.run_commands(
|
||||||
|
HookEvent::PreToolUse,
|
||||||
|
&self.hooks.pre_tool_use,
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
None,
|
||||||
|
false,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: &str,
|
||||||
|
is_error: bool,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_commands(
|
||||||
|
HookEvent::PostToolUse,
|
||||||
|
&self.hooks.post_tool_use,
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
Some(tool_output),
|
||||||
|
is_error,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn run_commands(
|
||||||
|
&self,
|
||||||
|
event: HookEvent,
|
||||||
|
commands: &[String],
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: Option<&str>,
|
||||||
|
is_error: bool,
|
||||||
|
) -> HookRunResult {
|
||||||
|
if commands.is_empty() {
|
||||||
|
return HookRunResult::allow(Vec::new());
|
||||||
|
}
|
||||||
|
|
||||||
|
let payload = json!({
|
||||||
|
"hook_event_name": event.as_str(),
|
||||||
|
"tool_name": tool_name,
|
||||||
|
"tool_input": parse_tool_input(tool_input),
|
||||||
|
"tool_input_json": tool_input,
|
||||||
|
"tool_output": tool_output,
|
||||||
|
"tool_result_is_error": is_error,
|
||||||
|
})
|
||||||
|
.to_string();
|
||||||
|
|
||||||
|
let mut messages = Vec::new();
|
||||||
|
|
||||||
|
for command in commands {
|
||||||
|
match self.run_command(
|
||||||
|
command,
|
||||||
|
event,
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
tool_output,
|
||||||
|
is_error,
|
||||||
|
&payload,
|
||||||
|
) {
|
||||||
|
HookCommandOutcome::Allow { message } => {
|
||||||
|
if let Some(message) = message {
|
||||||
|
messages.push(message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
HookCommandOutcome::Deny { message } => {
|
||||||
|
messages.push(message.unwrap_or_else(|| {
|
||||||
|
format!("{} hook denied tool `{tool_name}`", event.as_str())
|
||||||
|
}));
|
||||||
|
return HookRunResult {
|
||||||
|
denied: true,
|
||||||
|
messages,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
HookCommandOutcome::Warn { message } => messages.push(message),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
HookRunResult::allow(messages)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_arguments, clippy::unused_self)]
|
||||||
|
fn run_command(
|
||||||
|
&self,
|
||||||
|
command: &str,
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: Option<&str>,
|
||||||
|
is_error: bool,
|
||||||
|
payload: &str,
|
||||||
|
) -> HookCommandOutcome {
|
||||||
|
let mut child = shell_command(command);
|
||||||
|
child.stdin(std::process::Stdio::piped());
|
||||||
|
child.stdout(std::process::Stdio::piped());
|
||||||
|
child.stderr(std::process::Stdio::piped());
|
||||||
|
child.env("HOOK_EVENT", event.as_str());
|
||||||
|
child.env("HOOK_TOOL_NAME", tool_name);
|
||||||
|
child.env("HOOK_TOOL_INPUT", tool_input);
|
||||||
|
child.env("HOOK_TOOL_IS_ERROR", if is_error { "1" } else { "0" });
|
||||||
|
if let Some(tool_output) = tool_output {
|
||||||
|
child.env("HOOK_TOOL_OUTPUT", tool_output);
|
||||||
|
}
|
||||||
|
|
||||||
|
match child.output_with_stdin(payload.as_bytes()) {
|
||||||
|
Ok(output) => {
|
||||||
|
let stdout = String::from_utf8_lossy(&output.stdout).trim().to_string();
|
||||||
|
let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
|
||||||
|
let message = (!stdout.is_empty()).then_some(stdout);
|
||||||
|
match output.status.code() {
|
||||||
|
Some(0) => HookCommandOutcome::Allow { message },
|
||||||
|
Some(2) => HookCommandOutcome::Deny { message },
|
||||||
|
Some(code) => HookCommandOutcome::Warn {
|
||||||
|
message: format_hook_warning(
|
||||||
|
command,
|
||||||
|
code,
|
||||||
|
message.as_deref(),
|
||||||
|
stderr.as_str(),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
None => HookCommandOutcome::Warn {
|
||||||
|
message: format!(
|
||||||
|
"{} hook `{command}` terminated by signal while handling `{tool_name}`",
|
||||||
|
event.as_str()
|
||||||
|
),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(error) => HookCommandOutcome::Warn {
|
||||||
|
message: format!(
|
||||||
|
"{} hook `{command}` failed to start for `{tool_name}`: {error}",
|
||||||
|
event.as_str()
|
||||||
|
),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
enum HookCommandOutcome {
|
||||||
|
Allow { message: Option<String> },
|
||||||
|
Deny { message: Option<String> },
|
||||||
|
Warn { message: String },
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_tool_input(tool_input: &str) -> serde_json::Value {
|
||||||
|
serde_json::from_str(tool_input).unwrap_or_else(|_| json!({ "raw": tool_input }))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn format_hook_warning(command: &str, code: i32, stdout: Option<&str>, stderr: &str) -> String {
|
||||||
|
let mut message =
|
||||||
|
format!("Hook `{command}` exited with status {code}; allowing tool execution to continue");
|
||||||
|
if let Some(stdout) = stdout.filter(|stdout| !stdout.is_empty()) {
|
||||||
|
message.push_str(": ");
|
||||||
|
message.push_str(stdout);
|
||||||
|
} else if !stderr.is_empty() {
|
||||||
|
message.push_str(": ");
|
||||||
|
message.push_str(stderr);
|
||||||
|
}
|
||||||
|
message
|
||||||
|
}
|
||||||
|
|
||||||
|
fn shell_command(command: &str) -> CommandWithStdin {
|
||||||
|
#[cfg(windows)]
|
||||||
|
let command_builder = {
|
||||||
|
let mut command_builder = Command::new("cmd");
|
||||||
|
command_builder.arg("/C").arg(command);
|
||||||
|
CommandWithStdin::new(command_builder)
|
||||||
|
};
|
||||||
|
|
||||||
|
#[cfg(not(windows))]
|
||||||
|
let command_builder = if Path::new(command).exists() {
|
||||||
|
let mut command_builder = Command::new("sh");
|
||||||
|
command_builder.arg(command);
|
||||||
|
CommandWithStdin::new(command_builder)
|
||||||
|
} else {
|
||||||
|
let mut command_builder = Command::new("sh");
|
||||||
|
command_builder.arg("-lc").arg(command);
|
||||||
|
CommandWithStdin::new(command_builder)
|
||||||
|
};
|
||||||
|
|
||||||
|
command_builder
|
||||||
|
}
|
||||||
|
|
||||||
|
struct CommandWithStdin {
|
||||||
|
command: Command,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CommandWithStdin {
|
||||||
|
fn new(command: Command) -> Self {
|
||||||
|
Self { command }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn stdin(&mut self, cfg: std::process::Stdio) -> &mut Self {
|
||||||
|
self.command.stdin(cfg);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn stdout(&mut self, cfg: std::process::Stdio) -> &mut Self {
|
||||||
|
self.command.stdout(cfg);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn stderr(&mut self, cfg: std::process::Stdio) -> &mut Self {
|
||||||
|
self.command.stderr(cfg);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn env<K, V>(&mut self, key: K, value: V) -> &mut Self
|
||||||
|
where
|
||||||
|
K: AsRef<OsStr>,
|
||||||
|
V: AsRef<OsStr>,
|
||||||
|
{
|
||||||
|
self.command.env(key, value);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn output_with_stdin(&mut self, stdin: &[u8]) -> std::io::Result<std::process::Output> {
|
||||||
|
let mut child = self.command.spawn()?;
|
||||||
|
if let Some(mut child_stdin) = child.stdin.take() {
|
||||||
|
use std::io::Write as _;
|
||||||
|
child_stdin.write_all(stdin)?;
|
||||||
|
}
|
||||||
|
child.wait_with_output()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::{HookRunResult, HookRunner};
|
||||||
|
use crate::{PluginManager, PluginManagerConfig};
|
||||||
|
use std::fs;
|
||||||
|
use std::path::{Path, PathBuf};
|
||||||
|
use std::time::{SystemTime, UNIX_EPOCH};
|
||||||
|
|
||||||
|
fn temp_dir(label: &str) -> PathBuf {
|
||||||
|
let nanos = SystemTime::now()
|
||||||
|
.duration_since(UNIX_EPOCH)
|
||||||
|
.expect("time should be after epoch")
|
||||||
|
.as_nanos();
|
||||||
|
std::env::temp_dir().join(format!("plugins-hook-runner-{label}-{nanos}"))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn write_hook_plugin(root: &Path, name: &str, pre_message: &str, post_message: &str) {
|
||||||
|
fs::create_dir_all(root.join(".claude-plugin")).expect("manifest dir");
|
||||||
|
fs::create_dir_all(root.join("hooks")).expect("hooks dir");
|
||||||
|
fs::write(
|
||||||
|
root.join("hooks").join("pre.sh"),
|
||||||
|
format!("#!/bin/sh\nprintf '%s\\n' '{pre_message}'\n"),
|
||||||
|
)
|
||||||
|
.expect("write pre hook");
|
||||||
|
fs::write(
|
||||||
|
root.join("hooks").join("post.sh"),
|
||||||
|
format!("#!/bin/sh\nprintf '%s\\n' '{post_message}'\n"),
|
||||||
|
)
|
||||||
|
.expect("write post hook");
|
||||||
|
fs::write(
|
||||||
|
root.join(".claude-plugin").join("plugin.json"),
|
||||||
|
format!(
|
||||||
|
"{{\n \"name\": \"{name}\",\n \"version\": \"1.0.0\",\n \"description\": \"hook plugin\",\n \"hooks\": {{\n \"PreToolUse\": [\"./hooks/pre.sh\"],\n \"PostToolUse\": [\"./hooks/post.sh\"]\n }}\n}}"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.expect("write plugin manifest");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn collects_and_runs_hooks_from_enabled_plugins() {
|
||||||
|
let config_home = temp_dir("config");
|
||||||
|
let first_source_root = temp_dir("source-a");
|
||||||
|
let second_source_root = temp_dir("source-b");
|
||||||
|
write_hook_plugin(
|
||||||
|
&first_source_root,
|
||||||
|
"first",
|
||||||
|
"plugin pre one",
|
||||||
|
"plugin post one",
|
||||||
|
);
|
||||||
|
write_hook_plugin(
|
||||||
|
&second_source_root,
|
||||||
|
"second",
|
||||||
|
"plugin pre two",
|
||||||
|
"plugin post two",
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut manager = PluginManager::new(PluginManagerConfig::new(&config_home));
|
||||||
|
manager
|
||||||
|
.install(first_source_root.to_str().expect("utf8 path"))
|
||||||
|
.expect("first plugin install should succeed");
|
||||||
|
manager
|
||||||
|
.install(second_source_root.to_str().expect("utf8 path"))
|
||||||
|
.expect("second plugin install should succeed");
|
||||||
|
let registry = manager.plugin_registry().expect("registry should build");
|
||||||
|
|
||||||
|
let runner = HookRunner::from_registry(®istry).expect("plugin hooks should load");
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
runner.run_pre_tool_use("Read", r#"{"path":"README.md"}"#),
|
||||||
|
HookRunResult::allow(vec![
|
||||||
|
"plugin pre one".to_string(),
|
||||||
|
"plugin pre two".to_string(),
|
||||||
|
])
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
runner.run_post_tool_use("Read", r#"{"path":"README.md"}"#, "ok", false),
|
||||||
|
HookRunResult::allow(vec![
|
||||||
|
"plugin post one".to_string(),
|
||||||
|
"plugin post two".to_string(),
|
||||||
|
])
|
||||||
|
);
|
||||||
|
|
||||||
|
let _ = fs::remove_dir_all(config_home);
|
||||||
|
let _ = fs::remove_dir_all(first_source_root);
|
||||||
|
let _ = fs::remove_dir_all(second_source_root);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn pre_tool_use_denies_when_plugin_hook_exits_two() {
|
||||||
|
let runner = HookRunner::new(crate::PluginHooks {
|
||||||
|
pre_tool_use: vec!["printf 'blocked by plugin'; exit 2".to_string()],
|
||||||
|
post_tool_use: Vec::new(),
|
||||||
|
});
|
||||||
|
|
||||||
|
let result = runner.run_pre_tool_use("Bash", r#"{"command":"pwd"}"#);
|
||||||
|
|
||||||
|
assert!(result.is_denied());
|
||||||
|
assert_eq!(result.messages(), &["blocked by plugin".to_string()]);
|
||||||
|
}
|
||||||
|
}
|
||||||
2935
rust/crates/plugins/src/lib.rs
Normal file
2935
rust/crates/plugins/src/lib.rs
Normal file
File diff suppressed because it is too large
Load Diff
@@ -8,6 +8,7 @@ publish.workspace = true
|
|||||||
[dependencies]
|
[dependencies]
|
||||||
sha2 = "0.10"
|
sha2 = "0.10"
|
||||||
glob = "0.3"
|
glob = "0.3"
|
||||||
|
plugins = { path = "../plugins" }
|
||||||
regex = "1"
|
regex = "1"
|
||||||
serde = { version = "1", features = ["derive"] }
|
serde = { version = "1", features = ["derive"] }
|
||||||
serde_json = "1"
|
serde_json = "1"
|
||||||
|
|||||||
@@ -1,5 +1,10 @@
|
|||||||
use crate::session::{ContentBlock, ConversationMessage, MessageRole, Session};
|
use crate::session::{ContentBlock, ConversationMessage, MessageRole, Session};
|
||||||
|
|
||||||
|
const COMPACT_CONTINUATION_PREAMBLE: &str =
|
||||||
|
"This session is being continued from a previous conversation that ran out of context. The summary below covers the earlier portion of the conversation.\n\n";
|
||||||
|
const COMPACT_RECENT_MESSAGES_NOTE: &str = "Recent messages are preserved verbatim.";
|
||||||
|
const COMPACT_DIRECT_RESUME_INSTRUCTION: &str = "Continue the conversation from where it left off without asking the user any further questions. Resume directly — do not acknowledge the summary, do not recap what was happening, and do not preface with continuation text.";
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
pub struct CompactionConfig {
|
pub struct CompactionConfig {
|
||||||
pub preserve_recent_messages: usize,
|
pub preserve_recent_messages: usize,
|
||||||
@@ -30,8 +35,15 @@ pub fn estimate_session_tokens(session: &Session) -> usize {
|
|||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn should_compact(session: &Session, config: CompactionConfig) -> bool {
|
pub fn should_compact(session: &Session, config: CompactionConfig) -> bool {
|
||||||
session.messages.len() > config.preserve_recent_messages
|
let start = compacted_summary_prefix_len(session);
|
||||||
&& estimate_session_tokens(session) >= config.max_estimated_tokens
|
let compactable = &session.messages[start..];
|
||||||
|
|
||||||
|
compactable.len() > config.preserve_recent_messages
|
||||||
|
&& compactable
|
||||||
|
.iter()
|
||||||
|
.map(estimate_message_tokens)
|
||||||
|
.sum::<usize>()
|
||||||
|
>= config.max_estimated_tokens
|
||||||
}
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
@@ -56,16 +68,18 @@ pub fn get_compact_continuation_message(
|
|||||||
recent_messages_preserved: bool,
|
recent_messages_preserved: bool,
|
||||||
) -> String {
|
) -> String {
|
||||||
let mut base = format!(
|
let mut base = format!(
|
||||||
"This session is being continued from a previous conversation that ran out of context. The summary below covers the earlier portion of the conversation.\n\n{}",
|
"{COMPACT_CONTINUATION_PREAMBLE}{}",
|
||||||
format_compact_summary(summary)
|
format_compact_summary(summary)
|
||||||
);
|
);
|
||||||
|
|
||||||
if recent_messages_preserved {
|
if recent_messages_preserved {
|
||||||
base.push_str("\n\nRecent messages are preserved verbatim.");
|
base.push_str("\n\n");
|
||||||
|
base.push_str(COMPACT_RECENT_MESSAGES_NOTE);
|
||||||
}
|
}
|
||||||
|
|
||||||
if suppress_follow_up_questions {
|
if suppress_follow_up_questions {
|
||||||
base.push_str("\nContinue the conversation from where it left off without asking the user any further questions. Resume directly — do not acknowledge the summary, do not recap what was happening, and do not preface with continuation text.");
|
base.push('\n');
|
||||||
|
base.push_str(COMPACT_DIRECT_RESUME_INSTRUCTION);
|
||||||
}
|
}
|
||||||
|
|
||||||
base
|
base
|
||||||
@@ -82,13 +96,19 @@ pub fn compact_session(session: &Session, config: CompactionConfig) -> Compactio
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let existing_summary = session
|
||||||
|
.messages
|
||||||
|
.first()
|
||||||
|
.and_then(extract_existing_compacted_summary);
|
||||||
|
let compacted_prefix_len = usize::from(existing_summary.is_some());
|
||||||
let keep_from = session
|
let keep_from = session
|
||||||
.messages
|
.messages
|
||||||
.len()
|
.len()
|
||||||
.saturating_sub(config.preserve_recent_messages);
|
.saturating_sub(config.preserve_recent_messages);
|
||||||
let removed = &session.messages[..keep_from];
|
let removed = &session.messages[compacted_prefix_len..keep_from];
|
||||||
let preserved = session.messages[keep_from..].to_vec();
|
let preserved = session.messages[keep_from..].to_vec();
|
||||||
let summary = summarize_messages(removed);
|
let summary =
|
||||||
|
merge_compact_summaries(existing_summary.as_deref(), &summarize_messages(removed));
|
||||||
let formatted_summary = format_compact_summary(&summary);
|
let formatted_summary = format_compact_summary(&summary);
|
||||||
let continuation = get_compact_continuation_message(&summary, true, !preserved.is_empty());
|
let continuation = get_compact_continuation_message(&summary, true, !preserved.is_empty());
|
||||||
|
|
||||||
@@ -110,6 +130,16 @@ pub fn compact_session(session: &Session, config: CompactionConfig) -> Compactio
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn compacted_summary_prefix_len(session: &Session) -> usize {
|
||||||
|
usize::from(
|
||||||
|
session
|
||||||
|
.messages
|
||||||
|
.first()
|
||||||
|
.and_then(extract_existing_compacted_summary)
|
||||||
|
.is_some(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
fn summarize_messages(messages: &[ConversationMessage]) -> String {
|
fn summarize_messages(messages: &[ConversationMessage]) -> String {
|
||||||
let user_messages = messages
|
let user_messages = messages
|
||||||
.iter()
|
.iter()
|
||||||
@@ -197,6 +227,41 @@ fn summarize_messages(messages: &[ConversationMessage]) -> String {
|
|||||||
lines.join("\n")
|
lines.join("\n")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn merge_compact_summaries(existing_summary: Option<&str>, new_summary: &str) -> String {
|
||||||
|
let Some(existing_summary) = existing_summary else {
|
||||||
|
return new_summary.to_string();
|
||||||
|
};
|
||||||
|
|
||||||
|
let previous_highlights = extract_summary_highlights(existing_summary);
|
||||||
|
let new_formatted_summary = format_compact_summary(new_summary);
|
||||||
|
let new_highlights = extract_summary_highlights(&new_formatted_summary);
|
||||||
|
let new_timeline = extract_summary_timeline(&new_formatted_summary);
|
||||||
|
|
||||||
|
let mut lines = vec!["<summary>".to_string(), "Conversation summary:".to_string()];
|
||||||
|
|
||||||
|
if !previous_highlights.is_empty() {
|
||||||
|
lines.push("- Previously compacted context:".to_string());
|
||||||
|
lines.extend(
|
||||||
|
previous_highlights
|
||||||
|
.into_iter()
|
||||||
|
.map(|line| format!(" {line}")),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if !new_highlights.is_empty() {
|
||||||
|
lines.push("- Newly compacted context:".to_string());
|
||||||
|
lines.extend(new_highlights.into_iter().map(|line| format!(" {line}")));
|
||||||
|
}
|
||||||
|
|
||||||
|
if !new_timeline.is_empty() {
|
||||||
|
lines.push("- Key timeline:".to_string());
|
||||||
|
lines.extend(new_timeline.into_iter().map(|line| format!(" {line}")));
|
||||||
|
}
|
||||||
|
|
||||||
|
lines.push("</summary>".to_string());
|
||||||
|
lines.join("\n")
|
||||||
|
}
|
||||||
|
|
||||||
fn summarize_block(block: &ContentBlock) -> String {
|
fn summarize_block(block: &ContentBlock) -> String {
|
||||||
let raw = match block {
|
let raw = match block {
|
||||||
ContentBlock::Text { text } => text.clone(),
|
ContentBlock::Text { text } => text.clone(),
|
||||||
@@ -374,11 +439,71 @@ fn collapse_blank_lines(content: &str) -> String {
|
|||||||
result
|
result
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn extract_existing_compacted_summary(message: &ConversationMessage) -> Option<String> {
|
||||||
|
if message.role != MessageRole::System {
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
|
||||||
|
let text = first_text_block(message)?;
|
||||||
|
let summary = text.strip_prefix(COMPACT_CONTINUATION_PREAMBLE)?;
|
||||||
|
let summary = summary
|
||||||
|
.split_once(&format!("\n\n{COMPACT_RECENT_MESSAGES_NOTE}"))
|
||||||
|
.map_or(summary, |(value, _)| value);
|
||||||
|
let summary = summary
|
||||||
|
.split_once(&format!("\n{COMPACT_DIRECT_RESUME_INSTRUCTION}"))
|
||||||
|
.map_or(summary, |(value, _)| value);
|
||||||
|
Some(summary.trim().to_string())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn extract_summary_highlights(summary: &str) -> Vec<String> {
|
||||||
|
let mut lines = Vec::new();
|
||||||
|
let mut in_timeline = false;
|
||||||
|
|
||||||
|
for line in format_compact_summary(summary).lines() {
|
||||||
|
let trimmed = line.trim_end();
|
||||||
|
if trimmed.is_empty() || trimmed == "Summary:" || trimmed == "Conversation summary:" {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if trimmed == "- Key timeline:" {
|
||||||
|
in_timeline = true;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if in_timeline {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
lines.push(trimmed.to_string());
|
||||||
|
}
|
||||||
|
|
||||||
|
lines
|
||||||
|
}
|
||||||
|
|
||||||
|
fn extract_summary_timeline(summary: &str) -> Vec<String> {
|
||||||
|
let mut lines = Vec::new();
|
||||||
|
let mut in_timeline = false;
|
||||||
|
|
||||||
|
for line in format_compact_summary(summary).lines() {
|
||||||
|
let trimmed = line.trim_end();
|
||||||
|
if trimmed == "- Key timeline:" {
|
||||||
|
in_timeline = true;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if !in_timeline {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if trimmed.is_empty() {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
lines.push(trimmed.to_string());
|
||||||
|
}
|
||||||
|
|
||||||
|
lines
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::{
|
use super::{
|
||||||
collect_key_files, compact_session, estimate_session_tokens, format_compact_summary,
|
collect_key_files, compact_session, estimate_session_tokens, format_compact_summary,
|
||||||
infer_pending_work, should_compact, CompactionConfig,
|
get_compact_continuation_message, infer_pending_work, should_compact, CompactionConfig,
|
||||||
};
|
};
|
||||||
use crate::session::{ContentBlock, ConversationMessage, MessageRole, Session};
|
use crate::session::{ContentBlock, ConversationMessage, MessageRole, Session};
|
||||||
|
|
||||||
@@ -453,6 +578,98 @@ mod tests {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn keeps_previous_compacted_context_when_compacting_again() {
|
||||||
|
let initial_session = Session {
|
||||||
|
version: 1,
|
||||||
|
messages: vec![
|
||||||
|
ConversationMessage::user_text("Investigate rust/crates/runtime/src/compact.rs"),
|
||||||
|
ConversationMessage::assistant(vec![ContentBlock::Text {
|
||||||
|
text: "I will inspect the compact flow.".to_string(),
|
||||||
|
}]),
|
||||||
|
ConversationMessage::user_text(
|
||||||
|
"Also update rust/crates/runtime/src/conversation.rs",
|
||||||
|
),
|
||||||
|
ConversationMessage::assistant(vec![ContentBlock::Text {
|
||||||
|
text: "Next: preserve prior summary context during auto compact.".to_string(),
|
||||||
|
}]),
|
||||||
|
],
|
||||||
|
};
|
||||||
|
let config = CompactionConfig {
|
||||||
|
preserve_recent_messages: 2,
|
||||||
|
max_estimated_tokens: 1,
|
||||||
|
};
|
||||||
|
|
||||||
|
let first = compact_session(&initial_session, config);
|
||||||
|
let mut follow_up_messages = first.compacted_session.messages.clone();
|
||||||
|
follow_up_messages.extend([
|
||||||
|
ConversationMessage::user_text("Please add regression tests for compaction."),
|
||||||
|
ConversationMessage::assistant(vec![ContentBlock::Text {
|
||||||
|
text: "Working on regression coverage now.".to_string(),
|
||||||
|
}]),
|
||||||
|
]);
|
||||||
|
|
||||||
|
let second = compact_session(
|
||||||
|
&Session {
|
||||||
|
version: 1,
|
||||||
|
messages: follow_up_messages,
|
||||||
|
},
|
||||||
|
config,
|
||||||
|
);
|
||||||
|
|
||||||
|
assert!(second
|
||||||
|
.formatted_summary
|
||||||
|
.contains("Previously compacted context:"));
|
||||||
|
assert!(second
|
||||||
|
.formatted_summary
|
||||||
|
.contains("Scope: 2 earlier messages compacted"));
|
||||||
|
assert!(second
|
||||||
|
.formatted_summary
|
||||||
|
.contains("Newly compacted context:"));
|
||||||
|
assert!(second
|
||||||
|
.formatted_summary
|
||||||
|
.contains("Also update rust/crates/runtime/src/conversation.rs"));
|
||||||
|
assert!(matches!(
|
||||||
|
&second.compacted_session.messages[0].blocks[0],
|
||||||
|
ContentBlock::Text { text }
|
||||||
|
if text.contains("Previously compacted context:")
|
||||||
|
&& text.contains("Newly compacted context:")
|
||||||
|
));
|
||||||
|
assert!(matches!(
|
||||||
|
&second.compacted_session.messages[1].blocks[0],
|
||||||
|
ContentBlock::Text { text } if text.contains("Please add regression tests for compaction.")
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn ignores_existing_compacted_summary_when_deciding_to_recompact() {
|
||||||
|
let summary = "<summary>Conversation summary:\n- Scope: earlier work preserved.\n- Key timeline:\n - user: large preserved context\n</summary>";
|
||||||
|
let session = Session {
|
||||||
|
version: 1,
|
||||||
|
messages: vec![
|
||||||
|
ConversationMessage {
|
||||||
|
role: MessageRole::System,
|
||||||
|
blocks: vec![ContentBlock::Text {
|
||||||
|
text: get_compact_continuation_message(summary, true, true),
|
||||||
|
}],
|
||||||
|
usage: None,
|
||||||
|
},
|
||||||
|
ConversationMessage::user_text("tiny"),
|
||||||
|
ConversationMessage::assistant(vec![ContentBlock::Text {
|
||||||
|
text: "recent".to_string(),
|
||||||
|
}]),
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
assert!(!should_compact(
|
||||||
|
&session,
|
||||||
|
CompactionConfig {
|
||||||
|
preserve_recent_messages: 2,
|
||||||
|
max_estimated_tokens: 1,
|
||||||
|
}
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn truncates_long_blocks_in_summary() {
|
fn truncates_long_blocks_in_summary() {
|
||||||
let summary = super::summarize_block(&ContentBlock::Text {
|
let summary = super::summarize_block(&ContentBlock::Text {
|
||||||
|
|||||||
@@ -35,15 +35,41 @@ pub struct RuntimeConfig {
|
|||||||
feature_config: RuntimeFeatureConfig,
|
feature_config: RuntimeFeatureConfig,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
pub struct RuntimePluginConfig {
|
||||||
|
enabled_plugins: BTreeMap<String, bool>,
|
||||||
|
external_directories: Vec<String>,
|
||||||
|
install_root: Option<String>,
|
||||||
|
registry_path: Option<String>,
|
||||||
|
bundled_root: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
pub struct RuntimeFeatureConfig {
|
pub struct RuntimeFeatureConfig {
|
||||||
|
hooks: RuntimeHookConfig,
|
||||||
|
plugins: RuntimePluginConfig,
|
||||||
mcp: McpConfigCollection,
|
mcp: McpConfigCollection,
|
||||||
oauth: Option<OAuthConfig>,
|
oauth: Option<OAuthConfig>,
|
||||||
model: Option<String>,
|
model: Option<String>,
|
||||||
permission_mode: Option<ResolvedPermissionMode>,
|
permission_mode: Option<ResolvedPermissionMode>,
|
||||||
|
permission_rules: RuntimePermissionRuleConfig,
|
||||||
sandbox: SandboxConfig,
|
sandbox: SandboxConfig,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
pub struct RuntimeHookConfig {
|
||||||
|
pre_tool_use: Vec<String>,
|
||||||
|
post_tool_use: Vec<String>,
|
||||||
|
post_tool_use_failure: Vec<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
pub struct RuntimePermissionRuleConfig {
|
||||||
|
allow: Vec<String>,
|
||||||
|
deny: Vec<String>,
|
||||||
|
ask: Vec<String>,
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
pub struct McpConfigCollection {
|
pub struct McpConfigCollection {
|
||||||
servers: BTreeMap<String, ScopedMcpServerConfig>,
|
servers: BTreeMap<String, ScopedMcpServerConfig>,
|
||||||
@@ -167,13 +193,15 @@ impl ConfigLoader {
|
|||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn default_for(cwd: impl Into<PathBuf>) -> Self {
|
pub fn default_for(cwd: impl Into<PathBuf>) -> Self {
|
||||||
let cwd = cwd.into();
|
let cwd = cwd.into();
|
||||||
let config_home = std::env::var_os("CLAUDE_CONFIG_HOME")
|
let config_home = default_config_home();
|
||||||
.map(PathBuf::from)
|
|
||||||
.or_else(|| std::env::var_os("HOME").map(|home| PathBuf::from(home).join(".claude")))
|
|
||||||
.unwrap_or_else(|| PathBuf::from(".claude"));
|
|
||||||
Self { cwd, config_home }
|
Self { cwd, config_home }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn config_home(&self) -> &Path {
|
||||||
|
&self.config_home
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn discover(&self) -> Vec<ConfigEntry> {
|
pub fn discover(&self) -> Vec<ConfigEntry> {
|
||||||
let user_legacy_path = self.config_home.parent().map_or_else(
|
let user_legacy_path = self.config_home.parent().map_or_else(
|
||||||
@@ -221,12 +249,15 @@ impl ConfigLoader {
|
|||||||
let merged_value = JsonValue::Object(merged.clone());
|
let merged_value = JsonValue::Object(merged.clone());
|
||||||
|
|
||||||
let feature_config = RuntimeFeatureConfig {
|
let feature_config = RuntimeFeatureConfig {
|
||||||
|
hooks: parse_optional_hooks_config(&merged_value)?,
|
||||||
|
plugins: parse_optional_plugin_config(&merged_value)?,
|
||||||
mcp: McpConfigCollection {
|
mcp: McpConfigCollection {
|
||||||
servers: mcp_servers,
|
servers: mcp_servers,
|
||||||
},
|
},
|
||||||
oauth: parse_optional_oauth_config(&merged_value, "merged settings.oauth")?,
|
oauth: parse_optional_oauth_config(&merged_value, "merged settings.oauth")?,
|
||||||
model: parse_optional_model(&merged_value),
|
model: parse_optional_model(&merged_value),
|
||||||
permission_mode: parse_optional_permission_mode(&merged_value)?,
|
permission_mode: parse_optional_permission_mode(&merged_value)?,
|
||||||
|
permission_rules: parse_optional_permission_rules(&merged_value)?,
|
||||||
sandbox: parse_optional_sandbox_config(&merged_value)?,
|
sandbox: parse_optional_sandbox_config(&merged_value)?,
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -278,6 +309,16 @@ impl RuntimeConfig {
|
|||||||
&self.feature_config.mcp
|
&self.feature_config.mcp
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn hooks(&self) -> &RuntimeHookConfig {
|
||||||
|
&self.feature_config.hooks
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn plugins(&self) -> &RuntimePluginConfig {
|
||||||
|
&self.feature_config.plugins
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn oauth(&self) -> Option<&OAuthConfig> {
|
pub fn oauth(&self) -> Option<&OAuthConfig> {
|
||||||
self.feature_config.oauth.as_ref()
|
self.feature_config.oauth.as_ref()
|
||||||
@@ -293,6 +334,11 @@ impl RuntimeConfig {
|
|||||||
self.feature_config.permission_mode
|
self.feature_config.permission_mode
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_rules(&self) -> &RuntimePermissionRuleConfig {
|
||||||
|
&self.feature_config.permission_rules
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn sandbox(&self) -> &SandboxConfig {
|
pub fn sandbox(&self) -> &SandboxConfig {
|
||||||
&self.feature_config.sandbox
|
&self.feature_config.sandbox
|
||||||
@@ -300,6 +346,28 @@ impl RuntimeConfig {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl RuntimeFeatureConfig {
|
impl RuntimeFeatureConfig {
|
||||||
|
#[must_use]
|
||||||
|
pub fn with_hooks(mut self, hooks: RuntimeHookConfig) -> Self {
|
||||||
|
self.hooks = hooks;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn with_plugins(mut self, plugins: RuntimePluginConfig) -> Self {
|
||||||
|
self.plugins = plugins;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn hooks(&self) -> &RuntimeHookConfig {
|
||||||
|
&self.hooks
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn plugins(&self) -> &RuntimePluginConfig {
|
||||||
|
&self.plugins
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn mcp(&self) -> &McpConfigCollection {
|
pub fn mcp(&self) -> &McpConfigCollection {
|
||||||
&self.mcp
|
&self.mcp
|
||||||
@@ -320,12 +388,132 @@ impl RuntimeFeatureConfig {
|
|||||||
self.permission_mode
|
self.permission_mode
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_rules(&self) -> &RuntimePermissionRuleConfig {
|
||||||
|
&self.permission_rules
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn sandbox(&self) -> &SandboxConfig {
|
pub fn sandbox(&self) -> &SandboxConfig {
|
||||||
&self.sandbox
|
&self.sandbox
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl RuntimePluginConfig {
|
||||||
|
#[must_use]
|
||||||
|
pub fn enabled_plugins(&self) -> &BTreeMap<String, bool> {
|
||||||
|
&self.enabled_plugins
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn external_directories(&self) -> &[String] {
|
||||||
|
&self.external_directories
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn install_root(&self) -> Option<&str> {
|
||||||
|
self.install_root.as_deref()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn registry_path(&self) -> Option<&str> {
|
||||||
|
self.registry_path.as_deref()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn bundled_root(&self) -> Option<&str> {
|
||||||
|
self.bundled_root.as_deref()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn set_plugin_state(&mut self, plugin_id: String, enabled: bool) {
|
||||||
|
self.enabled_plugins.insert(plugin_id, enabled);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn state_for(&self, plugin_id: &str, default_enabled: bool) -> bool {
|
||||||
|
self.enabled_plugins
|
||||||
|
.get(plugin_id)
|
||||||
|
.copied()
|
||||||
|
.unwrap_or(default_enabled)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn default_config_home() -> PathBuf {
|
||||||
|
std::env::var_os("CLAUDE_CONFIG_HOME")
|
||||||
|
.map(PathBuf::from)
|
||||||
|
.or_else(|| std::env::var_os("HOME").map(|home| PathBuf::from(home).join(".claude")))
|
||||||
|
.unwrap_or_else(|| PathBuf::from(".claude"))
|
||||||
|
}
|
||||||
|
|
||||||
|
impl RuntimeHookConfig {
|
||||||
|
#[must_use]
|
||||||
|
pub fn new(
|
||||||
|
pre_tool_use: Vec<String>,
|
||||||
|
post_tool_use: Vec<String>,
|
||||||
|
post_tool_use_failure: Vec<String>,
|
||||||
|
) -> Self {
|
||||||
|
Self {
|
||||||
|
pre_tool_use,
|
||||||
|
post_tool_use,
|
||||||
|
post_tool_use_failure,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn pre_tool_use(&self) -> &[String] {
|
||||||
|
&self.pre_tool_use
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn post_tool_use(&self) -> &[String] {
|
||||||
|
&self.post_tool_use
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn post_tool_use_failure(&self) -> &[String] {
|
||||||
|
&self.post_tool_use_failure
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn merged(&self, other: &Self) -> Self {
|
||||||
|
let mut merged = self.clone();
|
||||||
|
merged.extend(other);
|
||||||
|
merged
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn extend(&mut self, other: &Self) {
|
||||||
|
extend_unique(&mut self.pre_tool_use, other.pre_tool_use());
|
||||||
|
extend_unique(&mut self.post_tool_use, other.post_tool_use());
|
||||||
|
extend_unique(
|
||||||
|
&mut self.post_tool_use_failure,
|
||||||
|
other.post_tool_use_failure(),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl RuntimePermissionRuleConfig {
|
||||||
|
#[must_use]
|
||||||
|
pub fn new(allow: Vec<String>, deny: Vec<String>, ask: Vec<String>) -> Self {
|
||||||
|
Self { allow, deny, ask }
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn allow(&self) -> &[String] {
|
||||||
|
&self.allow
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn deny(&self) -> &[String] {
|
||||||
|
&self.deny
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn ask(&self) -> &[String] {
|
||||||
|
&self.ask
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
impl McpConfigCollection {
|
impl McpConfigCollection {
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn servers(&self) -> &BTreeMap<String, ScopedMcpServerConfig> {
|
pub fn servers(&self) -> &BTreeMap<String, ScopedMcpServerConfig> {
|
||||||
@@ -424,6 +612,78 @@ fn parse_optional_model(root: &JsonValue) -> Option<String> {
|
|||||||
.map(ToOwned::to_owned)
|
.map(ToOwned::to_owned)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn parse_optional_hooks_config(root: &JsonValue) -> Result<RuntimeHookConfig, ConfigError> {
|
||||||
|
let Some(object) = root.as_object() else {
|
||||||
|
return Ok(RuntimeHookConfig::default());
|
||||||
|
};
|
||||||
|
let Some(hooks_value) = object.get("hooks") else {
|
||||||
|
return Ok(RuntimeHookConfig::default());
|
||||||
|
};
|
||||||
|
let hooks = expect_object(hooks_value, "merged settings.hooks")?;
|
||||||
|
Ok(RuntimeHookConfig {
|
||||||
|
pre_tool_use: optional_string_array(hooks, "PreToolUse", "merged settings.hooks")?
|
||||||
|
.unwrap_or_default(),
|
||||||
|
post_tool_use: optional_string_array(hooks, "PostToolUse", "merged settings.hooks")?
|
||||||
|
.unwrap_or_default(),
|
||||||
|
post_tool_use_failure: optional_string_array(
|
||||||
|
hooks,
|
||||||
|
"PostToolUseFailure",
|
||||||
|
"merged settings.hooks",
|
||||||
|
)?
|
||||||
|
.unwrap_or_default(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_optional_permission_rules(
|
||||||
|
root: &JsonValue,
|
||||||
|
) -> Result<RuntimePermissionRuleConfig, ConfigError> {
|
||||||
|
let Some(object) = root.as_object() else {
|
||||||
|
return Ok(RuntimePermissionRuleConfig::default());
|
||||||
|
};
|
||||||
|
let Some(permissions) = object.get("permissions").and_then(JsonValue::as_object) else {
|
||||||
|
return Ok(RuntimePermissionRuleConfig::default());
|
||||||
|
};
|
||||||
|
|
||||||
|
Ok(RuntimePermissionRuleConfig {
|
||||||
|
allow: optional_string_array(permissions, "allow", "merged settings.permissions")?
|
||||||
|
.unwrap_or_default(),
|
||||||
|
deny: optional_string_array(permissions, "deny", "merged settings.permissions")?
|
||||||
|
.unwrap_or_default(),
|
||||||
|
ask: optional_string_array(permissions, "ask", "merged settings.permissions")?
|
||||||
|
.unwrap_or_default(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_optional_plugin_config(root: &JsonValue) -> Result<RuntimePluginConfig, ConfigError> {
|
||||||
|
let Some(object) = root.as_object() else {
|
||||||
|
return Ok(RuntimePluginConfig::default());
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut config = RuntimePluginConfig::default();
|
||||||
|
if let Some(enabled_plugins) = object.get("enabledPlugins") {
|
||||||
|
config.enabled_plugins = parse_bool_map(enabled_plugins, "merged settings.enabledPlugins")?;
|
||||||
|
}
|
||||||
|
|
||||||
|
let Some(plugins_value) = object.get("plugins") else {
|
||||||
|
return Ok(config);
|
||||||
|
};
|
||||||
|
let plugins = expect_object(plugins_value, "merged settings.plugins")?;
|
||||||
|
|
||||||
|
if let Some(enabled_value) = plugins.get("enabled") {
|
||||||
|
config.enabled_plugins = parse_bool_map(enabled_value, "merged settings.plugins.enabled")?;
|
||||||
|
}
|
||||||
|
config.external_directories =
|
||||||
|
optional_string_array(plugins, "externalDirectories", "merged settings.plugins")?
|
||||||
|
.unwrap_or_default();
|
||||||
|
config.install_root =
|
||||||
|
optional_string(plugins, "installRoot", "merged settings.plugins")?.map(str::to_string);
|
||||||
|
config.registry_path =
|
||||||
|
optional_string(plugins, "registryPath", "merged settings.plugins")?.map(str::to_string);
|
||||||
|
config.bundled_root =
|
||||||
|
optional_string(plugins, "bundledRoot", "merged settings.plugins")?.map(str::to_string);
|
||||||
|
Ok(config)
|
||||||
|
}
|
||||||
|
|
||||||
fn parse_optional_permission_mode(
|
fn parse_optional_permission_mode(
|
||||||
root: &JsonValue,
|
root: &JsonValue,
|
||||||
) -> Result<Option<ResolvedPermissionMode>, ConfigError> {
|
) -> Result<Option<ResolvedPermissionMode>, ConfigError> {
|
||||||
@@ -656,6 +916,24 @@ fn optional_u16(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn parse_bool_map(value: &JsonValue, context: &str) -> Result<BTreeMap<String, bool>, ConfigError> {
|
||||||
|
let Some(map) = value.as_object() else {
|
||||||
|
return Err(ConfigError::Parse(format!(
|
||||||
|
"{context}: expected JSON object"
|
||||||
|
)));
|
||||||
|
};
|
||||||
|
map.iter()
|
||||||
|
.map(|(key, value)| {
|
||||||
|
value
|
||||||
|
.as_bool()
|
||||||
|
.map(|enabled| (key.clone(), enabled))
|
||||||
|
.ok_or_else(|| {
|
||||||
|
ConfigError::Parse(format!("{context}: field {key} must be a boolean"))
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.collect()
|
||||||
|
}
|
||||||
|
|
||||||
fn optional_string_array(
|
fn optional_string_array(
|
||||||
object: &BTreeMap<String, JsonValue>,
|
object: &BTreeMap<String, JsonValue>,
|
||||||
key: &str,
|
key: &str,
|
||||||
@@ -730,6 +1008,18 @@ fn deep_merge_objects(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn extend_unique(target: &mut Vec<String>, values: &[String]) {
|
||||||
|
for value in values {
|
||||||
|
push_unique(target, value.clone());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn push_unique(target: &mut Vec<String>, value: String) {
|
||||||
|
if !target.iter().any(|existing| existing == &value) {
|
||||||
|
target.push(value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::{
|
use super::{
|
||||||
@@ -783,7 +1073,7 @@ mod tests {
|
|||||||
.expect("write user compat config");
|
.expect("write user compat config");
|
||||||
fs::write(
|
fs::write(
|
||||||
home.join("settings.json"),
|
home.join("settings.json"),
|
||||||
r#"{"model":"sonnet","env":{"A2":"1"},"hooks":{"PreToolUse":["base"]},"permissions":{"defaultMode":"plan"}}"#,
|
r#"{"model":"sonnet","env":{"A2":"1"},"hooks":{"PreToolUse":["base"]},"permissions":{"defaultMode":"plan","allow":["Read"],"deny":["Bash(rm -rf)"]}}"#,
|
||||||
)
|
)
|
||||||
.expect("write user settings");
|
.expect("write user settings");
|
||||||
fs::write(
|
fs::write(
|
||||||
@@ -793,7 +1083,7 @@ mod tests {
|
|||||||
.expect("write project compat config");
|
.expect("write project compat config");
|
||||||
fs::write(
|
fs::write(
|
||||||
cwd.join(".claude").join("settings.json"),
|
cwd.join(".claude").join("settings.json"),
|
||||||
r#"{"env":{"C":"3"},"hooks":{"PostToolUse":["project"]},"mcpServers":{"project":{"command":"uvx","args":["project"]}}}"#,
|
r#"{"env":{"C":"3"},"hooks":{"PostToolUse":["project"],"PostToolUseFailure":["project-failure"]},"permissions":{"ask":["Edit"]},"mcpServers":{"project":{"command":"uvx","args":["project"]}}}"#,
|
||||||
)
|
)
|
||||||
.expect("write project settings");
|
.expect("write project settings");
|
||||||
fs::write(
|
fs::write(
|
||||||
@@ -836,6 +1126,18 @@ mod tests {
|
|||||||
.and_then(JsonValue::as_object)
|
.and_then(JsonValue::as_object)
|
||||||
.expect("hooks object")
|
.expect("hooks object")
|
||||||
.contains_key("PostToolUse"));
|
.contains_key("PostToolUse"));
|
||||||
|
assert_eq!(loaded.hooks().pre_tool_use(), &["base".to_string()]);
|
||||||
|
assert_eq!(loaded.hooks().post_tool_use(), &["project".to_string()]);
|
||||||
|
assert_eq!(
|
||||||
|
loaded.hooks().post_tool_use_failure(),
|
||||||
|
&["project-failure".to_string()]
|
||||||
|
);
|
||||||
|
assert_eq!(loaded.permission_rules().allow(), &["Read".to_string()]);
|
||||||
|
assert_eq!(
|
||||||
|
loaded.permission_rules().deny(),
|
||||||
|
&["Bash(rm -rf)".to_string()]
|
||||||
|
);
|
||||||
|
assert_eq!(loaded.permission_rules().ask(), &["Edit".to_string()]);
|
||||||
assert!(loaded.mcp().get("home").is_some());
|
assert!(loaded.mcp().get("home").is_some());
|
||||||
assert!(loaded.mcp().get("project").is_some());
|
assert!(loaded.mcp().get("project").is_some());
|
||||||
|
|
||||||
@@ -971,6 +1273,96 @@ mod tests {
|
|||||||
fs::remove_dir_all(root).expect("cleanup temp dir");
|
fs::remove_dir_all(root).expect("cleanup temp dir");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn parses_plugin_config_from_enabled_plugins() {
|
||||||
|
let root = temp_dir();
|
||||||
|
let cwd = root.join("project");
|
||||||
|
let home = root.join("home").join(".claude");
|
||||||
|
fs::create_dir_all(cwd.join(".claude")).expect("project config dir");
|
||||||
|
fs::create_dir_all(&home).expect("home config dir");
|
||||||
|
|
||||||
|
fs::write(
|
||||||
|
home.join("settings.json"),
|
||||||
|
r#"{
|
||||||
|
"enabledPlugins": {
|
||||||
|
"tool-guard@builtin": true,
|
||||||
|
"sample-plugin@external": false
|
||||||
|
}
|
||||||
|
}"#,
|
||||||
|
)
|
||||||
|
.expect("write user settings");
|
||||||
|
|
||||||
|
let loaded = ConfigLoader::new(&cwd, &home)
|
||||||
|
.load()
|
||||||
|
.expect("config should load");
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
loaded.plugins().enabled_plugins().get("tool-guard@builtin"),
|
||||||
|
Some(&true)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
loaded
|
||||||
|
.plugins()
|
||||||
|
.enabled_plugins()
|
||||||
|
.get("sample-plugin@external"),
|
||||||
|
Some(&false)
|
||||||
|
);
|
||||||
|
|
||||||
|
fs::remove_dir_all(root).expect("cleanup temp dir");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn parses_plugin_config() {
|
||||||
|
let root = temp_dir();
|
||||||
|
let cwd = root.join("project");
|
||||||
|
let home = root.join("home").join(".claude");
|
||||||
|
fs::create_dir_all(cwd.join(".claude")).expect("project config dir");
|
||||||
|
fs::create_dir_all(&home).expect("home config dir");
|
||||||
|
|
||||||
|
fs::write(
|
||||||
|
home.join("settings.json"),
|
||||||
|
r#"{
|
||||||
|
"enabledPlugins": {
|
||||||
|
"core-helpers@builtin": true
|
||||||
|
},
|
||||||
|
"plugins": {
|
||||||
|
"externalDirectories": ["./external-plugins"],
|
||||||
|
"installRoot": "plugin-cache/installed",
|
||||||
|
"registryPath": "plugin-cache/installed.json",
|
||||||
|
"bundledRoot": "./bundled-plugins"
|
||||||
|
}
|
||||||
|
}"#,
|
||||||
|
)
|
||||||
|
.expect("write plugin settings");
|
||||||
|
|
||||||
|
let loaded = ConfigLoader::new(&cwd, &home)
|
||||||
|
.load()
|
||||||
|
.expect("config should load");
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
loaded
|
||||||
|
.plugins()
|
||||||
|
.enabled_plugins()
|
||||||
|
.get("core-helpers@builtin"),
|
||||||
|
Some(&true)
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
loaded.plugins().external_directories(),
|
||||||
|
&["./external-plugins".to_string()]
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
loaded.plugins().install_root(),
|
||||||
|
Some("plugin-cache/installed")
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
loaded.plugins().registry_path(),
|
||||||
|
Some("plugin-cache/installed.json")
|
||||||
|
);
|
||||||
|
assert_eq!(loaded.plugins().bundled_root(), Some("./bundled-plugins"));
|
||||||
|
|
||||||
|
fs::remove_dir_all(root).expect("cleanup temp dir");
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn rejects_invalid_mcp_server_shapes() {
|
fn rejects_invalid_mcp_server_shapes() {
|
||||||
let root = temp_dir();
|
let root = temp_dir();
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
858
rust/crates/runtime/src/hooks.rs
Normal file
858
rust/crates/runtime/src/hooks.rs
Normal file
@@ -0,0 +1,858 @@
|
|||||||
|
use std::ffi::OsStr;
|
||||||
|
use std::io::Write;
|
||||||
|
use std::path::Path;
|
||||||
|
use std::process::{Command, Stdio};
|
||||||
|
use std::sync::{
|
||||||
|
atomic::{AtomicBool, Ordering},
|
||||||
|
Arc,
|
||||||
|
};
|
||||||
|
use std::thread;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use serde_json::{json, Value};
|
||||||
|
|
||||||
|
use crate::config::{RuntimeFeatureConfig, RuntimeHookConfig};
|
||||||
|
use crate::permissions::PermissionOverride;
|
||||||
|
|
||||||
|
pub type HookPermissionDecision = PermissionOverride;
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
|
pub enum HookEvent {
|
||||||
|
PreToolUse,
|
||||||
|
PostToolUse,
|
||||||
|
PostToolUseFailure,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookEvent {
|
||||||
|
#[must_use]
|
||||||
|
pub fn as_str(self) -> &'static str {
|
||||||
|
match self {
|
||||||
|
Self::PreToolUse => "PreToolUse",
|
||||||
|
Self::PostToolUse => "PostToolUse",
|
||||||
|
Self::PostToolUseFailure => "PostToolUseFailure",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub enum HookProgressEvent {
|
||||||
|
Started {
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: String,
|
||||||
|
command: String,
|
||||||
|
},
|
||||||
|
Completed {
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: String,
|
||||||
|
command: String,
|
||||||
|
},
|
||||||
|
Cancelled {
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: String,
|
||||||
|
command: String,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
pub trait HookProgressReporter {
|
||||||
|
fn on_event(&mut self, event: &HookProgressEvent);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Default)]
|
||||||
|
pub struct HookAbortSignal {
|
||||||
|
aborted: Arc<AtomicBool>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookAbortSignal {
|
||||||
|
#[must_use]
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self::default()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn abort(&self) {
|
||||||
|
self.aborted.store(true, Ordering::SeqCst);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn is_aborted(&self) -> bool {
|
||||||
|
self.aborted.load(Ordering::SeqCst)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct HookRunResult {
|
||||||
|
denied: bool,
|
||||||
|
cancelled: bool,
|
||||||
|
messages: Vec<String>,
|
||||||
|
permission_override: Option<PermissionOverride>,
|
||||||
|
permission_reason: Option<String>,
|
||||||
|
updated_input: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookRunResult {
|
||||||
|
#[must_use]
|
||||||
|
pub fn allow(messages: Vec<String>) -> Self {
|
||||||
|
Self {
|
||||||
|
denied: false,
|
||||||
|
cancelled: false,
|
||||||
|
messages,
|
||||||
|
permission_override: None,
|
||||||
|
permission_reason: None,
|
||||||
|
updated_input: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn is_denied(&self) -> bool {
|
||||||
|
self.denied
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn is_cancelled(&self) -> bool {
|
||||||
|
self.cancelled
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn messages(&self) -> &[String] {
|
||||||
|
&self.messages
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_override(&self) -> Option<PermissionOverride> {
|
||||||
|
self.permission_override
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_decision(&self) -> Option<HookPermissionDecision> {
|
||||||
|
self.permission_override
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_reason(&self) -> Option<&str> {
|
||||||
|
self.permission_reason.as_deref()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn updated_input(&self) -> Option<&str> {
|
||||||
|
self.updated_input.as_deref()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn updated_input_json(&self) -> Option<&str> {
|
||||||
|
self.updated_input()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
pub struct HookRunner {
|
||||||
|
config: RuntimeHookConfig,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookRunner {
|
||||||
|
#[must_use]
|
||||||
|
pub fn new(config: RuntimeHookConfig) -> Self {
|
||||||
|
Self { config }
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn from_feature_config(feature_config: &RuntimeFeatureConfig) -> Self {
|
||||||
|
Self::new(feature_config.hooks().clone())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_pre_tool_use(&self, tool_name: &str, tool_input: &str) -> HookRunResult {
|
||||||
|
self.run_pre_tool_use_with_context(tool_name, tool_input, None, None)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_pre_tool_use_with_context(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
reporter: Option<&mut dyn HookProgressReporter>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
Self::run_commands(
|
||||||
|
HookEvent::PreToolUse,
|
||||||
|
self.config.pre_tool_use(),
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
None,
|
||||||
|
false,
|
||||||
|
abort_signal,
|
||||||
|
reporter,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_pre_tool_use_with_signal(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_pre_tool_use_with_context(tool_name, tool_input, abort_signal, None)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: &str,
|
||||||
|
is_error: bool,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_post_tool_use_with_context(
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
tool_output,
|
||||||
|
is_error,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_with_context(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: &str,
|
||||||
|
is_error: bool,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
reporter: Option<&mut dyn HookProgressReporter>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
Self::run_commands(
|
||||||
|
HookEvent::PostToolUse,
|
||||||
|
self.config.post_tool_use(),
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
Some(tool_output),
|
||||||
|
is_error,
|
||||||
|
abort_signal,
|
||||||
|
reporter,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_with_signal(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: &str,
|
||||||
|
is_error: bool,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_post_tool_use_with_context(
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
tool_output,
|
||||||
|
is_error,
|
||||||
|
abort_signal,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_failure(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_error: &str,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_post_tool_use_failure_with_context(tool_name, tool_input, tool_error, None, None)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_failure_with_context(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_error: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
reporter: Option<&mut dyn HookProgressReporter>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
Self::run_commands(
|
||||||
|
HookEvent::PostToolUseFailure,
|
||||||
|
self.config.post_tool_use_failure(),
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
Some(tool_error),
|
||||||
|
true,
|
||||||
|
abort_signal,
|
||||||
|
reporter,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn run_post_tool_use_failure_with_signal(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_error: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
self.run_post_tool_use_failure_with_context(
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
tool_error,
|
||||||
|
abort_signal,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_arguments)]
|
||||||
|
fn run_commands(
|
||||||
|
event: HookEvent,
|
||||||
|
commands: &[String],
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: Option<&str>,
|
||||||
|
is_error: bool,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
mut reporter: Option<&mut dyn HookProgressReporter>,
|
||||||
|
) -> HookRunResult {
|
||||||
|
if commands.is_empty() {
|
||||||
|
return HookRunResult::allow(Vec::new());
|
||||||
|
}
|
||||||
|
|
||||||
|
if abort_signal.is_some_and(HookAbortSignal::is_aborted) {
|
||||||
|
return HookRunResult {
|
||||||
|
denied: false,
|
||||||
|
cancelled: true,
|
||||||
|
messages: vec![format!(
|
||||||
|
"{} hook cancelled before execution",
|
||||||
|
event.as_str()
|
||||||
|
)],
|
||||||
|
permission_override: None,
|
||||||
|
permission_reason: None,
|
||||||
|
updated_input: None,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
let payload = hook_payload(event, tool_name, tool_input, tool_output, is_error).to_string();
|
||||||
|
let mut result = HookRunResult::allow(Vec::new());
|
||||||
|
|
||||||
|
for command in commands {
|
||||||
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
|
reporter.on_event(&HookProgressEvent::Started {
|
||||||
|
event,
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
command: command.clone(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
match Self::run_command(
|
||||||
|
command,
|
||||||
|
event,
|
||||||
|
tool_name,
|
||||||
|
tool_input,
|
||||||
|
tool_output,
|
||||||
|
is_error,
|
||||||
|
&payload,
|
||||||
|
abort_signal,
|
||||||
|
) {
|
||||||
|
HookCommandOutcome::Allow { parsed } => {
|
||||||
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
|
reporter.on_event(&HookProgressEvent::Completed {
|
||||||
|
event,
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
command: command.clone(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
merge_parsed_hook_output(&mut result, parsed);
|
||||||
|
}
|
||||||
|
HookCommandOutcome::Deny { parsed } => {
|
||||||
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
|
reporter.on_event(&HookProgressEvent::Completed {
|
||||||
|
event,
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
command: command.clone(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
merge_parsed_hook_output(&mut result, parsed);
|
||||||
|
result.denied = true;
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
HookCommandOutcome::Warn { message } => {
|
||||||
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
|
reporter.on_event(&HookProgressEvent::Completed {
|
||||||
|
event,
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
command: command.clone(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
result.messages.push(message);
|
||||||
|
}
|
||||||
|
HookCommandOutcome::Cancelled { message } => {
|
||||||
|
if let Some(reporter) = reporter.as_deref_mut() {
|
||||||
|
reporter.on_event(&HookProgressEvent::Cancelled {
|
||||||
|
event,
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
command: command.clone(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
result.cancelled = true;
|
||||||
|
result.messages.push(message);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
result
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_arguments)]
|
||||||
|
fn run_command(
|
||||||
|
command: &str,
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: Option<&str>,
|
||||||
|
is_error: bool,
|
||||||
|
payload: &str,
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
) -> HookCommandOutcome {
|
||||||
|
let mut child = shell_command(command);
|
||||||
|
child.stdin(Stdio::piped());
|
||||||
|
child.stdout(Stdio::piped());
|
||||||
|
child.stderr(Stdio::piped());
|
||||||
|
child.env("HOOK_EVENT", event.as_str());
|
||||||
|
child.env("HOOK_TOOL_NAME", tool_name);
|
||||||
|
child.env("HOOK_TOOL_INPUT", tool_input);
|
||||||
|
child.env("HOOK_TOOL_IS_ERROR", if is_error { "1" } else { "0" });
|
||||||
|
if let Some(tool_output) = tool_output {
|
||||||
|
child.env("HOOK_TOOL_OUTPUT", tool_output);
|
||||||
|
}
|
||||||
|
|
||||||
|
match child.output_with_stdin(payload.as_bytes(), abort_signal) {
|
||||||
|
Ok(CommandExecution::Finished(output)) => {
|
||||||
|
let stdout = String::from_utf8_lossy(&output.stdout).trim().to_string();
|
||||||
|
let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
|
||||||
|
let parsed = parse_hook_output(&stdout);
|
||||||
|
match output.status.code() {
|
||||||
|
Some(0) => {
|
||||||
|
if parsed.deny {
|
||||||
|
HookCommandOutcome::Deny { parsed }
|
||||||
|
} else {
|
||||||
|
HookCommandOutcome::Allow { parsed }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Some(2) => HookCommandOutcome::Deny {
|
||||||
|
parsed: parsed.with_fallback_message(format!(
|
||||||
|
"{} hook denied tool `{tool_name}`",
|
||||||
|
event.as_str()
|
||||||
|
)),
|
||||||
|
},
|
||||||
|
Some(code) => HookCommandOutcome::Warn {
|
||||||
|
message: format_hook_warning(
|
||||||
|
command,
|
||||||
|
code,
|
||||||
|
parsed.primary_message(),
|
||||||
|
stderr.as_str(),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
None => HookCommandOutcome::Warn {
|
||||||
|
message: format!(
|
||||||
|
"{} hook `{command}` terminated by signal while handling `{tool_name}`",
|
||||||
|
event.as_str()
|
||||||
|
),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(CommandExecution::Cancelled) => HookCommandOutcome::Cancelled {
|
||||||
|
message: format!(
|
||||||
|
"{} hook `{command}` cancelled while handling `{tool_name}`",
|
||||||
|
event.as_str()
|
||||||
|
),
|
||||||
|
},
|
||||||
|
Err(error) => HookCommandOutcome::Warn {
|
||||||
|
message: format!(
|
||||||
|
"{} hook `{command}` failed to start for `{tool_name}`: {error}",
|
||||||
|
event.as_str()
|
||||||
|
),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
enum HookCommandOutcome {
|
||||||
|
Allow { parsed: ParsedHookOutput },
|
||||||
|
Deny { parsed: ParsedHookOutput },
|
||||||
|
Warn { message: String },
|
||||||
|
Cancelled { message: String },
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
struct ParsedHookOutput {
|
||||||
|
messages: Vec<String>,
|
||||||
|
deny: bool,
|
||||||
|
permission_override: Option<PermissionOverride>,
|
||||||
|
permission_reason: Option<String>,
|
||||||
|
updated_input: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ParsedHookOutput {
|
||||||
|
fn with_fallback_message(mut self, fallback: String) -> Self {
|
||||||
|
if self.messages.is_empty() {
|
||||||
|
self.messages.push(fallback);
|
||||||
|
}
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn primary_message(&self) -> Option<&str> {
|
||||||
|
self.messages.first().map(String::as_str)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn merge_parsed_hook_output(target: &mut HookRunResult, parsed: ParsedHookOutput) {
|
||||||
|
target.messages.extend(parsed.messages);
|
||||||
|
if parsed.permission_override.is_some() {
|
||||||
|
target.permission_override = parsed.permission_override;
|
||||||
|
}
|
||||||
|
if parsed.permission_reason.is_some() {
|
||||||
|
target.permission_reason = parsed.permission_reason;
|
||||||
|
}
|
||||||
|
if parsed.updated_input.is_some() {
|
||||||
|
target.updated_input = parsed.updated_input;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_hook_output(stdout: &str) -> ParsedHookOutput {
|
||||||
|
if stdout.is_empty() {
|
||||||
|
return ParsedHookOutput::default();
|
||||||
|
}
|
||||||
|
|
||||||
|
let Ok(Value::Object(root)) = serde_json::from_str::<Value>(stdout) else {
|
||||||
|
return ParsedHookOutput {
|
||||||
|
messages: vec![stdout.to_string()],
|
||||||
|
..ParsedHookOutput::default()
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut parsed = ParsedHookOutput::default();
|
||||||
|
|
||||||
|
if let Some(message) = root.get("systemMessage").and_then(Value::as_str) {
|
||||||
|
parsed.messages.push(message.to_string());
|
||||||
|
}
|
||||||
|
if let Some(message) = root.get("reason").and_then(Value::as_str) {
|
||||||
|
parsed.messages.push(message.to_string());
|
||||||
|
}
|
||||||
|
if root.get("continue").and_then(Value::as_bool) == Some(false)
|
||||||
|
|| root.get("decision").and_then(Value::as_str) == Some("block")
|
||||||
|
{
|
||||||
|
parsed.deny = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(Value::Object(specific)) = root.get("hookSpecificOutput") {
|
||||||
|
if let Some(Value::String(additional_context)) = specific.get("additionalContext") {
|
||||||
|
parsed.messages.push(additional_context.clone());
|
||||||
|
}
|
||||||
|
if let Some(decision) = specific.get("permissionDecision").and_then(Value::as_str) {
|
||||||
|
parsed.permission_override = match decision {
|
||||||
|
"allow" => Some(PermissionOverride::Allow),
|
||||||
|
"deny" => Some(PermissionOverride::Deny),
|
||||||
|
"ask" => Some(PermissionOverride::Ask),
|
||||||
|
_ => None,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if let Some(reason) = specific
|
||||||
|
.get("permissionDecisionReason")
|
||||||
|
.and_then(Value::as_str)
|
||||||
|
{
|
||||||
|
parsed.permission_reason = Some(reason.to_string());
|
||||||
|
}
|
||||||
|
if let Some(updated_input) = specific.get("updatedInput") {
|
||||||
|
parsed.updated_input = serde_json::to_string(updated_input).ok();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if parsed.messages.is_empty() {
|
||||||
|
parsed.messages.push(stdout.to_string());
|
||||||
|
}
|
||||||
|
|
||||||
|
parsed
|
||||||
|
}
|
||||||
|
|
||||||
|
fn hook_payload(
|
||||||
|
event: HookEvent,
|
||||||
|
tool_name: &str,
|
||||||
|
tool_input: &str,
|
||||||
|
tool_output: Option<&str>,
|
||||||
|
is_error: bool,
|
||||||
|
) -> Value {
|
||||||
|
match event {
|
||||||
|
HookEvent::PostToolUseFailure => json!({
|
||||||
|
"hook_event_name": event.as_str(),
|
||||||
|
"tool_name": tool_name,
|
||||||
|
"tool_input": parse_tool_input(tool_input),
|
||||||
|
"tool_input_json": tool_input,
|
||||||
|
"tool_error": tool_output,
|
||||||
|
"tool_result_is_error": true,
|
||||||
|
}),
|
||||||
|
_ => json!({
|
||||||
|
"hook_event_name": event.as_str(),
|
||||||
|
"tool_name": tool_name,
|
||||||
|
"tool_input": parse_tool_input(tool_input),
|
||||||
|
"tool_input_json": tool_input,
|
||||||
|
"tool_output": tool_output,
|
||||||
|
"tool_result_is_error": is_error,
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_tool_input(tool_input: &str) -> Value {
|
||||||
|
serde_json::from_str(tool_input).unwrap_or_else(|_| json!({ "raw": tool_input }))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn format_hook_warning(command: &str, code: i32, stdout: Option<&str>, stderr: &str) -> String {
|
||||||
|
let mut message =
|
||||||
|
format!("Hook `{command}` exited with status {code}; allowing tool execution to continue");
|
||||||
|
if let Some(stdout) = stdout.filter(|stdout| !stdout.is_empty()) {
|
||||||
|
message.push_str(": ");
|
||||||
|
message.push_str(stdout);
|
||||||
|
} else if !stderr.is_empty() {
|
||||||
|
message.push_str(": ");
|
||||||
|
message.push_str(stderr);
|
||||||
|
}
|
||||||
|
message
|
||||||
|
}
|
||||||
|
|
||||||
|
fn shell_command(command: &str) -> CommandWithStdin {
|
||||||
|
#[cfg(windows)]
|
||||||
|
let mut command_builder = {
|
||||||
|
let mut command_builder = Command::new("cmd");
|
||||||
|
command_builder.arg("/C").arg(command);
|
||||||
|
CommandWithStdin::new(command_builder)
|
||||||
|
};
|
||||||
|
|
||||||
|
#[cfg(not(windows))]
|
||||||
|
let command_builder = if Path::new(command).exists() {
|
||||||
|
let mut command_builder = Command::new("sh");
|
||||||
|
command_builder.arg(command);
|
||||||
|
CommandWithStdin::new(command_builder)
|
||||||
|
} else {
|
||||||
|
let mut command_builder = Command::new("sh");
|
||||||
|
command_builder.arg("-lc").arg(command);
|
||||||
|
CommandWithStdin::new(command_builder)
|
||||||
|
};
|
||||||
|
|
||||||
|
command_builder
|
||||||
|
}
|
||||||
|
|
||||||
|
struct CommandWithStdin {
|
||||||
|
command: Command,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CommandWithStdin {
|
||||||
|
fn new(command: Command) -> Self {
|
||||||
|
Self { command }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn stdin(&mut self, cfg: Stdio) -> &mut Self {
|
||||||
|
self.command.stdin(cfg);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn stdout(&mut self, cfg: Stdio) -> &mut Self {
|
||||||
|
self.command.stdout(cfg);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn stderr(&mut self, cfg: Stdio) -> &mut Self {
|
||||||
|
self.command.stderr(cfg);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn env<K, V>(&mut self, key: K, value: V) -> &mut Self
|
||||||
|
where
|
||||||
|
K: AsRef<OsStr>,
|
||||||
|
V: AsRef<OsStr>,
|
||||||
|
{
|
||||||
|
self.command.env(key, value);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
fn output_with_stdin(
|
||||||
|
&mut self,
|
||||||
|
stdin: &[u8],
|
||||||
|
abort_signal: Option<&HookAbortSignal>,
|
||||||
|
) -> std::io::Result<CommandExecution> {
|
||||||
|
let mut child = self.command.spawn()?;
|
||||||
|
if let Some(mut child_stdin) = child.stdin.take() {
|
||||||
|
child_stdin.write_all(stdin)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
loop {
|
||||||
|
if abort_signal.is_some_and(HookAbortSignal::is_aborted) {
|
||||||
|
let _ = child.kill();
|
||||||
|
let _ = child.wait_with_output();
|
||||||
|
return Ok(CommandExecution::Cancelled);
|
||||||
|
}
|
||||||
|
|
||||||
|
match child.try_wait()? {
|
||||||
|
Some(_) => return child.wait_with_output().map(CommandExecution::Finished),
|
||||||
|
None => thread::sleep(Duration::from_millis(20)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
enum CommandExecution {
|
||||||
|
Finished(std::process::Output),
|
||||||
|
Cancelled,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use std::thread;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use super::{
|
||||||
|
HookAbortSignal, HookEvent, HookProgressEvent, HookProgressReporter, HookRunResult,
|
||||||
|
HookRunner,
|
||||||
|
};
|
||||||
|
use crate::config::{RuntimeFeatureConfig, RuntimeHookConfig};
|
||||||
|
use crate::permissions::PermissionOverride;
|
||||||
|
|
||||||
|
struct RecordingReporter {
|
||||||
|
events: Vec<HookProgressEvent>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl HookProgressReporter for RecordingReporter {
|
||||||
|
fn on_event(&mut self, event: &HookProgressEvent) {
|
||||||
|
self.events.push(event.clone());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn allows_exit_code_zero_and_captures_stdout() {
|
||||||
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet("printf 'pre ok'")],
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
));
|
||||||
|
|
||||||
|
let result = runner.run_pre_tool_use("Read", r#"{"path":"README.md"}"#);
|
||||||
|
|
||||||
|
assert_eq!(result, HookRunResult::allow(vec!["pre ok".to_string()]));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn denies_exit_code_two() {
|
||||||
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet("printf 'blocked by hook'; exit 2")],
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
));
|
||||||
|
|
||||||
|
let result = runner.run_pre_tool_use("Bash", r#"{"command":"pwd"}"#);
|
||||||
|
|
||||||
|
assert!(result.is_denied());
|
||||||
|
assert_eq!(result.messages(), &["blocked by hook".to_string()]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn warns_for_other_non_zero_statuses() {
|
||||||
|
let runner = HookRunner::from_feature_config(&RuntimeFeatureConfig::default().with_hooks(
|
||||||
|
RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet("printf 'warning hook'; exit 1")],
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
),
|
||||||
|
));
|
||||||
|
|
||||||
|
let result = runner.run_pre_tool_use("Edit", r#"{"file":"src/lib.rs"}"#);
|
||||||
|
|
||||||
|
assert!(!result.is_denied());
|
||||||
|
assert!(result
|
||||||
|
.messages()
|
||||||
|
.iter()
|
||||||
|
.any(|message| message.contains("allowing tool execution to continue")));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn parses_pre_hook_permission_override_and_updated_input() {
|
||||||
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet(
|
||||||
|
r#"printf '%s' '{"systemMessage":"updated","hookSpecificOutput":{"permissionDecision":"allow","permissionDecisionReason":"hook ok","updatedInput":{"command":"git status"}}}'"#,
|
||||||
|
)],
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
));
|
||||||
|
|
||||||
|
let result = runner.run_pre_tool_use("bash", r#"{"command":"pwd"}"#);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
result.permission_override(),
|
||||||
|
Some(PermissionOverride::Allow)
|
||||||
|
);
|
||||||
|
assert_eq!(result.permission_reason(), Some("hook ok"));
|
||||||
|
assert_eq!(result.updated_input(), Some(r#"{"command":"git status"}"#));
|
||||||
|
assert!(result.messages().iter().any(|message| message == "updated"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn runs_post_tool_use_failure_hooks() {
|
||||||
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
vec![shell_snippet("printf 'failure hook ran'")],
|
||||||
|
));
|
||||||
|
|
||||||
|
let result =
|
||||||
|
runner.run_post_tool_use_failure("bash", r#"{"command":"false"}"#, "command failed");
|
||||||
|
|
||||||
|
assert!(!result.is_denied());
|
||||||
|
assert_eq!(result.messages(), &["failure hook ran".to_string()]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn abort_signal_cancels_long_running_hook_and_reports_progress() {
|
||||||
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet("sleep 5")],
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
));
|
||||||
|
let abort_signal = HookAbortSignal::new();
|
||||||
|
let abort_signal_for_thread = abort_signal.clone();
|
||||||
|
let mut reporter = RecordingReporter { events: Vec::new() };
|
||||||
|
|
||||||
|
thread::spawn(move || {
|
||||||
|
thread::sleep(Duration::from_millis(100));
|
||||||
|
abort_signal_for_thread.abort();
|
||||||
|
});
|
||||||
|
|
||||||
|
let result = runner.run_pre_tool_use_with_context(
|
||||||
|
"bash",
|
||||||
|
r#"{"command":"sleep 5"}"#,
|
||||||
|
Some(&abort_signal),
|
||||||
|
Some(&mut reporter),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert!(result.is_cancelled());
|
||||||
|
assert!(reporter.events.iter().any(|event| matches!(
|
||||||
|
event,
|
||||||
|
HookProgressEvent::Started {
|
||||||
|
event: HookEvent::PreToolUse,
|
||||||
|
..
|
||||||
|
}
|
||||||
|
)));
|
||||||
|
assert!(reporter.events.iter().any(|event| matches!(
|
||||||
|
event,
|
||||||
|
HookProgressEvent::Cancelled {
|
||||||
|
event: HookEvent::PreToolUse,
|
||||||
|
..
|
||||||
|
}
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(windows)]
|
||||||
|
fn shell_snippet(script: &str) -> String {
|
||||||
|
script.replace('\'', "\"")
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(not(windows))]
|
||||||
|
fn shell_snippet(script: &str) -> String {
|
||||||
|
script.to_string()
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,6 +4,7 @@ mod compact;
|
|||||||
mod config;
|
mod config;
|
||||||
mod conversation;
|
mod conversation;
|
||||||
mod file_ops;
|
mod file_ops;
|
||||||
|
mod hooks;
|
||||||
mod json;
|
mod json;
|
||||||
mod mcp;
|
mod mcp;
|
||||||
mod mcp_client;
|
mod mcp_client;
|
||||||
@@ -26,18 +27,22 @@ pub use config::{
|
|||||||
ConfigEntry, ConfigError, ConfigLoader, ConfigSource, McpClaudeAiProxyServerConfig,
|
ConfigEntry, ConfigError, ConfigLoader, ConfigSource, McpClaudeAiProxyServerConfig,
|
||||||
McpConfigCollection, McpOAuthConfig, McpRemoteServerConfig, McpSdkServerConfig,
|
McpConfigCollection, McpOAuthConfig, McpRemoteServerConfig, McpSdkServerConfig,
|
||||||
McpServerConfig, McpStdioServerConfig, McpTransport, McpWebSocketServerConfig, OAuthConfig,
|
McpServerConfig, McpStdioServerConfig, McpTransport, McpWebSocketServerConfig, OAuthConfig,
|
||||||
ResolvedPermissionMode, RuntimeConfig, RuntimeFeatureConfig, ScopedMcpServerConfig,
|
ResolvedPermissionMode, RuntimeConfig, RuntimeFeatureConfig, RuntimeHookConfig,
|
||||||
|
RuntimePermissionRuleConfig, RuntimePluginConfig, ScopedMcpServerConfig,
|
||||||
CLAUDE_CODE_SETTINGS_SCHEMA_NAME,
|
CLAUDE_CODE_SETTINGS_SCHEMA_NAME,
|
||||||
};
|
};
|
||||||
pub use conversation::{
|
pub use conversation::{
|
||||||
ApiClient, ApiRequest, AssistantEvent, ConversationRuntime, RuntimeError, StaticToolExecutor,
|
auto_compaction_threshold_from_env, ApiClient, ApiRequest, AssistantEvent, AutoCompactionEvent,
|
||||||
ToolError, ToolExecutor, TurnSummary,
|
ConversationRuntime, RuntimeError, StaticToolExecutor, ToolError, ToolExecutor, TurnSummary,
|
||||||
};
|
};
|
||||||
pub use file_ops::{
|
pub use file_ops::{
|
||||||
edit_file, glob_search, grep_search, read_file, write_file, EditFileOutput, GlobSearchOutput,
|
edit_file, glob_search, grep_search, read_file, write_file, EditFileOutput, GlobSearchOutput,
|
||||||
GrepSearchInput, GrepSearchOutput, ReadFileOutput, StructuredPatchHunk, TextFilePayload,
|
GrepSearchInput, GrepSearchOutput, ReadFileOutput, StructuredPatchHunk, TextFilePayload,
|
||||||
WriteFileOutput,
|
WriteFileOutput,
|
||||||
};
|
};
|
||||||
|
pub use hooks::{
|
||||||
|
HookAbortSignal, HookEvent, HookProgressEvent, HookProgressReporter, HookRunResult, HookRunner,
|
||||||
|
};
|
||||||
pub use mcp::{
|
pub use mcp::{
|
||||||
mcp_server_signature, mcp_tool_name, mcp_tool_prefix, normalize_name_for_mcp,
|
mcp_server_signature, mcp_tool_name, mcp_tool_prefix, normalize_name_for_mcp,
|
||||||
scoped_mcp_config_hash, unwrap_ccr_proxy_url,
|
scoped_mcp_config_hash, unwrap_ccr_proxy_url,
|
||||||
@@ -62,8 +67,8 @@ pub use oauth::{
|
|||||||
PkceChallengeMethod, PkceCodePair,
|
PkceChallengeMethod, PkceCodePair,
|
||||||
};
|
};
|
||||||
pub use permissions::{
|
pub use permissions::{
|
||||||
PermissionMode, PermissionOutcome, PermissionPolicy, PermissionPromptDecision,
|
PermissionContext, PermissionMode, PermissionOutcome, PermissionOverride, PermissionPolicy,
|
||||||
PermissionPrompter, PermissionRequest,
|
PermissionPromptDecision, PermissionPrompter, PermissionRequest,
|
||||||
};
|
};
|
||||||
pub use prompt::{
|
pub use prompt::{
|
||||||
load_system_prompt, prepend_bullets, ContextFile, ProjectContext, PromptBuildError,
|
load_system_prompt, prepend_bullets, ContextFile, ProjectContext, PromptBuildError,
|
||||||
|
|||||||
@@ -1,5 +1,9 @@
|
|||||||
use std::collections::BTreeMap;
|
use std::collections::BTreeMap;
|
||||||
|
|
||||||
|
use serde_json::Value;
|
||||||
|
|
||||||
|
use crate::config::RuntimePermissionRuleConfig;
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
|
||||||
pub enum PermissionMode {
|
pub enum PermissionMode {
|
||||||
ReadOnly,
|
ReadOnly,
|
||||||
@@ -22,12 +26,49 @@ impl PermissionMode {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
|
pub enum PermissionOverride {
|
||||||
|
Allow,
|
||||||
|
Deny,
|
||||||
|
Ask,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
pub struct PermissionContext {
|
||||||
|
override_decision: Option<PermissionOverride>,
|
||||||
|
override_reason: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl PermissionContext {
|
||||||
|
#[must_use]
|
||||||
|
pub fn new(
|
||||||
|
override_decision: Option<PermissionOverride>,
|
||||||
|
override_reason: Option<String>,
|
||||||
|
) -> Self {
|
||||||
|
Self {
|
||||||
|
override_decision,
|
||||||
|
override_reason,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn override_decision(&self) -> Option<PermissionOverride> {
|
||||||
|
self.override_decision
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn override_reason(&self) -> Option<&str> {
|
||||||
|
self.override_reason.as_deref()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
pub struct PermissionRequest {
|
pub struct PermissionRequest {
|
||||||
pub tool_name: String,
|
pub tool_name: String,
|
||||||
pub input: String,
|
pub input: String,
|
||||||
pub current_mode: PermissionMode,
|
pub current_mode: PermissionMode,
|
||||||
pub required_mode: PermissionMode,
|
pub required_mode: PermissionMode,
|
||||||
|
pub reason: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
@@ -50,6 +91,9 @@ pub enum PermissionOutcome {
|
|||||||
pub struct PermissionPolicy {
|
pub struct PermissionPolicy {
|
||||||
active_mode: PermissionMode,
|
active_mode: PermissionMode,
|
||||||
tool_requirements: BTreeMap<String, PermissionMode>,
|
tool_requirements: BTreeMap<String, PermissionMode>,
|
||||||
|
allow_rules: Vec<PermissionRule>,
|
||||||
|
deny_rules: Vec<PermissionRule>,
|
||||||
|
ask_rules: Vec<PermissionRule>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PermissionPolicy {
|
impl PermissionPolicy {
|
||||||
@@ -58,6 +102,9 @@ impl PermissionPolicy {
|
|||||||
Self {
|
Self {
|
||||||
active_mode,
|
active_mode,
|
||||||
tool_requirements: BTreeMap::new(),
|
tool_requirements: BTreeMap::new(),
|
||||||
|
allow_rules: Vec::new(),
|
||||||
|
deny_rules: Vec::new(),
|
||||||
|
ask_rules: Vec::new(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -72,6 +119,26 @@ impl PermissionPolicy {
|
|||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn with_permission_rules(mut self, config: &RuntimePermissionRuleConfig) -> Self {
|
||||||
|
self.allow_rules = config
|
||||||
|
.allow()
|
||||||
|
.iter()
|
||||||
|
.map(|rule| PermissionRule::parse(rule))
|
||||||
|
.collect();
|
||||||
|
self.deny_rules = config
|
||||||
|
.deny()
|
||||||
|
.iter()
|
||||||
|
.map(|rule| PermissionRule::parse(rule))
|
||||||
|
.collect();
|
||||||
|
self.ask_rules = config
|
||||||
|
.ask()
|
||||||
|
.iter()
|
||||||
|
.map(|rule| PermissionRule::parse(rule))
|
||||||
|
.collect();
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn active_mode(&self) -> PermissionMode {
|
pub fn active_mode(&self) -> PermissionMode {
|
||||||
self.active_mode
|
self.active_mode
|
||||||
@@ -90,38 +157,121 @@ impl PermissionPolicy {
|
|||||||
&self,
|
&self,
|
||||||
tool_name: &str,
|
tool_name: &str,
|
||||||
input: &str,
|
input: &str,
|
||||||
mut prompter: Option<&mut dyn PermissionPrompter>,
|
prompter: Option<&mut dyn PermissionPrompter>,
|
||||||
) -> PermissionOutcome {
|
) -> PermissionOutcome {
|
||||||
let current_mode = self.active_mode();
|
self.authorize_with_context(tool_name, input, &PermissionContext::default(), prompter)
|
||||||
let required_mode = self.required_mode_for(tool_name);
|
}
|
||||||
if current_mode == PermissionMode::Allow || current_mode >= required_mode {
|
|
||||||
return PermissionOutcome::Allow;
|
#[must_use]
|
||||||
|
#[allow(clippy::too_many_lines)]
|
||||||
|
pub fn authorize_with_context(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
input: &str,
|
||||||
|
context: &PermissionContext,
|
||||||
|
prompter: Option<&mut dyn PermissionPrompter>,
|
||||||
|
) -> PermissionOutcome {
|
||||||
|
if let Some(rule) = Self::find_matching_rule(&self.deny_rules, tool_name, input) {
|
||||||
|
return PermissionOutcome::Deny {
|
||||||
|
reason: format!(
|
||||||
|
"Permission to use {tool_name} has been denied by rule '{}'",
|
||||||
|
rule.raw
|
||||||
|
),
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
let request = PermissionRequest {
|
let current_mode = self.active_mode();
|
||||||
tool_name: tool_name.to_string(),
|
let required_mode = self.required_mode_for(tool_name);
|
||||||
input: input.to_string(),
|
let ask_rule = Self::find_matching_rule(&self.ask_rules, tool_name, input);
|
||||||
current_mode,
|
let allow_rule = Self::find_matching_rule(&self.allow_rules, tool_name, input);
|
||||||
required_mode,
|
|
||||||
};
|
match context.override_decision() {
|
||||||
|
Some(PermissionOverride::Deny) => {
|
||||||
|
return PermissionOutcome::Deny {
|
||||||
|
reason: context.override_reason().map_or_else(
|
||||||
|
|| format!("tool '{tool_name}' denied by hook"),
|
||||||
|
ToOwned::to_owned,
|
||||||
|
),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
Some(PermissionOverride::Ask) => {
|
||||||
|
let reason = context.override_reason().map_or_else(
|
||||||
|
|| format!("tool '{tool_name}' requires approval due to hook guidance"),
|
||||||
|
ToOwned::to_owned,
|
||||||
|
);
|
||||||
|
return Self::prompt_or_deny(
|
||||||
|
tool_name,
|
||||||
|
input,
|
||||||
|
current_mode,
|
||||||
|
required_mode,
|
||||||
|
Some(reason),
|
||||||
|
prompter,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
Some(PermissionOverride::Allow) => {
|
||||||
|
if let Some(rule) = ask_rule {
|
||||||
|
let reason = format!(
|
||||||
|
"tool '{tool_name}' requires approval due to ask rule '{}'",
|
||||||
|
rule.raw
|
||||||
|
);
|
||||||
|
return Self::prompt_or_deny(
|
||||||
|
tool_name,
|
||||||
|
input,
|
||||||
|
current_mode,
|
||||||
|
required_mode,
|
||||||
|
Some(reason),
|
||||||
|
prompter,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if allow_rule.is_some()
|
||||||
|
|| current_mode == PermissionMode::Allow
|
||||||
|
|| current_mode >= required_mode
|
||||||
|
{
|
||||||
|
return PermissionOutcome::Allow;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None => {}
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(rule) = ask_rule {
|
||||||
|
let reason = format!(
|
||||||
|
"tool '{tool_name}' requires approval due to ask rule '{}'",
|
||||||
|
rule.raw
|
||||||
|
);
|
||||||
|
return Self::prompt_or_deny(
|
||||||
|
tool_name,
|
||||||
|
input,
|
||||||
|
current_mode,
|
||||||
|
required_mode,
|
||||||
|
Some(reason),
|
||||||
|
prompter,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if allow_rule.is_some()
|
||||||
|
|| current_mode == PermissionMode::Allow
|
||||||
|
|| current_mode >= required_mode
|
||||||
|
{
|
||||||
|
return PermissionOutcome::Allow;
|
||||||
|
}
|
||||||
|
|
||||||
if current_mode == PermissionMode::Prompt
|
if current_mode == PermissionMode::Prompt
|
||||||
|| (current_mode == PermissionMode::WorkspaceWrite
|
|| (current_mode == PermissionMode::WorkspaceWrite
|
||||||
&& required_mode == PermissionMode::DangerFullAccess)
|
&& required_mode == PermissionMode::DangerFullAccess)
|
||||||
{
|
{
|
||||||
return match prompter.as_mut() {
|
let reason = Some(format!(
|
||||||
Some(prompter) => match prompter.decide(&request) {
|
"tool '{tool_name}' requires approval to escalate from {} to {}",
|
||||||
PermissionPromptDecision::Allow => PermissionOutcome::Allow,
|
current_mode.as_str(),
|
||||||
PermissionPromptDecision::Deny { reason } => PermissionOutcome::Deny { reason },
|
required_mode.as_str()
|
||||||
},
|
));
|
||||||
None => PermissionOutcome::Deny {
|
return Self::prompt_or_deny(
|
||||||
reason: format!(
|
tool_name,
|
||||||
"tool '{tool_name}' requires approval to escalate from {} to {}",
|
input,
|
||||||
current_mode.as_str(),
|
current_mode,
|
||||||
required_mode.as_str()
|
required_mode,
|
||||||
),
|
reason,
|
||||||
},
|
prompter,
|
||||||
};
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
PermissionOutcome::Deny {
|
PermissionOutcome::Deny {
|
||||||
@@ -132,14 +282,191 @@ impl PermissionPolicy {
|
|||||||
),
|
),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn prompt_or_deny(
|
||||||
|
tool_name: &str,
|
||||||
|
input: &str,
|
||||||
|
current_mode: PermissionMode,
|
||||||
|
required_mode: PermissionMode,
|
||||||
|
reason: Option<String>,
|
||||||
|
mut prompter: Option<&mut dyn PermissionPrompter>,
|
||||||
|
) -> PermissionOutcome {
|
||||||
|
let request = PermissionRequest {
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
input: input.to_string(),
|
||||||
|
current_mode,
|
||||||
|
required_mode,
|
||||||
|
reason: reason.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
match prompter.as_mut() {
|
||||||
|
Some(prompter) => match prompter.decide(&request) {
|
||||||
|
PermissionPromptDecision::Allow => PermissionOutcome::Allow,
|
||||||
|
PermissionPromptDecision::Deny { reason } => PermissionOutcome::Deny { reason },
|
||||||
|
},
|
||||||
|
None => PermissionOutcome::Deny {
|
||||||
|
reason: reason.unwrap_or_else(|| {
|
||||||
|
format!(
|
||||||
|
"tool '{tool_name}' requires approval to run while mode is {}",
|
||||||
|
current_mode.as_str()
|
||||||
|
)
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_matching_rule<'a>(
|
||||||
|
rules: &'a [PermissionRule],
|
||||||
|
tool_name: &str,
|
||||||
|
input: &str,
|
||||||
|
) -> Option<&'a PermissionRule> {
|
||||||
|
rules.iter().find(|rule| rule.matches(tool_name, input))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
struct PermissionRule {
|
||||||
|
raw: String,
|
||||||
|
tool_name: String,
|
||||||
|
matcher: PermissionRuleMatcher,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
enum PermissionRuleMatcher {
|
||||||
|
Any,
|
||||||
|
Exact(String),
|
||||||
|
Prefix(String),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl PermissionRule {
|
||||||
|
fn parse(raw: &str) -> Self {
|
||||||
|
let trimmed = raw.trim();
|
||||||
|
let open = find_first_unescaped(trimmed, '(');
|
||||||
|
let close = find_last_unescaped(trimmed, ')');
|
||||||
|
|
||||||
|
if let (Some(open), Some(close)) = (open, close) {
|
||||||
|
if close == trimmed.len() - 1 && open < close {
|
||||||
|
let tool_name = trimmed[..open].trim();
|
||||||
|
let content = &trimmed[open + 1..close];
|
||||||
|
if !tool_name.is_empty() {
|
||||||
|
let matcher = parse_rule_matcher(content);
|
||||||
|
return Self {
|
||||||
|
raw: trimmed.to_string(),
|
||||||
|
tool_name: tool_name.to_string(),
|
||||||
|
matcher,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Self {
|
||||||
|
raw: trimmed.to_string(),
|
||||||
|
tool_name: trimmed.to_string(),
|
||||||
|
matcher: PermissionRuleMatcher::Any,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn matches(&self, tool_name: &str, input: &str) -> bool {
|
||||||
|
if self.tool_name != tool_name {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
match &self.matcher {
|
||||||
|
PermissionRuleMatcher::Any => true,
|
||||||
|
PermissionRuleMatcher::Exact(expected) => {
|
||||||
|
extract_permission_subject(input).is_some_and(|candidate| candidate == *expected)
|
||||||
|
}
|
||||||
|
PermissionRuleMatcher::Prefix(prefix) => extract_permission_subject(input)
|
||||||
|
.is_some_and(|candidate| candidate.starts_with(prefix)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_rule_matcher(content: &str) -> PermissionRuleMatcher {
|
||||||
|
let unescaped = unescape_rule_content(content.trim());
|
||||||
|
if unescaped.is_empty() || unescaped == "*" {
|
||||||
|
PermissionRuleMatcher::Any
|
||||||
|
} else if let Some(prefix) = unescaped.strip_suffix(":*") {
|
||||||
|
PermissionRuleMatcher::Prefix(prefix.to_string())
|
||||||
|
} else {
|
||||||
|
PermissionRuleMatcher::Exact(unescaped)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn unescape_rule_content(content: &str) -> String {
|
||||||
|
content
|
||||||
|
.replace(r"\(", "(")
|
||||||
|
.replace(r"\)", ")")
|
||||||
|
.replace(r"\\", r"\")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_first_unescaped(value: &str, needle: char) -> Option<usize> {
|
||||||
|
let mut escaped = false;
|
||||||
|
for (idx, ch) in value.char_indices() {
|
||||||
|
if ch == '\\' {
|
||||||
|
escaped = !escaped;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if ch == needle && !escaped {
|
||||||
|
return Some(idx);
|
||||||
|
}
|
||||||
|
escaped = false;
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_last_unescaped(value: &str, needle: char) -> Option<usize> {
|
||||||
|
let chars = value.char_indices().collect::<Vec<_>>();
|
||||||
|
for (pos, (idx, ch)) in chars.iter().enumerate().rev() {
|
||||||
|
if *ch != needle {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
let mut backslashes = 0;
|
||||||
|
for (_, prev) in chars[..pos].iter().rev() {
|
||||||
|
if *prev == '\\' {
|
||||||
|
backslashes += 1;
|
||||||
|
} else {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if backslashes % 2 == 0 {
|
||||||
|
return Some(*idx);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
|
|
||||||
|
fn extract_permission_subject(input: &str) -> Option<String> {
|
||||||
|
let parsed = serde_json::from_str::<Value>(input).ok();
|
||||||
|
if let Some(Value::Object(object)) = parsed {
|
||||||
|
for key in [
|
||||||
|
"command",
|
||||||
|
"path",
|
||||||
|
"file_path",
|
||||||
|
"filePath",
|
||||||
|
"notebook_path",
|
||||||
|
"notebookPath",
|
||||||
|
"url",
|
||||||
|
"pattern",
|
||||||
|
"code",
|
||||||
|
"message",
|
||||||
|
] {
|
||||||
|
if let Some(value) = object.get(key).and_then(Value::as_str) {
|
||||||
|
return Some(value.to_string());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
(!input.trim().is_empty()).then(|| input.to_string())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::{
|
use super::{
|
||||||
PermissionMode, PermissionOutcome, PermissionPolicy, PermissionPromptDecision,
|
PermissionContext, PermissionMode, PermissionOutcome, PermissionOverride, PermissionPolicy,
|
||||||
PermissionPrompter, PermissionRequest,
|
PermissionPromptDecision, PermissionPrompter, PermissionRequest,
|
||||||
};
|
};
|
||||||
|
use crate::config::RuntimePermissionRuleConfig;
|
||||||
|
|
||||||
struct RecordingPrompter {
|
struct RecordingPrompter {
|
||||||
seen: Vec<PermissionRequest>,
|
seen: Vec<PermissionRequest>,
|
||||||
@@ -229,4 +556,120 @@ mod tests {
|
|||||||
PermissionOutcome::Deny { reason } if reason == "not now"
|
PermissionOutcome::Deny { reason } if reason == "not now"
|
||||||
));
|
));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn applies_rule_based_denials_and_allows() {
|
||||||
|
let rules = RuntimePermissionRuleConfig::new(
|
||||||
|
vec!["bash(git:*)".to_string()],
|
||||||
|
vec!["bash(rm -rf:*)".to_string()],
|
||||||
|
Vec::new(),
|
||||||
|
);
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::ReadOnly)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess)
|
||||||
|
.with_permission_rules(&rules);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
policy.authorize("bash", r#"{"command":"git status"}"#, None),
|
||||||
|
PermissionOutcome::Allow
|
||||||
|
);
|
||||||
|
assert!(matches!(
|
||||||
|
policy.authorize("bash", r#"{"command":"rm -rf /tmp/x"}"#, None),
|
||||||
|
PermissionOutcome::Deny { reason } if reason.contains("denied by rule")
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn ask_rules_force_prompt_even_when_mode_allows() {
|
||||||
|
let rules = RuntimePermissionRuleConfig::new(
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
vec!["bash(git:*)".to_string()],
|
||||||
|
);
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::DangerFullAccess)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess)
|
||||||
|
.with_permission_rules(&rules);
|
||||||
|
let mut prompter = RecordingPrompter {
|
||||||
|
seen: Vec::new(),
|
||||||
|
allow: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
let outcome = policy.authorize("bash", r#"{"command":"git status"}"#, Some(&mut prompter));
|
||||||
|
|
||||||
|
assert_eq!(outcome, PermissionOutcome::Allow);
|
||||||
|
assert_eq!(prompter.seen.len(), 1);
|
||||||
|
assert!(prompter.seen[0]
|
||||||
|
.reason
|
||||||
|
.as_deref()
|
||||||
|
.is_some_and(|reason| reason.contains("ask rule")));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn hook_allow_still_respects_ask_rules() {
|
||||||
|
let rules = RuntimePermissionRuleConfig::new(
|
||||||
|
Vec::new(),
|
||||||
|
Vec::new(),
|
||||||
|
vec!["bash(git:*)".to_string()],
|
||||||
|
);
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::ReadOnly)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess)
|
||||||
|
.with_permission_rules(&rules);
|
||||||
|
let context = PermissionContext::new(
|
||||||
|
Some(PermissionOverride::Allow),
|
||||||
|
Some("hook approved".to_string()),
|
||||||
|
);
|
||||||
|
let mut prompter = RecordingPrompter {
|
||||||
|
seen: Vec::new(),
|
||||||
|
allow: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
let outcome = policy.authorize_with_context(
|
||||||
|
"bash",
|
||||||
|
r#"{"command":"git status"}"#,
|
||||||
|
&context,
|
||||||
|
Some(&mut prompter),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_eq!(outcome, PermissionOutcome::Allow);
|
||||||
|
assert_eq!(prompter.seen.len(), 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn hook_deny_short_circuits_permission_flow() {
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::DangerFullAccess)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess);
|
||||||
|
let context = PermissionContext::new(
|
||||||
|
Some(PermissionOverride::Deny),
|
||||||
|
Some("blocked by hook".to_string()),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
policy.authorize_with_context("bash", "{}", &context, None),
|
||||||
|
PermissionOutcome::Deny {
|
||||||
|
reason: "blocked by hook".to_string(),
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn hook_ask_forces_prompt() {
|
||||||
|
let policy = PermissionPolicy::new(PermissionMode::DangerFullAccess)
|
||||||
|
.with_tool_requirement("bash", PermissionMode::DangerFullAccess);
|
||||||
|
let context = PermissionContext::new(
|
||||||
|
Some(PermissionOverride::Ask),
|
||||||
|
Some("hook requested confirmation".to_string()),
|
||||||
|
);
|
||||||
|
let mut prompter = RecordingPrompter {
|
||||||
|
seen: Vec::new(),
|
||||||
|
allow: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
let outcome = policy.authorize_with_context("bash", "{}", &context, Some(&mut prompter));
|
||||||
|
|
||||||
|
assert_eq!(outcome, PermissionOutcome::Allow);
|
||||||
|
assert_eq!(prompter.seen.len(), 1);
|
||||||
|
assert_eq!(
|
||||||
|
prompter.seen[0].reason.as_deref(),
|
||||||
|
Some("hook requested confirmation")
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -421,7 +421,7 @@ fn render_config_section(config: &RuntimeConfig) -> String {
|
|||||||
let mut lines = vec!["# Runtime config".to_string()];
|
let mut lines = vec!["# Runtime config".to_string()];
|
||||||
if config.loaded_entries().is_empty() {
|
if config.loaded_entries().is_empty() {
|
||||||
lines.extend(prepend_bullets(vec![
|
lines.extend(prepend_bullets(vec![
|
||||||
"No Claude Code settings files loaded.".to_string(),
|
"No Claw Code settings files loaded.".to_string()
|
||||||
]));
|
]));
|
||||||
return lines.join("\n");
|
return lines.join("\n");
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,9 +17,10 @@ crossterm = "0.28"
|
|||||||
pulldown-cmark = "0.13"
|
pulldown-cmark = "0.13"
|
||||||
rustyline = "15"
|
rustyline = "15"
|
||||||
runtime = { path = "../runtime" }
|
runtime = { path = "../runtime" }
|
||||||
|
plugins = { path = "../plugins" }
|
||||||
serde_json = "1"
|
serde_json = "1"
|
||||||
syntect = "5"
|
syntect = "5"
|
||||||
tokio = { version = "1", features = ["rt-multi-thread", "time"] }
|
tokio = { version = "1", features = ["rt-multi-thread", "signal", "time"] }
|
||||||
tools = { path = "../tools" }
|
tools = { path = "../tools" }
|
||||||
|
|
||||||
[lints]
|
[lints]
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ const STARTER_CLAUDE_JSON: &str = concat!(
|
|||||||
" }\n",
|
" }\n",
|
||||||
"}\n",
|
"}\n",
|
||||||
);
|
);
|
||||||
const GITIGNORE_COMMENT: &str = "# Claude Code local artifacts";
|
const GITIGNORE_COMMENT: &str = "# Claw Code local artifacts";
|
||||||
const GITIGNORE_ENTRIES: [&str; 2] = [".claude/settings.local.json", ".claude/sessions/"];
|
const GITIGNORE_ENTRIES: [&str; 2] = [".claude/settings.local.json", ".claude/sessions/"];
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
@@ -164,7 +164,7 @@ pub(crate) fn render_init_claude_md(cwd: &Path) -> String {
|
|||||||
let mut lines = vec![
|
let mut lines = vec![
|
||||||
"# CLAUDE.md".to_string(),
|
"# CLAUDE.md".to_string(),
|
||||||
String::new(),
|
String::new(),
|
||||||
"This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.".to_string(),
|
"This file provides guidance to Claw Code (clawcode.dev) when working with code in this repository.".to_string(),
|
||||||
String::new(),
|
String::new(),
|
||||||
];
|
];
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,7 +1,5 @@
|
|||||||
use std::fmt::Write as FmtWrite;
|
use std::fmt::Write as FmtWrite;
|
||||||
use std::io::{self, Write};
|
use std::io::{self, Write};
|
||||||
use std::thread;
|
|
||||||
use std::time::Duration;
|
|
||||||
|
|
||||||
use crossterm::cursor::{MoveToColumn, RestorePosition, SavePosition};
|
use crossterm::cursor::{MoveToColumn, RestorePosition, SavePosition};
|
||||||
use crossterm::style::{Color, Print, ResetColor, SetForegroundColor, Stylize};
|
use crossterm::style::{Color, Print, ResetColor, SetForegroundColor, Stylize};
|
||||||
@@ -22,6 +20,7 @@ pub struct ColorTheme {
|
|||||||
link: Color,
|
link: Color,
|
||||||
quote: Color,
|
quote: Color,
|
||||||
table_border: Color,
|
table_border: Color,
|
||||||
|
code_block_border: Color,
|
||||||
spinner_active: Color,
|
spinner_active: Color,
|
||||||
spinner_done: Color,
|
spinner_done: Color,
|
||||||
spinner_failed: Color,
|
spinner_failed: Color,
|
||||||
@@ -37,6 +36,7 @@ impl Default for ColorTheme {
|
|||||||
link: Color::Blue,
|
link: Color::Blue,
|
||||||
quote: Color::DarkGrey,
|
quote: Color::DarkGrey,
|
||||||
table_border: Color::DarkCyan,
|
table_border: Color::DarkCyan,
|
||||||
|
code_block_border: Color::DarkGrey,
|
||||||
spinner_active: Color::Blue,
|
spinner_active: Color::Blue,
|
||||||
spinner_done: Color::Green,
|
spinner_done: Color::Green,
|
||||||
spinner_failed: Color::Red,
|
spinner_failed: Color::Red,
|
||||||
@@ -154,33 +154,64 @@ impl TableState {
|
|||||||
struct RenderState {
|
struct RenderState {
|
||||||
emphasis: usize,
|
emphasis: usize,
|
||||||
strong: usize,
|
strong: usize,
|
||||||
|
heading_level: Option<u8>,
|
||||||
quote: usize,
|
quote: usize,
|
||||||
list_stack: Vec<ListKind>,
|
list_stack: Vec<ListKind>,
|
||||||
|
link_stack: Vec<LinkState>,
|
||||||
table: Option<TableState>,
|
table: Option<TableState>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
struct LinkState {
|
||||||
|
destination: String,
|
||||||
|
text: String,
|
||||||
|
}
|
||||||
|
|
||||||
impl RenderState {
|
impl RenderState {
|
||||||
fn style_text(&self, text: &str, theme: &ColorTheme) -> String {
|
fn style_text(&self, text: &str, theme: &ColorTheme) -> String {
|
||||||
let mut styled = text.to_string();
|
let mut style = text.stylize();
|
||||||
if self.strong > 0 {
|
|
||||||
styled = format!("{}", styled.bold().with(theme.strong));
|
if matches!(self.heading_level, Some(1 | 2)) || self.strong > 0 {
|
||||||
|
style = style.bold();
|
||||||
}
|
}
|
||||||
if self.emphasis > 0 {
|
if self.emphasis > 0 {
|
||||||
styled = format!("{}", styled.italic().with(theme.emphasis));
|
style = style.italic();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if let Some(level) = self.heading_level {
|
||||||
|
style = match level {
|
||||||
|
1 => style.with(theme.heading),
|
||||||
|
2 => style.white(),
|
||||||
|
3 => style.with(Color::Blue),
|
||||||
|
_ => style.with(Color::Grey),
|
||||||
|
};
|
||||||
|
} else if self.strong > 0 {
|
||||||
|
style = style.with(theme.strong);
|
||||||
|
} else if self.emphasis > 0 {
|
||||||
|
style = style.with(theme.emphasis);
|
||||||
|
}
|
||||||
|
|
||||||
if self.quote > 0 {
|
if self.quote > 0 {
|
||||||
styled = format!("{}", styled.with(theme.quote));
|
style = style.with(theme.quote);
|
||||||
}
|
}
|
||||||
styled
|
|
||||||
|
format!("{style}")
|
||||||
}
|
}
|
||||||
|
|
||||||
fn capture_target_mut<'a>(&'a mut self, output: &'a mut String) -> &'a mut String {
|
fn append_raw(&mut self, output: &mut String, text: &str) {
|
||||||
if let Some(table) = self.table.as_mut() {
|
if let Some(link) = self.link_stack.last_mut() {
|
||||||
&mut table.current_cell
|
link.text.push_str(text);
|
||||||
|
} else if let Some(table) = self.table.as_mut() {
|
||||||
|
table.current_cell.push_str(text);
|
||||||
} else {
|
} else {
|
||||||
output
|
output.push_str(text);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn append_styled(&mut self, output: &mut String, text: &str, theme: &ColorTheme) {
|
||||||
|
let styled = self.style_text(text, theme);
|
||||||
|
self.append_raw(output, &styled);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
@@ -238,6 +269,11 @@ impl TerminalRenderer {
|
|||||||
output.trim_end().to_string()
|
output.trim_end().to_string()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn markdown_to_ansi(&self, markdown: &str) -> String {
|
||||||
|
self.render_markdown(markdown)
|
||||||
|
}
|
||||||
|
|
||||||
#[allow(clippy::too_many_lines)]
|
#[allow(clippy::too_many_lines)]
|
||||||
fn render_event(
|
fn render_event(
|
||||||
&self,
|
&self,
|
||||||
@@ -249,15 +285,21 @@ impl TerminalRenderer {
|
|||||||
in_code_block: &mut bool,
|
in_code_block: &mut bool,
|
||||||
) {
|
) {
|
||||||
match event {
|
match event {
|
||||||
Event::Start(Tag::Heading { level, .. }) => self.start_heading(level as u8, output),
|
Event::Start(Tag::Heading { level, .. }) => {
|
||||||
Event::End(TagEnd::Heading(..) | TagEnd::Paragraph) => output.push_str("\n\n"),
|
Self::start_heading(state, level as u8, output);
|
||||||
|
}
|
||||||
|
Event::End(TagEnd::Paragraph) => output.push_str("\n\n"),
|
||||||
Event::Start(Tag::BlockQuote(..)) => self.start_quote(state, output),
|
Event::Start(Tag::BlockQuote(..)) => self.start_quote(state, output),
|
||||||
Event::End(TagEnd::BlockQuote(..)) => {
|
Event::End(TagEnd::BlockQuote(..)) => {
|
||||||
state.quote = state.quote.saturating_sub(1);
|
state.quote = state.quote.saturating_sub(1);
|
||||||
output.push('\n');
|
output.push('\n');
|
||||||
}
|
}
|
||||||
|
Event::End(TagEnd::Heading(..)) => {
|
||||||
|
state.heading_level = None;
|
||||||
|
output.push_str("\n\n");
|
||||||
|
}
|
||||||
Event::End(TagEnd::Item) | Event::SoftBreak | Event::HardBreak => {
|
Event::End(TagEnd::Item) | Event::SoftBreak | Event::HardBreak => {
|
||||||
state.capture_target_mut(output).push('\n');
|
state.append_raw(output, "\n");
|
||||||
}
|
}
|
||||||
Event::Start(Tag::List(first_item)) => {
|
Event::Start(Tag::List(first_item)) => {
|
||||||
let kind = match first_item {
|
let kind = match first_item {
|
||||||
@@ -293,41 +335,52 @@ impl TerminalRenderer {
|
|||||||
Event::Code(code) => {
|
Event::Code(code) => {
|
||||||
let rendered =
|
let rendered =
|
||||||
format!("{}", format!("`{code}`").with(self.color_theme.inline_code));
|
format!("{}", format!("`{code}`").with(self.color_theme.inline_code));
|
||||||
state.capture_target_mut(output).push_str(&rendered);
|
state.append_raw(output, &rendered);
|
||||||
}
|
}
|
||||||
Event::Rule => output.push_str("---\n"),
|
Event::Rule => output.push_str("---\n"),
|
||||||
Event::Text(text) => {
|
Event::Text(text) => {
|
||||||
self.push_text(text.as_ref(), state, output, code_buffer, *in_code_block);
|
self.push_text(text.as_ref(), state, output, code_buffer, *in_code_block);
|
||||||
}
|
}
|
||||||
Event::Html(html) | Event::InlineHtml(html) => {
|
Event::Html(html) | Event::InlineHtml(html) => {
|
||||||
state.capture_target_mut(output).push_str(&html);
|
state.append_raw(output, &html);
|
||||||
}
|
}
|
||||||
Event::FootnoteReference(reference) => {
|
Event::FootnoteReference(reference) => {
|
||||||
let _ = write!(state.capture_target_mut(output), "[{reference}]");
|
state.append_raw(output, &format!("[{reference}]"));
|
||||||
}
|
}
|
||||||
Event::TaskListMarker(done) => {
|
Event::TaskListMarker(done) => {
|
||||||
state
|
state.append_raw(output, if done { "[x] " } else { "[ ] " });
|
||||||
.capture_target_mut(output)
|
|
||||||
.push_str(if done { "[x] " } else { "[ ] " });
|
|
||||||
}
|
}
|
||||||
Event::InlineMath(math) | Event::DisplayMath(math) => {
|
Event::InlineMath(math) | Event::DisplayMath(math) => {
|
||||||
state.capture_target_mut(output).push_str(&math);
|
state.append_raw(output, &math);
|
||||||
}
|
}
|
||||||
Event::Start(Tag::Link { dest_url, .. }) => {
|
Event::Start(Tag::Link { dest_url, .. }) => {
|
||||||
let rendered = format!(
|
state.link_stack.push(LinkState {
|
||||||
"{}",
|
destination: dest_url.to_string(),
|
||||||
format!("[{dest_url}]")
|
text: String::new(),
|
||||||
.underlined()
|
});
|
||||||
.with(self.color_theme.link)
|
}
|
||||||
);
|
Event::End(TagEnd::Link) => {
|
||||||
state.capture_target_mut(output).push_str(&rendered);
|
if let Some(link) = state.link_stack.pop() {
|
||||||
|
let label = if link.text.is_empty() {
|
||||||
|
link.destination.clone()
|
||||||
|
} else {
|
||||||
|
link.text
|
||||||
|
};
|
||||||
|
let rendered = format!(
|
||||||
|
"{}",
|
||||||
|
format!("[{label}]({})", link.destination)
|
||||||
|
.underlined()
|
||||||
|
.with(self.color_theme.link)
|
||||||
|
);
|
||||||
|
state.append_raw(output, &rendered);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
Event::Start(Tag::Image { dest_url, .. }) => {
|
Event::Start(Tag::Image { dest_url, .. }) => {
|
||||||
let rendered = format!(
|
let rendered = format!(
|
||||||
"{}",
|
"{}",
|
||||||
format!("[image:{dest_url}]").with(self.color_theme.link)
|
format!("[image:{dest_url}]").with(self.color_theme.link)
|
||||||
);
|
);
|
||||||
state.capture_target_mut(output).push_str(&rendered);
|
state.append_raw(output, &rendered);
|
||||||
}
|
}
|
||||||
Event::Start(Tag::Table(..)) => state.table = Some(TableState::default()),
|
Event::Start(Tag::Table(..)) => state.table = Some(TableState::default()),
|
||||||
Event::End(TagEnd::Table) => {
|
Event::End(TagEnd::Table) => {
|
||||||
@@ -369,19 +422,15 @@ impl TerminalRenderer {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
Event::Start(Tag::Paragraph | Tag::MetadataBlock(..) | _)
|
Event::Start(Tag::Paragraph | Tag::MetadataBlock(..) | _)
|
||||||
| Event::End(TagEnd::Link | TagEnd::Image | TagEnd::MetadataBlock(..) | _) => {}
|
| Event::End(TagEnd::Image | TagEnd::MetadataBlock(..) | _) => {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn start_heading(&self, level: u8, output: &mut String) {
|
fn start_heading(state: &mut RenderState, level: u8, output: &mut String) {
|
||||||
output.push('\n');
|
state.heading_level = Some(level);
|
||||||
let prefix = match level {
|
if !output.is_empty() {
|
||||||
1 => "# ",
|
output.push('\n');
|
||||||
2 => "## ",
|
}
|
||||||
3 => "### ",
|
|
||||||
_ => "#### ",
|
|
||||||
};
|
|
||||||
let _ = write!(output, "{}", prefix.bold().with(self.color_theme.heading));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn start_quote(&self, state: &mut RenderState, output: &mut String) {
|
fn start_quote(&self, state: &mut RenderState, output: &mut String) {
|
||||||
@@ -405,20 +454,27 @@ impl TerminalRenderer {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn start_code_block(&self, code_language: &str, output: &mut String) {
|
fn start_code_block(&self, code_language: &str, output: &mut String) {
|
||||||
if !code_language.is_empty() {
|
let label = if code_language.is_empty() {
|
||||||
let _ = writeln!(
|
"code".to_string()
|
||||||
output,
|
} else {
|
||||||
"{}",
|
code_language.to_string()
|
||||||
format!("╭─ {code_language}").with(self.color_theme.heading)
|
};
|
||||||
);
|
let _ = writeln!(
|
||||||
}
|
output,
|
||||||
|
"{}",
|
||||||
|
format!("╭─ {label}")
|
||||||
|
.bold()
|
||||||
|
.with(self.color_theme.code_block_border)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
fn finish_code_block(&self, code_buffer: &str, code_language: &str, output: &mut String) {
|
fn finish_code_block(&self, code_buffer: &str, code_language: &str, output: &mut String) {
|
||||||
output.push_str(&self.highlight_code(code_buffer, code_language));
|
output.push_str(&self.highlight_code(code_buffer, code_language));
|
||||||
if !code_language.is_empty() {
|
let _ = write!(
|
||||||
let _ = write!(output, "{}", "╰─".with(self.color_theme.heading));
|
output,
|
||||||
}
|
"{}",
|
||||||
|
"╰─".bold().with(self.color_theme.code_block_border)
|
||||||
|
);
|
||||||
output.push_str("\n\n");
|
output.push_str("\n\n");
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -433,8 +489,7 @@ impl TerminalRenderer {
|
|||||||
if in_code_block {
|
if in_code_block {
|
||||||
code_buffer.push_str(text);
|
code_buffer.push_str(text);
|
||||||
} else {
|
} else {
|
||||||
let rendered = state.style_text(text, &self.color_theme);
|
state.append_styled(output, text, &self.color_theme);
|
||||||
state.capture_target_mut(output).push_str(&rendered);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -521,9 +576,10 @@ impl TerminalRenderer {
|
|||||||
for line in LinesWithEndings::from(code) {
|
for line in LinesWithEndings::from(code) {
|
||||||
match syntax_highlighter.highlight_line(line, &self.syntax_set) {
|
match syntax_highlighter.highlight_line(line, &self.syntax_set) {
|
||||||
Ok(ranges) => {
|
Ok(ranges) => {
|
||||||
colored_output.push_str(&as_24_bit_terminal_escaped(&ranges[..], false));
|
let escaped = as_24_bit_terminal_escaped(&ranges[..], false);
|
||||||
|
colored_output.push_str(&apply_code_block_background(&escaped));
|
||||||
}
|
}
|
||||||
Err(_) => colored_output.push_str(line),
|
Err(_) => colored_output.push_str(&apply_code_block_background(line)),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -531,16 +587,83 @@ impl TerminalRenderer {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn stream_markdown(&self, markdown: &str, out: &mut impl Write) -> io::Result<()> {
|
pub fn stream_markdown(&self, markdown: &str, out: &mut impl Write) -> io::Result<()> {
|
||||||
let rendered_markdown = self.render_markdown(markdown);
|
let rendered_markdown = self.markdown_to_ansi(markdown);
|
||||||
for chunk in rendered_markdown.split_inclusive(char::is_whitespace) {
|
write!(out, "{rendered_markdown}")?;
|
||||||
write!(out, "{chunk}")?;
|
if !rendered_markdown.ends_with('\n') {
|
||||||
out.flush()?;
|
writeln!(out)?;
|
||||||
thread::sleep(Duration::from_millis(8));
|
|
||||||
}
|
}
|
||||||
writeln!(out)
|
out.flush()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Default, Clone, PartialEq, Eq)]
|
||||||
|
pub struct MarkdownStreamState {
|
||||||
|
pending: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl MarkdownStreamState {
|
||||||
|
#[must_use]
|
||||||
|
pub fn push(&mut self, renderer: &TerminalRenderer, delta: &str) -> Option<String> {
|
||||||
|
self.pending.push_str(delta);
|
||||||
|
let split = find_stream_safe_boundary(&self.pending)?;
|
||||||
|
let ready = self.pending[..split].to_string();
|
||||||
|
self.pending.drain(..split);
|
||||||
|
Some(renderer.markdown_to_ansi(&ready))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn flush(&mut self, renderer: &TerminalRenderer) -> Option<String> {
|
||||||
|
if self.pending.trim().is_empty() {
|
||||||
|
self.pending.clear();
|
||||||
|
None
|
||||||
|
} else {
|
||||||
|
let pending = std::mem::take(&mut self.pending);
|
||||||
|
Some(renderer.markdown_to_ansi(&pending))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn apply_code_block_background(line: &str) -> String {
|
||||||
|
let trimmed = line.trim_end_matches('\n');
|
||||||
|
let trailing_newline = if trimmed.len() == line.len() {
|
||||||
|
""
|
||||||
|
} else {
|
||||||
|
"\n"
|
||||||
|
};
|
||||||
|
let with_background = trimmed.replace("\u{1b}[0m", "\u{1b}[0;48;5;236m");
|
||||||
|
format!("\u{1b}[48;5;236m{with_background}\u{1b}[0m{trailing_newline}")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_stream_safe_boundary(markdown: &str) -> Option<usize> {
|
||||||
|
let mut in_fence = false;
|
||||||
|
let mut last_boundary = None;
|
||||||
|
|
||||||
|
for (offset, line) in markdown.split_inclusive('\n').scan(0usize, |cursor, line| {
|
||||||
|
let start = *cursor;
|
||||||
|
*cursor += line.len();
|
||||||
|
Some((start, line))
|
||||||
|
}) {
|
||||||
|
let trimmed = line.trim_start();
|
||||||
|
if trimmed.starts_with("```") || trimmed.starts_with("~~~") {
|
||||||
|
in_fence = !in_fence;
|
||||||
|
if !in_fence {
|
||||||
|
last_boundary = Some(offset + line.len());
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if in_fence {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if trimmed.is_empty() {
|
||||||
|
last_boundary = Some(offset + line.len());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
last_boundary
|
||||||
|
}
|
||||||
|
|
||||||
fn visible_width(input: &str) -> usize {
|
fn visible_width(input: &str) -> usize {
|
||||||
strip_ansi(input).chars().count()
|
strip_ansi(input).chars().count()
|
||||||
}
|
}
|
||||||
@@ -569,7 +692,7 @@ fn strip_ansi(input: &str) -> String {
|
|||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::{strip_ansi, Spinner, TerminalRenderer};
|
use super::{strip_ansi, MarkdownStreamState, Spinner, TerminalRenderer};
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn renders_markdown_with_styling_and_lists() {
|
fn renders_markdown_with_styling_and_lists() {
|
||||||
@@ -583,16 +706,28 @@ mod tests {
|
|||||||
assert!(markdown_output.contains('\u{1b}'));
|
assert!(markdown_output.contains('\u{1b}'));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn renders_links_as_colored_markdown_labels() {
|
||||||
|
let terminal_renderer = TerminalRenderer::new();
|
||||||
|
let markdown_output =
|
||||||
|
terminal_renderer.render_markdown("See [Claw](https://example.com/docs) now.");
|
||||||
|
let plain_text = strip_ansi(&markdown_output);
|
||||||
|
|
||||||
|
assert!(plain_text.contains("[Claw](https://example.com/docs)"));
|
||||||
|
assert!(markdown_output.contains('\u{1b}'));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn highlights_fenced_code_blocks() {
|
fn highlights_fenced_code_blocks() {
|
||||||
let terminal_renderer = TerminalRenderer::new();
|
let terminal_renderer = TerminalRenderer::new();
|
||||||
let markdown_output =
|
let markdown_output =
|
||||||
terminal_renderer.render_markdown("```rust\nfn hi() { println!(\"hi\"); }\n```");
|
terminal_renderer.markdown_to_ansi("```rust\nfn hi() { println!(\"hi\"); }\n```");
|
||||||
let plain_text = strip_ansi(&markdown_output);
|
let plain_text = strip_ansi(&markdown_output);
|
||||||
|
|
||||||
assert!(plain_text.contains("╭─ rust"));
|
assert!(plain_text.contains("╭─ rust"));
|
||||||
assert!(plain_text.contains("fn hi"));
|
assert!(plain_text.contains("fn hi"));
|
||||||
assert!(markdown_output.contains('\u{1b}'));
|
assert!(markdown_output.contains('\u{1b}'));
|
||||||
|
assert!(markdown_output.contains("[48;5;236m"));
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -623,6 +758,26 @@ mod tests {
|
|||||||
assert!(markdown_output.contains('\u{1b}'));
|
assert!(markdown_output.contains('\u{1b}'));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn streaming_state_waits_for_complete_blocks() {
|
||||||
|
let renderer = TerminalRenderer::new();
|
||||||
|
let mut state = MarkdownStreamState::default();
|
||||||
|
|
||||||
|
assert_eq!(state.push(&renderer, "# Heading"), None);
|
||||||
|
let flushed = state
|
||||||
|
.push(&renderer, "\n\nParagraph\n\n")
|
||||||
|
.expect("completed block");
|
||||||
|
let plain_text = strip_ansi(&flushed);
|
||||||
|
assert!(plain_text.contains("Heading"));
|
||||||
|
assert!(plain_text.contains("Paragraph"));
|
||||||
|
|
||||||
|
assert_eq!(state.push(&renderer, "```rust\nfn main() {}\n"), None);
|
||||||
|
let code = state
|
||||||
|
.push(&renderer, "```\n")
|
||||||
|
.expect("closed code fence flushes");
|
||||||
|
assert!(strip_ansi(&code).contains("fn main()"));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn spinner_advances_frames() {
|
fn spinner_advances_frames() {
|
||||||
let terminal_renderer = TerminalRenderer::new();
|
let terminal_renderer = TerminalRenderer::new();
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ publish.workspace = true
|
|||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
api = { path = "../api" }
|
api = { path = "../api" }
|
||||||
|
plugins = { path = "../plugins" }
|
||||||
runtime = { path = "../runtime" }
|
runtime = { path = "../runtime" }
|
||||||
reqwest = { version = "0.12", default-features = false, features = ["blocking", "rustls-tls"] }
|
reqwest = { version = "0.12", default-features = false, features = ["blocking", "rustls-tls"] }
|
||||||
serde = { version = "1", features = ["derive"] }
|
serde = { version = "1", features = ["derive"] }
|
||||||
|
|||||||
@@ -8,12 +8,13 @@ use api::{
|
|||||||
MessageRequest, MessageResponse, OutputContentBlock, StreamEvent as ApiStreamEvent, ToolChoice,
|
MessageRequest, MessageResponse, OutputContentBlock, StreamEvent as ApiStreamEvent, ToolChoice,
|
||||||
ToolDefinition, ToolResultContentBlock,
|
ToolDefinition, ToolResultContentBlock,
|
||||||
};
|
};
|
||||||
|
use plugins::{PluginManager, PluginManagerConfig, PluginTool};
|
||||||
use reqwest::blocking::Client;
|
use reqwest::blocking::Client;
|
||||||
use runtime::{
|
use runtime::{
|
||||||
edit_file, execute_bash, glob_search, grep_search, load_system_prompt, read_file, write_file,
|
edit_file, execute_bash, glob_search, grep_search, load_system_prompt, read_file, write_file,
|
||||||
ApiClient, ApiRequest, AssistantEvent, BashCommandInput, ContentBlock, ConversationMessage,
|
ApiClient, ApiRequest, AssistantEvent, BashCommandInput, ConfigLoader, ContentBlock,
|
||||||
ConversationRuntime, GrepSearchInput, MessageRole, PermissionMode, PermissionPolicy,
|
ConversationMessage, ConversationRuntime, GrepSearchInput, MessageRole, PermissionMode,
|
||||||
RuntimeError, Session, TokenUsage, ToolError, ToolExecutor,
|
PermissionPolicy, RuntimeConfig, RuntimeError, Session, TokenUsage, ToolError, ToolExecutor,
|
||||||
};
|
};
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use serde_json::{json, Value};
|
use serde_json::{json, Value};
|
||||||
@@ -55,6 +56,239 @@ pub struct ToolSpec {
|
|||||||
pub required_permission: PermissionMode,
|
pub required_permission: PermissionMode,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq)]
|
||||||
|
pub struct RegisteredTool {
|
||||||
|
pub definition: ToolDefinition,
|
||||||
|
pub required_permission: PermissionMode,
|
||||||
|
handler: RegisteredToolHandler,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::large_enum_variant)]
|
||||||
|
#[derive(Debug, Clone, PartialEq)]
|
||||||
|
enum RegisteredToolHandler {
|
||||||
|
Builtin,
|
||||||
|
Plugin(PluginTool),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq)]
|
||||||
|
pub struct GlobalToolRegistry {
|
||||||
|
entries: Vec<RegisteredTool>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl GlobalToolRegistry {
|
||||||
|
#[must_use]
|
||||||
|
pub fn builtin() -> Self {
|
||||||
|
Self {
|
||||||
|
entries: mvp_tool_specs()
|
||||||
|
.into_iter()
|
||||||
|
.map(|spec| RegisteredTool {
|
||||||
|
definition: ToolDefinition {
|
||||||
|
name: spec.name.to_string(),
|
||||||
|
description: Some(spec.description.to_string()),
|
||||||
|
input_schema: spec.input_schema,
|
||||||
|
},
|
||||||
|
required_permission: spec.required_permission,
|
||||||
|
handler: RegisteredToolHandler::Builtin,
|
||||||
|
})
|
||||||
|
.collect(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_plugin_tools(plugin_tools: Vec<PluginTool>) -> Result<Self, String> {
|
||||||
|
let mut registry = Self::builtin();
|
||||||
|
let mut seen = registry
|
||||||
|
.entries
|
||||||
|
.iter()
|
||||||
|
.map(|entry| {
|
||||||
|
(
|
||||||
|
normalize_registry_tool_name(&entry.definition.name),
|
||||||
|
entry.definition.name.clone(),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
.collect::<BTreeMap<_, _>>();
|
||||||
|
|
||||||
|
for tool in plugin_tools {
|
||||||
|
let normalized = normalize_registry_tool_name(&tool.definition().name);
|
||||||
|
if let Some(existing) = seen.get(&normalized) {
|
||||||
|
return Err(format!(
|
||||||
|
"plugin tool `{}` from `{}` conflicts with already-registered tool `{existing}`",
|
||||||
|
tool.definition().name,
|
||||||
|
tool.plugin_id()
|
||||||
|
));
|
||||||
|
}
|
||||||
|
seen.insert(normalized, tool.definition().name.clone());
|
||||||
|
registry.entries.push(RegisteredTool {
|
||||||
|
definition: ToolDefinition {
|
||||||
|
name: tool.definition().name.clone(),
|
||||||
|
description: tool.definition().description.clone(),
|
||||||
|
input_schema: tool.definition().input_schema.clone(),
|
||||||
|
},
|
||||||
|
required_permission: permission_mode_from_plugin_tool(tool.required_permission())?,
|
||||||
|
handler: RegisteredToolHandler::Plugin(tool),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(registry)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn entries(&self) -> &[RegisteredTool] {
|
||||||
|
&self.entries
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_entry(&self, name: &str) -> Option<&RegisteredTool> {
|
||||||
|
let normalized = normalize_registry_tool_name(name);
|
||||||
|
self.entries.iter().find(|entry| {
|
||||||
|
normalize_registry_tool_name(entry.definition.name.as_str()) == normalized
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn definitions(&self, allowed_tools: Option<&BTreeSet<String>>) -> Vec<ToolDefinition> {
|
||||||
|
self.entries
|
||||||
|
.iter()
|
||||||
|
.filter(|entry| {
|
||||||
|
allowed_tools.is_none_or(|allowed| allowed.contains(entry.definition.name.as_str()))
|
||||||
|
})
|
||||||
|
.map(|entry| entry.definition.clone())
|
||||||
|
.collect()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn permission_specs(
|
||||||
|
&self,
|
||||||
|
allowed_tools: Option<&BTreeSet<String>>,
|
||||||
|
) -> Vec<(String, PermissionMode)> {
|
||||||
|
self.entries
|
||||||
|
.iter()
|
||||||
|
.filter(|entry| {
|
||||||
|
allowed_tools.is_none_or(|allowed| allowed.contains(entry.definition.name.as_str()))
|
||||||
|
})
|
||||||
|
.map(|entry| (entry.definition.name.clone(), entry.required_permission))
|
||||||
|
.collect()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn normalize_allowed_tools(
|
||||||
|
&self,
|
||||||
|
values: &[String],
|
||||||
|
) -> Result<Option<BTreeSet<String>>, String> {
|
||||||
|
if values.is_empty() {
|
||||||
|
return Ok(None);
|
||||||
|
}
|
||||||
|
|
||||||
|
let canonical_names = self
|
||||||
|
.entries
|
||||||
|
.iter()
|
||||||
|
.map(|entry| entry.definition.name.clone())
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
let mut name_map = canonical_names
|
||||||
|
.iter()
|
||||||
|
.map(|name| (normalize_registry_tool_name(name), name.clone()))
|
||||||
|
.collect::<BTreeMap<_, _>>();
|
||||||
|
|
||||||
|
for (alias, canonical) in [
|
||||||
|
("read", "read_file"),
|
||||||
|
("write", "write_file"),
|
||||||
|
("edit", "edit_file"),
|
||||||
|
("glob", "glob_search"),
|
||||||
|
("grep", "grep_search"),
|
||||||
|
] {
|
||||||
|
if canonical_names.iter().any(|name| name == canonical) {
|
||||||
|
name_map.insert(alias.to_string(), canonical.to_string());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut allowed = BTreeSet::new();
|
||||||
|
for value in values {
|
||||||
|
for token in value
|
||||||
|
.split(|ch: char| ch == ',' || ch.is_whitespace())
|
||||||
|
.filter(|token| !token.is_empty())
|
||||||
|
{
|
||||||
|
let normalized = normalize_registry_tool_name(token);
|
||||||
|
let canonical = name_map.get(&normalized).ok_or_else(|| {
|
||||||
|
format!(
|
||||||
|
"unsupported tool in --allowedTools: {token} (expected one of: {})",
|
||||||
|
canonical_names.join(", ")
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
allowed.insert(canonical.clone());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(Some(allowed))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn execute(&self, name: &str, input: &Value) -> Result<String, String> {
|
||||||
|
let entry = self
|
||||||
|
.find_entry(name)
|
||||||
|
.ok_or_else(|| format!("unsupported tool: {name}"))?;
|
||||||
|
match &entry.handler {
|
||||||
|
RegisteredToolHandler::Builtin => execute_tool(&entry.definition.name, input),
|
||||||
|
RegisteredToolHandler::Plugin(tool) => {
|
||||||
|
tool.execute(input).map_err(|error| error.to_string())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for GlobalToolRegistry {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::builtin()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn normalize_registry_tool_name(value: &str) -> String {
|
||||||
|
let trimmed = value.trim();
|
||||||
|
let chars = trimmed.chars().collect::<Vec<_>>();
|
||||||
|
let mut normalized = String::new();
|
||||||
|
|
||||||
|
for (index, ch) in chars.iter().copied().enumerate() {
|
||||||
|
if matches!(ch, '-' | ' ' | '\t' | '\n') {
|
||||||
|
if !normalized.ends_with('_') {
|
||||||
|
normalized.push('_');
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ch == '_' {
|
||||||
|
if !normalized.ends_with('_') {
|
||||||
|
normalized.push('_');
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ch.is_uppercase() {
|
||||||
|
let prev = chars.get(index.wrapping_sub(1)).copied();
|
||||||
|
let next = chars.get(index + 1).copied();
|
||||||
|
let needs_separator = index > 0
|
||||||
|
&& !normalized.ends_with('_')
|
||||||
|
&& (prev.is_some_and(|prev| prev.is_lowercase() || prev.is_ascii_digit())
|
||||||
|
|| (prev.is_some_and(char::is_uppercase)
|
||||||
|
&& next.is_some_and(char::is_lowercase)));
|
||||||
|
if needs_separator {
|
||||||
|
normalized.push('_');
|
||||||
|
}
|
||||||
|
normalized.extend(ch.to_lowercase());
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
normalized.push(ch.to_ascii_lowercase());
|
||||||
|
}
|
||||||
|
|
||||||
|
normalized.trim_matches('_').to_string()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn permission_mode_from_plugin_tool(value: &str) -> Result<PermissionMode, String> {
|
||||||
|
match value {
|
||||||
|
"read-only" => Ok(PermissionMode::ReadOnly),
|
||||||
|
"workspace-write" => Ok(PermissionMode::WorkspaceWrite),
|
||||||
|
"danger-full-access" => Ok(PermissionMode::DangerFullAccess),
|
||||||
|
other => Err(format!(
|
||||||
|
"unsupported plugin tool permission `{other}` (expected read-only, workspace-write, or danger-full-access)"
|
||||||
|
)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
#[allow(clippy::too_many_lines)]
|
#[allow(clippy::too_many_lines)]
|
||||||
pub fn mvp_tool_specs() -> Vec<ToolSpec> {
|
pub fn mvp_tool_specs() -> Vec<ToolSpec> {
|
||||||
@@ -323,7 +557,7 @@ pub fn mvp_tool_specs() -> Vec<ToolSpec> {
|
|||||||
},
|
},
|
||||||
ToolSpec {
|
ToolSpec {
|
||||||
name: "Config",
|
name: "Config",
|
||||||
description: "Get or set Claude Code settings.",
|
description: "Get or set Claw Code settings.",
|
||||||
input_schema: json!({
|
input_schema: json!({
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@@ -1280,15 +1514,7 @@ fn validate_todos(todos: &[TodoItem]) -> Result<(), String> {
|
|||||||
if todos.is_empty() {
|
if todos.is_empty() {
|
||||||
return Err(String::from("todos must not be empty"));
|
return Err(String::from("todos must not be empty"));
|
||||||
}
|
}
|
||||||
let in_progress = todos
|
// Allow multiple in_progress items for parallel workflows
|
||||||
.iter()
|
|
||||||
.filter(|todo| matches!(todo.status, TodoStatus::InProgress))
|
|
||||||
.count();
|
|
||||||
if in_progress > 1 {
|
|
||||||
return Err(String::from(
|
|
||||||
"exactly zero or one todo items may be in_progress",
|
|
||||||
));
|
|
||||||
}
|
|
||||||
if todos.iter().any(|todo| todo.content.trim().is_empty()) {
|
if todos.iter().any(|todo| todo.content.trim().is_empty()) {
|
||||||
return Err(String::from("todo content must not be empty"));
|
return Err(String::from("todo content must not be empty"));
|
||||||
}
|
}
|
||||||
@@ -1474,13 +1700,15 @@ fn build_agent_runtime(
|
|||||||
.clone()
|
.clone()
|
||||||
.unwrap_or_else(|| DEFAULT_AGENT_MODEL.to_string());
|
.unwrap_or_else(|| DEFAULT_AGENT_MODEL.to_string());
|
||||||
let allowed_tools = job.allowed_tools.clone();
|
let allowed_tools = job.allowed_tools.clone();
|
||||||
let api_client = AnthropicRuntimeClient::new(model, allowed_tools.clone())?;
|
let tool_registry = current_tool_registry()?;
|
||||||
let tool_executor = SubagentToolExecutor::new(allowed_tools);
|
let api_client =
|
||||||
|
AnthropicRuntimeClient::new(model, allowed_tools.clone(), tool_registry.clone())?;
|
||||||
|
let tool_executor = SubagentToolExecutor::new(allowed_tools, tool_registry.clone());
|
||||||
Ok(ConversationRuntime::new(
|
Ok(ConversationRuntime::new(
|
||||||
Session::new(),
|
Session::new(),
|
||||||
api_client,
|
api_client,
|
||||||
tool_executor,
|
tool_executor,
|
||||||
agent_permission_policy(),
|
agent_permission_policy(&tool_registry),
|
||||||
job.system_prompt.clone(),
|
job.system_prompt.clone(),
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
@@ -1545,7 +1773,7 @@ fn allowed_tools_for_subagent(subagent_type: &str) -> BTreeSet<String> {
|
|||||||
"SendUserMessage",
|
"SendUserMessage",
|
||||||
"PowerShell",
|
"PowerShell",
|
||||||
],
|
],
|
||||||
"claude-code-guide" => vec![
|
"claw-code-guide" => vec![
|
||||||
"read_file",
|
"read_file",
|
||||||
"glob_search",
|
"glob_search",
|
||||||
"grep_search",
|
"grep_search",
|
||||||
@@ -1589,10 +1817,12 @@ fn allowed_tools_for_subagent(subagent_type: &str) -> BTreeSet<String> {
|
|||||||
tools.into_iter().map(str::to_string).collect()
|
tools.into_iter().map(str::to_string).collect()
|
||||||
}
|
}
|
||||||
|
|
||||||
fn agent_permission_policy() -> PermissionPolicy {
|
fn agent_permission_policy(tool_registry: &GlobalToolRegistry) -> PermissionPolicy {
|
||||||
mvp_tool_specs().into_iter().fold(
|
tool_registry.permission_specs(None).into_iter().fold(
|
||||||
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
||||||
|policy, spec| policy.with_tool_requirement(spec.name, spec.required_permission),
|
|policy, (name, required_permission)| {
|
||||||
|
policy.with_tool_requirement(name, required_permission)
|
||||||
|
},
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1648,10 +1878,15 @@ struct AnthropicRuntimeClient {
|
|||||||
client: AnthropicClient,
|
client: AnthropicClient,
|
||||||
model: String,
|
model: String,
|
||||||
allowed_tools: BTreeSet<String>,
|
allowed_tools: BTreeSet<String>,
|
||||||
|
tool_registry: GlobalToolRegistry,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl AnthropicRuntimeClient {
|
impl AnthropicRuntimeClient {
|
||||||
fn new(model: String, allowed_tools: BTreeSet<String>) -> Result<Self, String> {
|
fn new(
|
||||||
|
model: String,
|
||||||
|
allowed_tools: BTreeSet<String>,
|
||||||
|
tool_registry: GlobalToolRegistry,
|
||||||
|
) -> Result<Self, String> {
|
||||||
let client = AnthropicClient::from_env()
|
let client = AnthropicClient::from_env()
|
||||||
.map_err(|error| error.to_string())?
|
.map_err(|error| error.to_string())?
|
||||||
.with_base_url(read_base_url());
|
.with_base_url(read_base_url());
|
||||||
@@ -1660,20 +1895,14 @@ impl AnthropicRuntimeClient {
|
|||||||
client,
|
client,
|
||||||
model,
|
model,
|
||||||
allowed_tools,
|
allowed_tools,
|
||||||
|
tool_registry,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl ApiClient for AnthropicRuntimeClient {
|
impl ApiClient for AnthropicRuntimeClient {
|
||||||
fn stream(&mut self, request: ApiRequest) -> Result<Vec<AssistantEvent>, RuntimeError> {
|
fn stream(&mut self, request: ApiRequest) -> Result<Vec<AssistantEvent>, RuntimeError> {
|
||||||
let tools = tool_specs_for_allowed_tools(Some(&self.allowed_tools))
|
let tools = self.tool_registry.definitions(Some(&self.allowed_tools));
|
||||||
.into_iter()
|
|
||||||
.map(|spec| ToolDefinition {
|
|
||||||
name: spec.name.to_string(),
|
|
||||||
description: Some(spec.description.to_string()),
|
|
||||||
input_schema: spec.input_schema,
|
|
||||||
})
|
|
||||||
.collect::<Vec<_>>();
|
|
||||||
let message_request = MessageRequest {
|
let message_request = MessageRequest {
|
||||||
model: self.model.clone(),
|
model: self.model.clone(),
|
||||||
max_tokens: 32_000,
|
max_tokens: 32_000,
|
||||||
@@ -1724,6 +1953,8 @@ impl ApiClient for AnthropicRuntimeClient {
|
|||||||
input.push_str(&partial_json);
|
input.push_str(&partial_json);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
ContentBlockDelta::ThinkingDelta { .. }
|
||||||
|
| ContentBlockDelta::SignatureDelta { .. } => {}
|
||||||
},
|
},
|
||||||
ApiStreamEvent::ContentBlockStop(_) => {
|
ApiStreamEvent::ContentBlockStop(_) => {
|
||||||
if let Some((id, name, input)) = pending_tool.take() {
|
if let Some((id, name, input)) = pending_tool.take() {
|
||||||
@@ -1776,32 +2007,82 @@ impl ApiClient for AnthropicRuntimeClient {
|
|||||||
|
|
||||||
struct SubagentToolExecutor {
|
struct SubagentToolExecutor {
|
||||||
allowed_tools: BTreeSet<String>,
|
allowed_tools: BTreeSet<String>,
|
||||||
|
tool_registry: GlobalToolRegistry,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl SubagentToolExecutor {
|
impl SubagentToolExecutor {
|
||||||
fn new(allowed_tools: BTreeSet<String>) -> Self {
|
fn new(allowed_tools: BTreeSet<String>, tool_registry: GlobalToolRegistry) -> Self {
|
||||||
Self { allowed_tools }
|
Self {
|
||||||
|
allowed_tools,
|
||||||
|
tool_registry,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl ToolExecutor for SubagentToolExecutor {
|
impl ToolExecutor for SubagentToolExecutor {
|
||||||
fn execute(&mut self, tool_name: &str, input: &str) -> Result<String, ToolError> {
|
fn execute(&mut self, tool_name: &str, input: &str) -> Result<String, ToolError> {
|
||||||
if !self.allowed_tools.contains(tool_name) {
|
let entry = self
|
||||||
|
.tool_registry
|
||||||
|
.find_entry(tool_name)
|
||||||
|
.ok_or_else(|| ToolError::new(format!("unsupported tool: {tool_name}")))?;
|
||||||
|
if !self.allowed_tools.contains(entry.definition.name.as_str()) {
|
||||||
return Err(ToolError::new(format!(
|
return Err(ToolError::new(format!(
|
||||||
"tool `{tool_name}` is not enabled for this sub-agent"
|
"tool `{tool_name}` is not enabled for this sub-agent"
|
||||||
)));
|
)));
|
||||||
}
|
}
|
||||||
let value = serde_json::from_str(input)
|
let value = serde_json::from_str(input)
|
||||||
.map_err(|error| ToolError::new(format!("invalid tool input JSON: {error}")))?;
|
.map_err(|error| ToolError::new(format!("invalid tool input JSON: {error}")))?;
|
||||||
execute_tool(tool_name, &value).map_err(ToolError::new)
|
self.tool_registry
|
||||||
|
.execute(tool_name, &value)
|
||||||
|
.map_err(ToolError::new)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn tool_specs_for_allowed_tools(allowed_tools: Option<&BTreeSet<String>>) -> Vec<ToolSpec> {
|
fn current_tool_registry() -> Result<GlobalToolRegistry, String> {
|
||||||
mvp_tool_specs()
|
let cwd = std::env::current_dir().map_err(|error| error.to_string())?;
|
||||||
.into_iter()
|
let loader = ConfigLoader::default_for(&cwd);
|
||||||
.filter(|spec| allowed_tools.is_none_or(|allowed| allowed.contains(spec.name)))
|
let runtime_config = loader.load().map_err(|error| error.to_string())?;
|
||||||
.collect()
|
let plugin_manager = build_plugin_manager(&cwd, &loader, &runtime_config);
|
||||||
|
let plugin_tools = plugin_manager
|
||||||
|
.aggregated_tools()
|
||||||
|
.map_err(|error| error.to_string())?;
|
||||||
|
GlobalToolRegistry::with_plugin_tools(plugin_tools)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn build_plugin_manager(
|
||||||
|
cwd: &Path,
|
||||||
|
loader: &ConfigLoader,
|
||||||
|
runtime_config: &RuntimeConfig,
|
||||||
|
) -> PluginManager {
|
||||||
|
let plugin_settings = runtime_config.plugins();
|
||||||
|
let mut plugin_config = PluginManagerConfig::new(loader.config_home().to_path_buf());
|
||||||
|
plugin_config.enabled_plugins = plugin_settings.enabled_plugins().clone();
|
||||||
|
plugin_config.external_dirs = plugin_settings
|
||||||
|
.external_directories()
|
||||||
|
.iter()
|
||||||
|
.map(|path| resolve_plugin_path(cwd, loader.config_home(), path))
|
||||||
|
.collect();
|
||||||
|
plugin_config.install_root = plugin_settings
|
||||||
|
.install_root()
|
||||||
|
.map(|path| resolve_plugin_path(cwd, loader.config_home(), path));
|
||||||
|
plugin_config.registry_path = plugin_settings
|
||||||
|
.registry_path()
|
||||||
|
.map(|path| resolve_plugin_path(cwd, loader.config_home(), path));
|
||||||
|
plugin_config.bundled_root = plugin_settings
|
||||||
|
.bundled_root()
|
||||||
|
.map(|path| resolve_plugin_path(cwd, loader.config_home(), path));
|
||||||
|
PluginManager::new(plugin_config)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn resolve_plugin_path(cwd: &Path, config_home: &Path, value: &str) -> PathBuf {
|
||||||
|
let path = PathBuf::from(value);
|
||||||
|
if path.is_absolute() {
|
||||||
|
path
|
||||||
|
} else if value.starts_with('.') {
|
||||||
|
cwd.join(path)
|
||||||
|
} else {
|
||||||
|
config_home.join(path)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn convert_messages(messages: &[ConversationMessage]) -> Vec<InputMessage> {
|
fn convert_messages(messages: &[ConversationMessage]) -> Vec<InputMessage> {
|
||||||
@@ -1868,6 +2149,7 @@ fn push_output_block(
|
|||||||
};
|
};
|
||||||
*pending_tool = Some((id, name, initial_input));
|
*pending_tool = Some((id, name, initial_input));
|
||||||
}
|
}
|
||||||
|
OutputContentBlock::Thinking { .. } | OutputContentBlock::RedactedThinking { .. } => {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2095,7 +2377,7 @@ fn normalize_subagent_type(subagent_type: Option<&str>) -> String {
|
|||||||
"verification" | "verificationagent" | "verify" | "verifier" => {
|
"verification" | "verificationagent" | "verify" | "verifier" => {
|
||||||
String::from("Verification")
|
String::from("Verification")
|
||||||
}
|
}
|
||||||
"claudecodeguide" | "claudecodeguideagent" | "guide" => String::from("claude-code-guide"),
|
"claudecodeguide" | "claudecodeguideagent" | "guide" => String::from("claw-code-guide"),
|
||||||
"statusline" | "statuslinesetup" => String::from("statusline-setup"),
|
"statusline" | "statuslinesetup" => String::from("statusline-setup"),
|
||||||
_ => trimmed.to_string(),
|
_ => trimmed.to_string(),
|
||||||
}
|
}
|
||||||
@@ -2913,9 +3195,13 @@ mod tests {
|
|||||||
use super::{
|
use super::{
|
||||||
agent_permission_policy, allowed_tools_for_subagent, execute_agent_with_spawn,
|
agent_permission_policy, allowed_tools_for_subagent, execute_agent_with_spawn,
|
||||||
execute_tool, final_assistant_text, mvp_tool_specs, persist_agent_terminal_state,
|
execute_tool, final_assistant_text, mvp_tool_specs, persist_agent_terminal_state,
|
||||||
AgentInput, AgentJob, SubagentToolExecutor,
|
response_to_events, AgentInput, AgentJob, GlobalToolRegistry, SubagentToolExecutor,
|
||||||
|
};
|
||||||
|
use api::{MessageResponse, OutputContentBlock, Usage};
|
||||||
|
use plugins::{PluginTool, PluginToolDefinition, PluginToolPermission};
|
||||||
|
use runtime::{
|
||||||
|
ApiRequest, AssistantEvent, ConversationRuntime, RuntimeError, Session, ToolExecutor,
|
||||||
};
|
};
|
||||||
use runtime::{ApiRequest, AssistantEvent, ConversationRuntime, RuntimeError, Session};
|
|
||||||
use serde_json::json;
|
use serde_json::json;
|
||||||
|
|
||||||
fn env_lock() -> &'static Mutex<()> {
|
fn env_lock() -> &'static Mutex<()> {
|
||||||
@@ -2931,6 +3217,17 @@ mod tests {
|
|||||||
std::env::temp_dir().join(format!("clawd-tools-{unique}-{name}"))
|
std::env::temp_dir().join(format!("clawd-tools-{unique}-{name}"))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn make_executable(path: &PathBuf) {
|
||||||
|
#[cfg(unix)]
|
||||||
|
{
|
||||||
|
use std::os::unix::fs::PermissionsExt;
|
||||||
|
|
||||||
|
let mut permissions = std::fs::metadata(path).expect("metadata").permissions();
|
||||||
|
permissions.set_mode(0o755);
|
||||||
|
std::fs::set_permissions(path, permissions).expect("chmod");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn exposes_mvp_tools() {
|
fn exposes_mvp_tools() {
|
||||||
let names = mvp_tool_specs()
|
let names = mvp_tool_specs()
|
||||||
@@ -2960,6 +3257,170 @@ mod tests {
|
|||||||
assert!(error.contains("unsupported tool"));
|
assert!(error.contains("unsupported tool"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn global_registry_registers_and_executes_plugin_tools() {
|
||||||
|
let script = temp_path("plugin-tool.sh");
|
||||||
|
std::fs::write(
|
||||||
|
&script,
|
||||||
|
"#!/bin/sh\nINPUT=$(cat)\nprintf '{\"plugin\":\"%s\",\"tool\":\"%s\",\"input\":%s}\\n' \"$CLAWD_PLUGIN_ID\" \"$CLAWD_TOOL_NAME\" \"$INPUT\"\n",
|
||||||
|
)
|
||||||
|
.expect("write script");
|
||||||
|
make_executable(&script);
|
||||||
|
|
||||||
|
let registry = GlobalToolRegistry::with_plugin_tools(vec![PluginTool::new(
|
||||||
|
"demo@external",
|
||||||
|
"demo",
|
||||||
|
PluginToolDefinition {
|
||||||
|
name: "plugin_echo".to_string(),
|
||||||
|
description: Some("Echo plugin input".to_string()),
|
||||||
|
input_schema: json!({
|
||||||
|
"type": "object",
|
||||||
|
"properties": { "message": { "type": "string" } },
|
||||||
|
"required": ["message"],
|
||||||
|
"additionalProperties": false
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
"sh".to_string(),
|
||||||
|
vec![script.display().to_string()],
|
||||||
|
PluginToolPermission::WorkspaceWrite,
|
||||||
|
script.parent().map(PathBuf::from),
|
||||||
|
)])
|
||||||
|
.expect("registry should build");
|
||||||
|
|
||||||
|
let names = registry
|
||||||
|
.definitions(None)
|
||||||
|
.into_iter()
|
||||||
|
.map(|definition| definition.name)
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
assert!(names.contains(&"bash".to_string()));
|
||||||
|
assert!(names.contains(&"plugin_echo".to_string()));
|
||||||
|
|
||||||
|
let output = registry
|
||||||
|
.execute("plugin_echo", &json!({ "message": "hello" }))
|
||||||
|
.expect("plugin tool should execute");
|
||||||
|
let payload: serde_json::Value = serde_json::from_str(&output).expect("valid json");
|
||||||
|
assert_eq!(payload["plugin"], "demo@external");
|
||||||
|
assert_eq!(payload["tool"], "plugin_echo");
|
||||||
|
assert_eq!(payload["input"]["message"], "hello");
|
||||||
|
|
||||||
|
let _ = std::fs::remove_file(script);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn global_registry_normalizes_plugin_tool_names_for_allowlists_and_execution() {
|
||||||
|
let script = temp_path("plugin-tool-normalized.sh");
|
||||||
|
std::fs::write(
|
||||||
|
&script,
|
||||||
|
"#!/bin/sh\nINPUT=$(cat)\nprintf '{\"tool\":\"%s\",\"input\":%s}\\n' \"$CLAWD_TOOL_NAME\" \"$INPUT\"\n",
|
||||||
|
)
|
||||||
|
.expect("write script");
|
||||||
|
make_executable(&script);
|
||||||
|
|
||||||
|
let registry = GlobalToolRegistry::with_plugin_tools(vec![PluginTool::new(
|
||||||
|
"demo@external",
|
||||||
|
"demo",
|
||||||
|
PluginToolDefinition {
|
||||||
|
name: "plugin_echo".to_string(),
|
||||||
|
description: Some("Echo plugin input".to_string()),
|
||||||
|
input_schema: json!({
|
||||||
|
"type": "object",
|
||||||
|
"properties": { "message": { "type": "string" } },
|
||||||
|
"required": ["message"],
|
||||||
|
"additionalProperties": false
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
script.display().to_string(),
|
||||||
|
Vec::new(),
|
||||||
|
PluginToolPermission::WorkspaceWrite,
|
||||||
|
script.parent().map(PathBuf::from),
|
||||||
|
)])
|
||||||
|
.expect("registry should build");
|
||||||
|
|
||||||
|
let allowed = registry
|
||||||
|
.normalize_allowed_tools(&[String::from("PLUGIN-ECHO")])
|
||||||
|
.expect("plugin tool allowlist should normalize")
|
||||||
|
.expect("allowlist should be present");
|
||||||
|
assert!(allowed.contains("plugin_echo"));
|
||||||
|
|
||||||
|
let output = registry
|
||||||
|
.execute("plugin-echo", &json!({ "message": "hello" }))
|
||||||
|
.expect("normalized plugin tool name should execute");
|
||||||
|
let payload: serde_json::Value = serde_json::from_str(&output).expect("valid json");
|
||||||
|
assert_eq!(payload["tool"], "plugin_echo");
|
||||||
|
assert_eq!(payload["input"]["message"], "hello");
|
||||||
|
|
||||||
|
let builtin_output = GlobalToolRegistry::builtin()
|
||||||
|
.execute("structured-output", &json!({ "ok": true }))
|
||||||
|
.expect("normalized builtin tool name should execute");
|
||||||
|
let builtin_payload: serde_json::Value =
|
||||||
|
serde_json::from_str(&builtin_output).expect("valid json");
|
||||||
|
assert_eq!(builtin_payload["structured_output"]["ok"], true);
|
||||||
|
|
||||||
|
let _ = std::fs::remove_file(script);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn subagent_executor_executes_allowed_plugin_tools() {
|
||||||
|
let script = temp_path("subagent-plugin-tool.sh");
|
||||||
|
std::fs::write(
|
||||||
|
&script,
|
||||||
|
"#!/bin/sh\nINPUT=$(cat)\nprintf '{\"tool\":\"%s\",\"input\":%s}\\n' \"$CLAWD_TOOL_NAME\" \"$INPUT\"\n",
|
||||||
|
)
|
||||||
|
.expect("write script");
|
||||||
|
make_executable(&script);
|
||||||
|
|
||||||
|
let registry = GlobalToolRegistry::with_plugin_tools(vec![PluginTool::new(
|
||||||
|
"demo@external",
|
||||||
|
"demo",
|
||||||
|
PluginToolDefinition {
|
||||||
|
name: "plugin_echo".to_string(),
|
||||||
|
description: Some("Echo plugin input".to_string()),
|
||||||
|
input_schema: json!({
|
||||||
|
"type": "object",
|
||||||
|
"properties": { "message": { "type": "string" } },
|
||||||
|
"required": ["message"],
|
||||||
|
"additionalProperties": false
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
script.display().to_string(),
|
||||||
|
Vec::new(),
|
||||||
|
PluginToolPermission::WorkspaceWrite,
|
||||||
|
script.parent().map(PathBuf::from),
|
||||||
|
)])
|
||||||
|
.expect("registry should build");
|
||||||
|
|
||||||
|
let mut executor =
|
||||||
|
SubagentToolExecutor::new(BTreeSet::from([String::from("plugin_echo")]), registry);
|
||||||
|
let output = executor
|
||||||
|
.execute("plugin-echo", r#"{"message":"hello"}"#)
|
||||||
|
.expect("plugin tool should execute for subagent");
|
||||||
|
let payload: serde_json::Value = serde_json::from_str(&output).expect("valid json");
|
||||||
|
assert_eq!(payload["tool"], "plugin_echo");
|
||||||
|
assert_eq!(payload["input"]["message"], "hello");
|
||||||
|
|
||||||
|
let _ = std::fs::remove_file(script);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn global_registry_rejects_conflicting_plugin_tool_names() {
|
||||||
|
let error = GlobalToolRegistry::with_plugin_tools(vec![PluginTool::new(
|
||||||
|
"demo@external",
|
||||||
|
"demo",
|
||||||
|
PluginToolDefinition {
|
||||||
|
name: "read-file".to_string(),
|
||||||
|
description: Some("Conflicts with builtin".to_string()),
|
||||||
|
input_schema: json!({ "type": "object" }),
|
||||||
|
},
|
||||||
|
"echo".to_string(),
|
||||||
|
Vec::new(),
|
||||||
|
PluginToolPermission::ReadOnly,
|
||||||
|
None,
|
||||||
|
)])
|
||||||
|
.expect_err("conflicting plugin tool should fail");
|
||||||
|
|
||||||
|
assert!(error.contains("conflicts with already-registered tool `read_file`"));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn web_fetch_returns_prompt_aware_summary() {
|
fn web_fetch_returns_prompt_aware_summary() {
|
||||||
let server = TestServer::spawn(Arc::new(|request_line: &str| {
|
let server = TestServer::spawn(Arc::new(|request_line: &str| {
|
||||||
@@ -3188,7 +3649,8 @@ mod tests {
|
|||||||
.expect_err("empty todos should fail");
|
.expect_err("empty todos should fail");
|
||||||
assert!(empty.contains("todos must not be empty"));
|
assert!(empty.contains("todos must not be empty"));
|
||||||
|
|
||||||
let too_many_active = execute_tool(
|
// Multiple in_progress items are now allowed for parallel workflows
|
||||||
|
let _multi_active = execute_tool(
|
||||||
"TodoWrite",
|
"TodoWrite",
|
||||||
&json!({
|
&json!({
|
||||||
"todos": [
|
"todos": [
|
||||||
@@ -3197,8 +3659,7 @@ mod tests {
|
|||||||
]
|
]
|
||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
.expect_err("multiple in-progress todos should fail");
|
.expect("multiple in-progress todos should succeed");
|
||||||
assert!(too_many_active.contains("zero or one todo items may be in_progress"));
|
|
||||||
|
|
||||||
let blank_content = execute_tool(
|
let blank_content = execute_tool(
|
||||||
"TodoWrite",
|
"TodoWrite",
|
||||||
@@ -3539,8 +4000,11 @@ mod tests {
|
|||||||
calls: 0,
|
calls: 0,
|
||||||
input_path: path.display().to_string(),
|
input_path: path.display().to_string(),
|
||||||
},
|
},
|
||||||
SubagentToolExecutor::new(BTreeSet::from([String::from("read_file")])),
|
SubagentToolExecutor::new(
|
||||||
agent_permission_policy(),
|
BTreeSet::from([String::from("read_file")]),
|
||||||
|
GlobalToolRegistry::builtin(),
|
||||||
|
),
|
||||||
|
agent_permission_policy(&GlobalToolRegistry::builtin()),
|
||||||
vec![String::from("system prompt")],
|
vec![String::from("system prompt")],
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -3566,6 +4030,42 @@ mod tests {
|
|||||||
let _ = std::fs::remove_file(path);
|
let _ = std::fs::remove_file(path);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn response_to_events_ignores_thinking_blocks() {
|
||||||
|
let events = response_to_events(MessageResponse {
|
||||||
|
id: "msg-1".to_string(),
|
||||||
|
kind: "message".to_string(),
|
||||||
|
model: "claude-opus-4-6".to_string(),
|
||||||
|
role: "assistant".to_string(),
|
||||||
|
content: vec![
|
||||||
|
OutputContentBlock::Thinking {
|
||||||
|
thinking: "step 1".to_string(),
|
||||||
|
signature: Some("sig_123".to_string()),
|
||||||
|
},
|
||||||
|
OutputContentBlock::Text {
|
||||||
|
text: "Final answer".to_string(),
|
||||||
|
},
|
||||||
|
],
|
||||||
|
stop_reason: Some("end_turn".to_string()),
|
||||||
|
stop_sequence: None,
|
||||||
|
usage: Usage {
|
||||||
|
input_tokens: 1,
|
||||||
|
output_tokens: 1,
|
||||||
|
cache_creation_input_tokens: 0,
|
||||||
|
cache_read_input_tokens: 0,
|
||||||
|
},
|
||||||
|
request_id: None,
|
||||||
|
});
|
||||||
|
|
||||||
|
assert!(matches!(
|
||||||
|
&events[0],
|
||||||
|
AssistantEvent::TextDelta(text) if text == "Final answer"
|
||||||
|
));
|
||||||
|
assert!(!events
|
||||||
|
.iter()
|
||||||
|
.any(|event| matches!(event, AssistantEvent::ToolUse { .. })));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn agent_rejects_blank_required_fields() {
|
fn agent_rejects_blank_required_fields() {
|
||||||
let missing_description = execute_tool(
|
let missing_description = execute_tool(
|
||||||
|
|||||||
Reference in New Issue
Block a user