Compare commits
35 Commits
rcc/parity
...
rcc/plugin
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7f33569f3a | ||
|
|
24fea5db9e | ||
|
|
782d9cea71 | ||
|
|
97d725d5e5 | ||
|
|
d794acd3f4 | ||
|
|
4c1eaa16e0 | ||
|
|
13851d800f | ||
|
|
9e717192f8 | ||
|
|
6584ed1ad7 | ||
|
|
46abf52143 | ||
|
|
28be7b3e24 | ||
|
|
a10bbaf8de | ||
|
|
f967484b9a | ||
|
|
6520cf8c3f | ||
|
|
5f66392f45 | ||
|
|
123a7f4013 | ||
|
|
0db9660727 | ||
|
|
e488e94307 | ||
|
|
f8d4da3e68 | ||
|
|
8f6d8db958 | ||
|
|
7b17b037cb | ||
|
|
b905b611f0 | ||
|
|
9ade3a70d7 | ||
|
|
91ab8ea9d9 | ||
|
|
992681c4fd | ||
|
|
77427245c1 | ||
|
|
ac6c5d00a8 | ||
|
|
a94ef61b01 | ||
|
|
a9ac7e5bb8 | ||
|
|
0175ee0a90 | ||
|
|
705c62257c | ||
|
|
1bd0eef368 | ||
|
|
ba220d210e | ||
|
|
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.
|
||||||
343
PARITY.md
343
PARITY.md
@@ -1,253 +1,214 @@
|
|||||||
# PARITY Gap Analysis
|
# PARITY GAP ANALYSIS
|
||||||
|
|
||||||
Date: 2026-04-01
|
Scope: read-only comparison between the original TypeScript source at `/home/bellman/Workspace/claude-code/src/` and the Rust port under `rust/crates/`.
|
||||||
|
|
||||||
Scope compared:
|
Method: compared feature surfaces, registries, entrypoints, and runtime plumbing only. No TypeScript source was copied.
|
||||||
- Upstream TypeScript: `/home/bellman/Workspace/claude-code/src/`
|
|
||||||
- Rust port: `rust/crates/`
|
|
||||||
|
|
||||||
Method:
|
|
||||||
- Read-only comparison only.
|
|
||||||
- No upstream source was copied into this repo.
|
|
||||||
- This is a focused feature-gap report for `tools`, `hooks`, `plugins`, `skills`, `cli`, `assistant`, and `services`.
|
|
||||||
|
|
||||||
## Executive summary
|
## Executive summary
|
||||||
|
|
||||||
The Rust port has a solid core for:
|
The Rust port has a good foundation for:
|
||||||
- basic prompt/REPL flow
|
- Anthropic API/OAuth basics
|
||||||
- session/runtime state
|
- local conversation/session state
|
||||||
- Anthropic API/OAuth plumbing
|
- a core tool loop
|
||||||
- a compact MVP tool registry
|
- MCP stdio/bootstrap support
|
||||||
- CLAUDE.md discovery
|
- CLAUDE.md discovery
|
||||||
- MCP config parsing/bootstrap primitives
|
- a small but usable built-in tool set
|
||||||
|
|
||||||
But it is still materially behind the TypeScript implementation in six major areas:
|
It is **not feature-parity** with the TypeScript CLI.
|
||||||
1. **Tools surface area** is much smaller.
|
|
||||||
2. **Hook execution** is largely missing; Rust mostly loads hook config but does not run a TS-style PreToolUse/PostToolUse pipeline.
|
|
||||||
3. **Plugins** are effectively absent in Rust.
|
|
||||||
4. **Skills** are only partially implemented in Rust via direct `SKILL.md` loading; there is no comparable skills command/discovery/registration surface.
|
|
||||||
5. **CLI** breadth is much narrower in Rust.
|
|
||||||
6. **Assistant/tool orchestration** lacks the richer streaming concurrency, hook integration, and orchestration behavior present in TS.
|
|
||||||
7. **Services** in Rust cover API/auth/runtime basics, but many higher-level TS services are missing.
|
|
||||||
|
|
||||||
## Critical bug status on this branch
|
Largest gaps:
|
||||||
|
- **plugins** are effectively absent in Rust
|
||||||
Targeted critical items requested by the user:
|
- **hooks** are parsed but not executed in Rust
|
||||||
- **Prompt mode tools enabled**: fixed in `rust/crates/rusty-claude-cli/src/main.rs:75-82`
|
- **CLI breadth** is much narrower in Rust
|
||||||
- **Default permission mode = danger-full-access**: fixed in `rust/crates/rusty-claude-cli/src/args.rs:12-16`, `rust/crates/rusty-claude-cli/src/main.rs:348-353`, and starter config `rust/crates/rusty-claude-cli/src/init.rs:4-9`
|
- **skills** are local-file only in Rust, without the TS registry/bundled pipeline
|
||||||
- **Tool input `{}` prefix bug**: fixed/guarded in streaming vs non-stream paths at `rust/crates/rusty-claude-cli/src/main.rs:2211-2256`
|
- **assistant orchestration** lacks TS hook-aware orchestration and remote/structured transports
|
||||||
- **Unlimited max_iterations**: already present at `rust/crates/runtime/src/conversation.rs:143-148` with `usize::MAX` initialization at `rust/crates/runtime/src/conversation.rs:119`
|
- **services** beyond core API/OAuth/MCP are mostly missing in Rust
|
||||||
|
|
||||||
Build/test/manual verification is tracked separately below and must pass before the branch is considered done.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 1) tools/
|
## tools/
|
||||||
|
|
||||||
### Upstream TS has
|
### TS exists
|
||||||
- Large per-tool module surface under `src/tools/`, including agent/task tools, AskUserQuestion, MCP tools, plan/worktree tools, REPL, schedule/task tools, synthetic output, brief/upload, and more.
|
Evidence:
|
||||||
- Evidence:
|
- `src/tools/` contains broad tool families including `AgentTool`, `AskUserQuestionTool`, `BashTool`, `ConfigTool`, `FileReadTool`, `FileWriteTool`, `GlobTool`, `GrepTool`, `LSPTool`, `ListMcpResourcesTool`, `MCPTool`, `McpAuthTool`, `ReadMcpResourceTool`, `RemoteTriggerTool`, `ScheduleCronTool`, `SkillTool`, `Task*`, `Team*`, `TodoWriteTool`, `ToolSearchTool`, `WebFetchTool`, `WebSearchTool`.
|
||||||
- `src/tools/AgentTool/AgentTool.tsx`
|
- Tool execution/orchestration is split across `src/services/tools/StreamingToolExecutor.ts`, `src/services/tools/toolExecution.ts`, `src/services/tools/toolHooks.ts`, and `src/services/tools/toolOrchestration.ts`.
|
||||||
- `src/tools/AskUserQuestionTool/AskUserQuestionTool.tsx`
|
|
||||||
- `src/tools/ListMcpResourcesTool/ListMcpResourcesTool.ts`
|
|
||||||
- `src/tools/ReadMcpResourceTool/ReadMcpResourceTool.ts`
|
|
||||||
- `src/tools/EnterPlanModeTool/EnterPlanModeTool.ts`
|
|
||||||
- `src/tools/ExitPlanModeTool/ExitPlanModeV2Tool.ts`
|
|
||||||
- `src/tools/EnterWorktreeTool/EnterWorktreeTool.ts`
|
|
||||||
- `src/tools/ExitWorktreeTool/ExitWorktreeTool.ts`
|
|
||||||
- `src/tools/RemoteTriggerTool/RemoteTriggerTool.ts`
|
|
||||||
- `src/tools/ScheduleCronTool/*`
|
|
||||||
- `src/tools/TaskCreateTool/*`, `TaskGetTool/*`, `TaskListTool/*`, `TaskOutputTool/*`
|
|
||||||
|
|
||||||
### Rust currently has
|
### Rust exists
|
||||||
- A single MVP registry in `rust/crates/tools/src/lib.rs:53-371`.
|
Evidence:
|
||||||
- Implemented tools include `bash`, `read_file`, `write_file`, `edit_file`, `glob_search`, `grep_search`, `WebFetch`, `WebSearch`, `TodoWrite`, `Skill`, `Agent`, `ToolSearch`, `NotebookEdit`, `Sleep`, `SendUserMessage`, `Config`, `StructuredOutput`, `REPL`, `PowerShell`.
|
- Tool registry is centralized in `rust/crates/tools/src/lib.rs` via `mvp_tool_specs()`.
|
||||||
|
- Current built-ins include shell/file/search/web/todo/skill/agent/config/notebook/repl/powershell primitives.
|
||||||
|
- Runtime execution is wired through `rust/crates/tools/src/lib.rs` and `rust/crates/runtime/src/conversation.rs`.
|
||||||
|
|
||||||
### Missing or broken in Rust
|
### Missing or broken in Rust
|
||||||
- **Missing large chunks of the upstream tool catalog**: I did not find Rust equivalents for AskUserQuestion, MCP resource listing/reading tools, plan/worktree entry/exit tools, task management tools, remote trigger, synthetic output, or schedule/cron tools.
|
- No Rust equivalents for major TS tools such as `AskUserQuestionTool`, `LSPTool`, `ListMcpResourcesTool`, `MCPTool`, `McpAuthTool`, `ReadMcpResourceTool`, `RemoteTriggerTool`, `ScheduleCronTool`, `Task*`, `Team*`, and several workflow/system tools.
|
||||||
- **Tool decomposition is much coarser**: TS isolates tool-specific validation/security/UI behavior per tool module; Rust centralizes almost everything in one file (`rust/crates/tools/src/lib.rs`).
|
- Rust tool surface is still explicitly an MVP registry, not a parity registry.
|
||||||
- **Likely parity impact**: lower fidelity tool prompting, weaker per-tool behavior specialization, and fewer native tool choices exposed to the model.
|
- Rust lacks TS’s layered tool orchestration split.
|
||||||
|
|
||||||
|
**Status:** partial core only.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 2) hooks/
|
## hooks/
|
||||||
|
|
||||||
### Upstream TS has
|
### TS exists
|
||||||
- A full permission and tool-hook system with **PermissionRequest**, **PreToolUse**, **PostToolUse**, and failure/cancellation handling.
|
Evidence:
|
||||||
- Evidence:
|
- Hook command surface under `src/commands/hooks/`.
|
||||||
- `src/hooks/toolPermission/PermissionContext.ts:25,222`
|
- Runtime hook machinery in `src/services/tools/toolHooks.ts` and `src/services/tools/toolExecution.ts`.
|
||||||
- `src/hooks/toolPermission/handlers/coordinatorHandler.ts:32-38`
|
- TS supports `PreToolUse`, `PostToolUse`, and broader hook-driven behaviors configured through settings and documented in `src/skills/bundled/updateConfig.ts`.
|
||||||
- `src/hooks/toolPermission/handlers/interactiveHandler.ts:412-429`
|
|
||||||
- `src/services/tools/toolHooks.ts:39,435`
|
|
||||||
- `src/services/tools/toolExecution.ts:800,1074,1483`
|
|
||||||
- `src/commands/hooks/index.ts:5-8`
|
|
||||||
|
|
||||||
### Rust currently has
|
### Rust exists
|
||||||
- Hook data is **loaded/merged from config** and visible in reports:
|
Evidence:
|
||||||
- `rust/crates/runtime/src/config.rs:786-797,829-838`
|
- Hook config is parsed and merged in `rust/crates/runtime/src/config.rs`.
|
||||||
- `rust/crates/rusty-claude-cli/src/main.rs:1665-1669`
|
- Hook config can be inspected via Rust config reporting in `rust/crates/commands/src/lib.rs` and `rust/crates/rusty-claude-cli/src/main.rs`.
|
||||||
- The system prompt acknowledges user-configured hooks:
|
- Prompt guidance mentions hooks in `rust/crates/runtime/src/prompt.rs`.
|
||||||
- `rust/crates/runtime/src/prompt.rs:452-459`
|
|
||||||
|
|
||||||
### Missing or broken in Rust
|
### Missing or broken in Rust
|
||||||
- **No comparable hook execution pipeline found** in the Rust runtime conversation/tool execution path.
|
- No actual hook execution pipeline in `rust/crates/runtime/src/conversation.rs`.
|
||||||
- `rust/crates/runtime/src/conversation.rs:151-208` goes straight from assistant tool_use -> permission check -> tool execute -> tool_result, without TS-style PreToolUse/PostToolUse processing.
|
- No PreToolUse/PostToolUse mutation/deny/rewrite/result-hook behavior.
|
||||||
- I did **not** find Rust counterparts to TS files like `toolHooks.ts` or `PermissionContext.ts` that execute hook callbacks and alter/block tool behavior.
|
- No Rust `/hooks` parity command.
|
||||||
- Result: Rust appears to support **hook configuration visibility**, but not full **hook behavior parity**.
|
|
||||||
|
**Status:** config-only; runtime behavior missing.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 3) plugins/
|
## plugins/
|
||||||
|
|
||||||
### Upstream TS has
|
### TS exists
|
||||||
- Built-in and bundled plugin registration plus CLI/service support for validate/list/install/uninstall/enable/disable/update flows.
|
Evidence:
|
||||||
- Evidence:
|
- Built-in plugin scaffolding in `src/plugins/builtinPlugins.ts` and `src/plugins/bundled/index.ts`.
|
||||||
- `src/plugins/builtinPlugins.ts:7-17,149-150`
|
- Plugin lifecycle/services in `src/services/plugins/PluginInstallationManager.ts` and `src/services/plugins/pluginOperations.ts`.
|
||||||
- `src/plugins/bundled/index.ts:7-22`
|
- CLI/plugin command surface under `src/commands/plugin/` and `src/commands/reload-plugins/`.
|
||||||
- `src/cli/handlers/plugins.ts:51,101,157,668`
|
|
||||||
- `src/services/plugins/pluginOperations.ts:16,54,306,435,713`
|
|
||||||
- `src/services/plugins/pluginCliCommands.ts:7,36`
|
|
||||||
|
|
||||||
### Rust currently has
|
### Rust exists
|
||||||
- I did **not** find a dedicated plugin crate/module/handler under `rust/crates/`.
|
Evidence:
|
||||||
- The Rust crate layout is only `api`, `commands`, `compat-harness`, `runtime`, `rusty-claude-cli`, and `tools`.
|
- No dedicated plugin subsystem appears under `rust/crates/`.
|
||||||
|
- Repo-wide Rust references to plugins are effectively absent beyond text/help mentions.
|
||||||
|
|
||||||
### Missing or broken in Rust
|
### Missing or broken in Rust
|
||||||
- **Plugin loading/install/update/validation is missing.**
|
- No plugin loader.
|
||||||
- **No plugin CLI surface found** comparable to `claude plugin ...`.
|
- No marketplace install/update/enable/disable flow.
|
||||||
- **No plugin runtime refresh/reconciliation layer found**.
|
- No `/plugin` or `/reload-plugins` parity.
|
||||||
- This is one of the largest parity gaps.
|
- No plugin-provided hook/tool/command/MCP extension path.
|
||||||
|
|
||||||
|
**Status:** missing.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 4) skills/
|
## skills/ and CLAUDE.md discovery
|
||||||
|
|
||||||
### Upstream TS has
|
### TS exists
|
||||||
- Bundled skills registry and loader integration, plus a `skills` command.
|
Evidence:
|
||||||
- Evidence:
|
- Skill loading/registry pipeline in `src/skills/loadSkillsDir.ts`, `src/skills/bundledSkills.ts`, and `src/skills/mcpSkillBuilders.ts`.
|
||||||
- `src/commands/skills/index.ts:6`
|
- Bundled skills under `src/skills/bundled/`.
|
||||||
- `src/skills/bundledSkills.ts:44,99,107,114`
|
- Skills command surface under `src/commands/skills/`.
|
||||||
- `src/skills/loadSkillsDir.ts:65`
|
|
||||||
- `src/skills/mcpSkillBuilders.ts:4-21,40`
|
|
||||||
|
|
||||||
### Rust currently has
|
### Rust exists
|
||||||
- A `Skill` tool that loads local `SKILL.md` files directly:
|
Evidence:
|
||||||
- `rust/crates/tools/src/lib.rs:1244-1255`
|
- `Skill` tool in `rust/crates/tools/src/lib.rs` resolves and reads local `SKILL.md` files.
|
||||||
- `rust/crates/tools/src/lib.rs:1288-1323`
|
- CLAUDE.md discovery is implemented in `rust/crates/runtime/src/prompt.rs`.
|
||||||
- CLAUDE.md / instruction discovery exists in runtime prompt loading:
|
- Rust supports `/memory` and `/init` via `rust/crates/commands/src/lib.rs` and `rust/crates/rusty-claude-cli/src/main.rs`.
|
||||||
- `rust/crates/runtime/src/prompt.rs:203-208`
|
|
||||||
|
|
||||||
### Missing or broken in Rust
|
### Missing or broken in Rust
|
||||||
- **No Rust `/skills` slash command** in `rust/crates/commands/src/lib.rs:41-166`.
|
- No bundled skill registry equivalent.
|
||||||
- **No visible bundled-skill registry equivalent** to TS `bundledSkills.ts` / `loadSkillsDir.ts` / `mcpSkillBuilders.ts`.
|
- No `/skills` command.
|
||||||
- Current Rust skill support is closer to **direct file loading** than full upstream **skill discovery/registration/command integration**.
|
- No MCP skill-builder pipeline.
|
||||||
|
- No TS-style live skill discovery/reload/change handling.
|
||||||
|
- No comparable session-memory / team-memory integration around skills.
|
||||||
|
|
||||||
|
**Status:** basic local skill loading only.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 5) cli/
|
## cli/
|
||||||
|
|
||||||
### Upstream TS has
|
### TS exists
|
||||||
- Broad CLI handler and transport surface.
|
Evidence:
|
||||||
- Evidence:
|
- Large command surface under `src/commands/` including `agents`, `hooks`, `mcp`, `memory`, `model`, `permissions`, `plan`, `plugin`, `resume`, `review`, `skills`, `tasks`, and many more.
|
||||||
- `src/cli/handlers/agents.ts:2-32`
|
- Structured/remote transport stack in `src/cli/structuredIO.ts`, `src/cli/remoteIO.ts`, and `src/cli/transports/*`.
|
||||||
- `src/cli/handlers/auth.ts`
|
- CLI handler split in `src/cli/handlers/*`.
|
||||||
- `src/cli/handlers/autoMode.ts:24,35,73`
|
|
||||||
- `src/cli/handlers/plugins.ts:2-3,101,157,668`
|
|
||||||
- `src/cli/remoteIO.ts:25-35,118-127`
|
|
||||||
- `src/cli/transports/SSETransport.ts`
|
|
||||||
- `src/cli/transports/WebSocketTransport.ts`
|
|
||||||
- `src/cli/transports/HybridTransport.ts`
|
|
||||||
- `src/cli/transports/SerialBatchEventUploader.ts`
|
|
||||||
- `src/cli/transports/WorkerStateUploader.ts`
|
|
||||||
|
|
||||||
### Rust currently has
|
### Rust exists
|
||||||
- Minimal top-level subcommands in `rust/crates/rusty-claude-cli/src/args.rs:29-39` and `rust/crates/rusty-claude-cli/src/main.rs:67-90,242-261`.
|
Evidence:
|
||||||
- Slash command surface is 15 commands total in `rust/crates/commands/src/lib.rs:41-166,389`.
|
- Shared slash command registry in `rust/crates/commands/src/lib.rs`.
|
||||||
|
- Rust slash commands currently cover `help`, `status`, `compact`, `model`, `permissions`, `clear`, `cost`, `resume`, `config`, `memory`, `init`, `diff`, `version`, `export`, `session`.
|
||||||
|
- Main CLI/repl/prompt handling lives in `rust/crates/rusty-claude-cli/src/main.rs`.
|
||||||
|
|
||||||
### Missing or broken in Rust
|
### Missing or broken in Rust
|
||||||
- **Missing major CLI subcommand families**: agents, plugins, mcp management, auto-mode tooling, and many other TS commands.
|
- Missing major TS command families: `/agents`, `/hooks`, `/mcp`, `/plugin`, `/skills`, `/plan`, `/review`, `/tasks`, and many others.
|
||||||
- **Missing remote/transport stack parity**: I did not find Rust equivalents to TS remote structured IO / SSE / websocket / CCR transport layers.
|
- No Rust equivalent to TS structured IO / remote transport layers.
|
||||||
- **Slash command breadth is much narrower** than TS command inventory under `src/commands/`.
|
- No TS-style handler decomposition for auth/plugins/MCP/agents.
|
||||||
- **Prompt-mode parity bug** was present and is now fixed for this branch’s prompt path.
|
- JSON prompt mode is improved on this branch, but still not clean transport parity: empirical verification shows tool-capable JSON output can emit human-readable tool-result lines before the final JSON object.
|
||||||
|
|
||||||
|
**Status:** functional local CLI core, much narrower than TS.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 6) assistant/
|
## assistant/ (agentic loop, streaming, tool calling)
|
||||||
|
|
||||||
### Upstream TS has
|
### TS exists
|
||||||
- Rich tool orchestration and streaming execution behavior, including concurrency/cancellation/fallback logic.
|
Evidence:
|
||||||
- Evidence:
|
- Assistant/session surface at `src/assistant/sessionHistory.ts`.
|
||||||
- `src/services/tools/StreamingToolExecutor.ts:35-214`
|
- Tool orchestration in `src/services/tools/StreamingToolExecutor.ts`, `src/services/tools/toolExecution.ts`, `src/services/tools/toolOrchestration.ts`.
|
||||||
- `src/services/tools/toolExecution.ts:455-569,800-918,1483`
|
- Remote/structured streaming layers in `src/cli/structuredIO.ts` and `src/cli/remoteIO.ts`.
|
||||||
- `src/services/tools/toolOrchestration.ts:134-167`
|
|
||||||
- `src/assistant/sessionHistory.ts`
|
|
||||||
|
|
||||||
### Rust currently has
|
### Rust exists
|
||||||
- A straightforward agentic loop in `rust/crates/runtime/src/conversation.rs:130-214`.
|
Evidence:
|
||||||
- Streaming API adaptation in `rust/crates/rusty-claude-cli/src/main.rs:1998-2058`.
|
- Core loop in `rust/crates/runtime/src/conversation.rs`.
|
||||||
- Tool-use block assembly and non-stream fallback handling in `rust/crates/rusty-claude-cli/src/main.rs:2211-2256`.
|
- Stream/tool event translation in `rust/crates/rusty-claude-cli/src/main.rs`.
|
||||||
|
- Session persistence in `rust/crates/runtime/src/session.rs`.
|
||||||
|
|
||||||
### Missing or broken in Rust
|
### Missing or broken in Rust
|
||||||
- **No TS-style streaming tool executor** with sibling cancellation / fallback discard semantics.
|
- No TS-style hook-aware orchestration layer.
|
||||||
- **No integrated PreToolUse/PostToolUse hook participation** in assistant execution.
|
- No TS structured/remote assistant transport stack.
|
||||||
- **No comparable orchestration layer for richer tool event semantics** found.
|
- No richer TS assistant/session-history/background-task integration.
|
||||||
- Historically broken parity items in prompt mode were:
|
- JSON output path is no longer single-turn only on this branch, but output cleanliness still lags TS transport expectations.
|
||||||
- prompt tool enablement (`main.rs:75-82`) — now fixed on this branch
|
|
||||||
- streamed `{}` tool-input prefix behavior (`main.rs:2211-2256`) — now fixed/guarded on this branch
|
**Status:** strong core loop, missing orchestration layers.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 7) services/
|
## services/ (API client, auth, models, MCP)
|
||||||
|
|
||||||
### Upstream TS has
|
### TS exists
|
||||||
- Very broad service layer, including API, analytics, compact/session memory, prompt suggestions, plugin services, MCP service helpers, LSP management, policy limits, team memory sync, notifier/tips, etc.
|
Evidence:
|
||||||
- Evidence:
|
- API services under `src/services/api/*`.
|
||||||
- `src/services/api/client.ts`, `src/services/api/claude.ts`, `src/services/api/withRetry.ts`
|
- OAuth services under `src/services/oauth/*`.
|
||||||
- `src/services/oauth/client.ts`, `src/services/oauth/index.ts`
|
- MCP services under `src/services/mcp/*`.
|
||||||
- `src/services/mcp/*`
|
- Additional service layers for analytics, prompt suggestion, session memory, plugin operations, settings sync, policy limits, team memory sync, notifier, voice, and more under `src/services/*`.
|
||||||
- `src/services/plugins/*`
|
|
||||||
- `src/services/lsp/*`
|
|
||||||
- `src/services/compact/*`
|
|
||||||
- `src/services/SessionMemory/*`
|
|
||||||
- `src/services/PromptSuggestion/*`
|
|
||||||
- `src/services/analytics/*`
|
|
||||||
- `src/services/teamMemorySync/*`
|
|
||||||
|
|
||||||
### Rust currently has
|
### Rust exists
|
||||||
- Core service equivalents for:
|
Evidence:
|
||||||
- API client + SSE: `rust/crates/api/src/client.rs`, `rust/crates/api/src/sse.rs`, `rust/crates/api/src/types.rs`
|
- Core Anthropic API client in `rust/crates/api/src/{client,error,sse,types}.rs`.
|
||||||
- OAuth: `rust/crates/runtime/src/oauth.rs`
|
- OAuth support in `rust/crates/runtime/src/oauth.rs`.
|
||||||
- MCP config/bootstrap primitives: `rust/crates/runtime/src/mcp.rs`, `rust/crates/runtime/src/mcp_client.rs`, `rust/crates/runtime/src/mcp_stdio.rs`, `rust/crates/runtime/src/config.rs`
|
- MCP config/bootstrap/client support in `rust/crates/runtime/src/{config,mcp,mcp_client,mcp_stdio}.rs`.
|
||||||
- prompt/context loading: `rust/crates/runtime/src/prompt.rs`
|
- Usage accounting in `rust/crates/runtime/src/usage.rs`.
|
||||||
- session compaction/runtime usage: `rust/crates/runtime/src/compact.rs`, `rust/crates/runtime/src/usage.rs`
|
- Remote upstream-proxy support in `rust/crates/runtime/src/remote.rs`.
|
||||||
|
|
||||||
### Missing or broken in Rust
|
### Missing or broken in Rust
|
||||||
- **Missing many higher-level services**: analytics, plugin services, prompt suggestion, team memory sync, richer LSP service management, notifier/tips ecosystem, and much of the surrounding product/service scaffolding.
|
- Most TS service ecosystem beyond core messaging/auth/MCP is absent.
|
||||||
- Rust is closer to a **runtime/API core** than a full parity implementation of the TS service layer.
|
- No TS-equivalent plugin service layer.
|
||||||
|
- No TS-equivalent analytics/settings-sync/policy-limit/team-memory subsystems.
|
||||||
|
- No TS-style MCP connection-manager/UI layer.
|
||||||
|
- Model/provider ergonomics remain thinner than TS.
|
||||||
|
|
||||||
|
**Status:** core foundation exists; broader service ecosystem missing.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Highest-priority parity gaps after the critical bug fixes
|
## Critical bug status in this worktree
|
||||||
|
|
||||||
1. **Hook execution parity**
|
### Fixed
|
||||||
- Config exists, execution does not appear to.
|
- **Prompt mode tools enabled**
|
||||||
- This affects permissions, tool interception, and continuation behavior.
|
- `rust/crates/rusty-claude-cli/src/main.rs` now constructs prompt mode with `LiveCli::new(model, true, ...)`.
|
||||||
|
- **Default permission mode = DangerFullAccess**
|
||||||
|
- Runtime default now resolves to `DangerFullAccess` in `rust/crates/rusty-claude-cli/src/main.rs`.
|
||||||
|
- Clap default also uses `DangerFullAccess` in `rust/crates/rusty-claude-cli/src/args.rs`.
|
||||||
|
- Init template writes `dontAsk` in `rust/crates/rusty-claude-cli/src/init.rs`.
|
||||||
|
- **Streaming `{}` tool-input prefix bug**
|
||||||
|
- `rust/crates/rusty-claude-cli/src/main.rs` now strips the initial empty object only for streaming tool input, while preserving legitimate `{}` in non-stream responses.
|
||||||
|
- **Unlimited max_iterations**
|
||||||
|
- Verified at `rust/crates/runtime/src/conversation.rs` with `usize::MAX`.
|
||||||
|
|
||||||
2. **Plugin system parity**
|
### Remaining notable parity issue
|
||||||
- Entire install/load/manage surface appears missing.
|
- **JSON prompt output cleanliness**
|
||||||
|
- Tool-capable JSON mode now loops, but empirical verification still shows pre-JSON human-readable tool-result output when tools fire.
|
||||||
3. **CLI breadth parity**
|
|
||||||
- Missing many upstream command families and remote transports.
|
|
||||||
|
|
||||||
4. **Tool surface parity**
|
|
||||||
- MVP tool registry exists, but a large number of upstream tool types are absent.
|
|
||||||
|
|
||||||
5. **Assistant orchestration parity**
|
|
||||||
- Core loop exists, but advanced streaming/execution behaviors from TS are missing.
|
|
||||||
|
|
||||||
## Recommended next work after current critical fixes
|
|
||||||
|
|
||||||
1. Finish build/test/manual verification of the critical bug patch.
|
|
||||||
2. Implement **hook execution** before broadening the tool surface further.
|
|
||||||
3. Decide whether **plugins** are in-scope for parity; if yes, this likely needs dedicated design work, not a small patch.
|
|
||||||
4. Expand the CLI/tool matrix deliberately rather than adding one-off commands without shared orchestration support.
|
|
||||||
|
|||||||
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]
|
||||||
14
rust/Cargo.lock
generated
14
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",
|
||||||
@@ -1545,10 +1556,13 @@ dependencies = [
|
|||||||
name = "tools"
|
name = "tools"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
|
"api",
|
||||||
|
"plugins",
|
||||||
"reqwest",
|
"reqwest",
|
||||||
"runtime",
|
"runtime",
|
||||||
"serde",
|
"serde",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
|
"tokio",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|||||||
351
rust/README.md
351
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" }
|
||||||
|
|||||||
@@ -1,3 +1,9 @@
|
|||||||
|
use std::collections::BTreeMap;
|
||||||
|
use std::env;
|
||||||
|
use std::fs;
|
||||||
|
use std::path::{Path, PathBuf};
|
||||||
|
|
||||||
|
use plugins::{PluginError, PluginManager, PluginSummary};
|
||||||
use runtime::{compact_session, CompactionConfig, Session};
|
use runtime::{compact_session, CompactionConfig, Session};
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
@@ -33,6 +39,7 @@ impl CommandRegistry {
|
|||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
pub struct SlashCommandSpec {
|
pub struct SlashCommandSpec {
|
||||||
pub name: &'static str,
|
pub name: &'static str,
|
||||||
|
pub aliases: &'static [&'static str],
|
||||||
pub summary: &'static str,
|
pub summary: &'static str,
|
||||||
pub argument_hint: Option<&'static str>,
|
pub argument_hint: Option<&'static str>,
|
||||||
pub resume_supported: bool,
|
pub resume_supported: bool,
|
||||||
@@ -90,7 +97,7 @@ const SLASH_COMMAND_SPECS: &[SlashCommandSpec] = &[
|
|||||||
SlashCommandSpec {
|
SlashCommandSpec {
|
||||||
name: "config",
|
name: "config",
|
||||||
summary: "Inspect Claude config files or merged sections",
|
summary: "Inspect Claude config files or merged sections",
|
||||||
argument_hint: Some("[env|hooks|model]"),
|
argument_hint: Some("[env|hooks|model|plugins]"),
|
||||||
resume_supported: true,
|
resume_supported: true,
|
||||||
},
|
},
|
||||||
SlashCommandSpec {
|
SlashCommandSpec {
|
||||||
@@ -117,6 +124,48 @@ const SLASH_COMMAND_SPECS: &[SlashCommandSpec] = &[
|
|||||||
argument_hint: None,
|
argument_hint: None,
|
||||||
resume_supported: true,
|
resume_supported: true,
|
||||||
},
|
},
|
||||||
|
SlashCommandSpec {
|
||||||
|
name: "bughunter",
|
||||||
|
summary: "Inspect the codebase for likely bugs",
|
||||||
|
argument_hint: Some("[scope]"),
|
||||||
|
resume_supported: false,
|
||||||
|
},
|
||||||
|
SlashCommandSpec {
|
||||||
|
name: "commit",
|
||||||
|
summary: "Generate a commit message and create a git commit",
|
||||||
|
argument_hint: None,
|
||||||
|
resume_supported: false,
|
||||||
|
},
|
||||||
|
SlashCommandSpec {
|
||||||
|
name: "pr",
|
||||||
|
summary: "Draft or create a pull request from the conversation",
|
||||||
|
argument_hint: Some("[context]"),
|
||||||
|
resume_supported: false,
|
||||||
|
},
|
||||||
|
SlashCommandSpec {
|
||||||
|
name: "issue",
|
||||||
|
summary: "Draft or create a GitHub issue from the conversation",
|
||||||
|
argument_hint: Some("[context]"),
|
||||||
|
resume_supported: false,
|
||||||
|
},
|
||||||
|
SlashCommandSpec {
|
||||||
|
name: "ultraplan",
|
||||||
|
summary: "Run a deep planning prompt with multi-step reasoning",
|
||||||
|
argument_hint: Some("[task]"),
|
||||||
|
resume_supported: false,
|
||||||
|
},
|
||||||
|
SlashCommandSpec {
|
||||||
|
name: "teleport",
|
||||||
|
summary: "Jump to a file or symbol by searching the workspace",
|
||||||
|
argument_hint: Some("<symbol-or-path>"),
|
||||||
|
resume_supported: false,
|
||||||
|
},
|
||||||
|
SlashCommandSpec {
|
||||||
|
name: "debug-tool-call",
|
||||||
|
summary: "Replay the last tool call with debug details",
|
||||||
|
argument_hint: None,
|
||||||
|
resume_supported: false,
|
||||||
|
},
|
||||||
SlashCommandSpec {
|
SlashCommandSpec {
|
||||||
name: "export",
|
name: "export",
|
||||||
summary: "Export the current conversation to a file",
|
summary: "Export the current conversation to a file",
|
||||||
@@ -129,6 +178,14 @@ const SLASH_COMMAND_SPECS: &[SlashCommandSpec] = &[
|
|||||||
argument_hint: Some("[list|switch <session-id>]"),
|
argument_hint: Some("[list|switch <session-id>]"),
|
||||||
resume_supported: false,
|
resume_supported: false,
|
||||||
},
|
},
|
||||||
|
SlashCommandSpec {
|
||||||
|
name: "plugins",
|
||||||
|
summary: "List or manage plugins",
|
||||||
|
argument_hint: Some(
|
||||||
|
"[list|install <path>|enable <name>|disable <name>|uninstall <id>|update <id>]",
|
||||||
|
),
|
||||||
|
resume_supported: false,
|
||||||
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
@@ -136,6 +193,23 @@ pub enum SlashCommand {
|
|||||||
Help,
|
Help,
|
||||||
Status,
|
Status,
|
||||||
Compact,
|
Compact,
|
||||||
|
Bughunter {
|
||||||
|
scope: Option<String>,
|
||||||
|
},
|
||||||
|
Commit,
|
||||||
|
Pr {
|
||||||
|
context: Option<String>,
|
||||||
|
},
|
||||||
|
Issue {
|
||||||
|
context: Option<String>,
|
||||||
|
},
|
||||||
|
Ultraplan {
|
||||||
|
task: Option<String>,
|
||||||
|
},
|
||||||
|
Teleport {
|
||||||
|
target: Option<String>,
|
||||||
|
},
|
||||||
|
DebugToolCall,
|
||||||
Model {
|
Model {
|
||||||
model: Option<String>,
|
model: Option<String>,
|
||||||
},
|
},
|
||||||
@@ -163,6 +237,10 @@ pub enum SlashCommand {
|
|||||||
action: Option<String>,
|
action: Option<String>,
|
||||||
target: Option<String>,
|
target: Option<String>,
|
||||||
},
|
},
|
||||||
|
Plugins {
|
||||||
|
action: Option<String>,
|
||||||
|
target: Option<String>,
|
||||||
|
},
|
||||||
Unknown(String),
|
Unknown(String),
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -180,6 +258,23 @@ impl SlashCommand {
|
|||||||
"help" => Self::Help,
|
"help" => Self::Help,
|
||||||
"status" => Self::Status,
|
"status" => Self::Status,
|
||||||
"compact" => Self::Compact,
|
"compact" => Self::Compact,
|
||||||
|
"bughunter" => Self::Bughunter {
|
||||||
|
scope: remainder_after_command(trimmed, command),
|
||||||
|
},
|
||||||
|
"commit" => Self::Commit,
|
||||||
|
"pr" => Self::Pr {
|
||||||
|
context: remainder_after_command(trimmed, command),
|
||||||
|
},
|
||||||
|
"issue" => Self::Issue {
|
||||||
|
context: remainder_after_command(trimmed, command),
|
||||||
|
},
|
||||||
|
"ultraplan" => Self::Ultraplan {
|
||||||
|
task: remainder_after_command(trimmed, command),
|
||||||
|
},
|
||||||
|
"teleport" => Self::Teleport {
|
||||||
|
target: remainder_after_command(trimmed, command),
|
||||||
|
},
|
||||||
|
"debug-tool-call" => Self::DebugToolCall,
|
||||||
"model" => Self::Model {
|
"model" => Self::Model {
|
||||||
model: parts.next().map(ToOwned::to_owned),
|
model: parts.next().map(ToOwned::to_owned),
|
||||||
},
|
},
|
||||||
@@ -207,11 +302,27 @@ impl SlashCommand {
|
|||||||
action: parts.next().map(ToOwned::to_owned),
|
action: parts.next().map(ToOwned::to_owned),
|
||||||
target: parts.next().map(ToOwned::to_owned),
|
target: parts.next().map(ToOwned::to_owned),
|
||||||
},
|
},
|
||||||
|
"plugins" => Self::Plugins {
|
||||||
|
action: parts.next().map(ToOwned::to_owned),
|
||||||
|
target: {
|
||||||
|
let remainder = parts.collect::<Vec<_>>().join(" ");
|
||||||
|
(!remainder.is_empty()).then_some(remainder)
|
||||||
|
},
|
||||||
|
},
|
||||||
other => Self::Unknown(other.to_string()),
|
other => Self::Unknown(other.to_string()),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn remainder_after_command(input: &str, command: &str) -> Option<String> {
|
||||||
|
input
|
||||||
|
.trim()
|
||||||
|
.strip_prefix(&format!("/{command}"))
|
||||||
|
.map(str::trim)
|
||||||
|
.filter(|value| !value.is_empty())
|
||||||
|
.map(ToOwned::to_owned)
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn slash_command_specs() -> &'static [SlashCommandSpec] {
|
pub fn slash_command_specs() -> &'static [SlashCommandSpec] {
|
||||||
SLASH_COMMAND_SPECS
|
SLASH_COMMAND_SPECS
|
||||||
@@ -252,6 +363,176 @@ pub struct SlashCommandResult {
|
|||||||
pub session: Session,
|
pub session: Session,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct PluginsCommandResult {
|
||||||
|
pub message: String,
|
||||||
|
pub reload_runtime: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_lines)]
|
||||||
|
pub fn handle_plugins_slash_command(
|
||||||
|
action: Option<&str>,
|
||||||
|
target: Option<&str>,
|
||||||
|
manager: &mut PluginManager,
|
||||||
|
) -> Result<PluginsCommandResult, PluginError> {
|
||||||
|
match action {
|
||||||
|
None | Some("list") => Ok(PluginsCommandResult {
|
||||||
|
message: render_plugins_report(&manager.list_installed_plugins()?),
|
||||||
|
reload_runtime: false,
|
||||||
|
}),
|
||||||
|
Some("install") => {
|
||||||
|
let Some(target) = target else {
|
||||||
|
return Ok(PluginsCommandResult {
|
||||||
|
message: "Usage: /plugins install <path>".to_string(),
|
||||||
|
reload_runtime: false,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
let install = manager.install(target)?;
|
||||||
|
let plugin = manager
|
||||||
|
.list_installed_plugins()?
|
||||||
|
.into_iter()
|
||||||
|
.find(|plugin| plugin.metadata.id == install.plugin_id);
|
||||||
|
Ok(PluginsCommandResult {
|
||||||
|
message: render_plugin_install_report(&install.plugin_id, plugin.as_ref()),
|
||||||
|
reload_runtime: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
Some("enable") => {
|
||||||
|
let Some(target) = target else {
|
||||||
|
return Ok(PluginsCommandResult {
|
||||||
|
message: "Usage: /plugins enable <name>".to_string(),
|
||||||
|
reload_runtime: false,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
let plugin = resolve_plugin_target(manager, target)?;
|
||||||
|
manager.enable(&plugin.metadata.id)?;
|
||||||
|
Ok(PluginsCommandResult {
|
||||||
|
message: format!(
|
||||||
|
"Plugins\n Result enabled {}\n Name {}\n Version {}\n Status enabled",
|
||||||
|
plugin.metadata.id, plugin.metadata.name, plugin.metadata.version
|
||||||
|
),
|
||||||
|
reload_runtime: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
Some("disable") => {
|
||||||
|
let Some(target) = target else {
|
||||||
|
return Ok(PluginsCommandResult {
|
||||||
|
message: "Usage: /plugins disable <name>".to_string(),
|
||||||
|
reload_runtime: false,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
let plugin = resolve_plugin_target(manager, target)?;
|
||||||
|
manager.disable(&plugin.metadata.id)?;
|
||||||
|
Ok(PluginsCommandResult {
|
||||||
|
message: format!(
|
||||||
|
"Plugins\n Result disabled {}\n Name {}\n Version {}\n Status disabled",
|
||||||
|
plugin.metadata.id, plugin.metadata.name, plugin.metadata.version
|
||||||
|
),
|
||||||
|
reload_runtime: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
Some("uninstall") => {
|
||||||
|
let Some(target) = target else {
|
||||||
|
return Ok(PluginsCommandResult {
|
||||||
|
message: "Usage: /plugins uninstall <plugin-id>".to_string(),
|
||||||
|
reload_runtime: false,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
manager.uninstall(target)?;
|
||||||
|
Ok(PluginsCommandResult {
|
||||||
|
message: format!("Plugins\n Result uninstalled {target}"),
|
||||||
|
reload_runtime: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
Some("update") => {
|
||||||
|
let Some(target) = target else {
|
||||||
|
return Ok(PluginsCommandResult {
|
||||||
|
message: "Usage: /plugins update <plugin-id>".to_string(),
|
||||||
|
reload_runtime: false,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
let update = manager.update(target)?;
|
||||||
|
let plugin = manager
|
||||||
|
.list_installed_plugins()?
|
||||||
|
.into_iter()
|
||||||
|
.find(|plugin| plugin.metadata.id == update.plugin_id);
|
||||||
|
Ok(PluginsCommandResult {
|
||||||
|
message: format!(
|
||||||
|
"Plugins\n Result updated {}\n Name {}\n Old version {}\n New version {}\n Status {}",
|
||||||
|
update.plugin_id,
|
||||||
|
plugin
|
||||||
|
.as_ref()
|
||||||
|
.map_or_else(|| update.plugin_id.clone(), |plugin| plugin.metadata.name.clone()),
|
||||||
|
update.old_version,
|
||||||
|
update.new_version,
|
||||||
|
plugin
|
||||||
|
.as_ref()
|
||||||
|
.map_or("unknown", |plugin| if plugin.enabled { "enabled" } else { "disabled" }),
|
||||||
|
),
|
||||||
|
reload_runtime: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
Some(other) => Ok(PluginsCommandResult {
|
||||||
|
message: format!(
|
||||||
|
"Unknown /plugins action '{other}'. Use list, install, enable, disable, uninstall, or update."
|
||||||
|
),
|
||||||
|
reload_runtime: false,
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn render_plugins_report(plugins: &[PluginSummary]) -> String {
|
||||||
|
let mut lines = vec!["Plugins".to_string()];
|
||||||
|
if plugins.is_empty() {
|
||||||
|
lines.push(" No plugins installed.".to_string());
|
||||||
|
return lines.join("\n");
|
||||||
|
}
|
||||||
|
for plugin in plugins {
|
||||||
|
let enabled = if plugin.enabled {
|
||||||
|
"enabled"
|
||||||
|
} else {
|
||||||
|
"disabled"
|
||||||
|
};
|
||||||
|
lines.push(format!(
|
||||||
|
" {name:<20} v{version:<10} {enabled}",
|
||||||
|
name = plugin.metadata.name,
|
||||||
|
version = plugin.metadata.version,
|
||||||
|
));
|
||||||
|
}
|
||||||
|
lines.join("\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn render_plugin_install_report(plugin_id: &str, plugin: Option<&PluginSummary>) -> String {
|
||||||
|
let name = plugin.map_or(plugin_id, |plugin| plugin.metadata.name.as_str());
|
||||||
|
let version = plugin.map_or("unknown", |plugin| plugin.metadata.version.as_str());
|
||||||
|
let enabled = plugin.is_some_and(|plugin| plugin.enabled);
|
||||||
|
format!(
|
||||||
|
"Plugins\n Result installed {plugin_id}\n Name {name}\n Version {version}\n Status {}",
|
||||||
|
if enabled { "enabled" } else { "disabled" }
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn resolve_plugin_target(
|
||||||
|
manager: &PluginManager,
|
||||||
|
target: &str,
|
||||||
|
) -> Result<PluginSummary, PluginError> {
|
||||||
|
let mut matches = manager
|
||||||
|
.list_installed_plugins()?
|
||||||
|
.into_iter()
|
||||||
|
.filter(|plugin| plugin.metadata.id == target || plugin.metadata.name == target)
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
match matches.len() {
|
||||||
|
1 => Ok(matches.remove(0)),
|
||||||
|
0 => Err(PluginError::NotFound(format!(
|
||||||
|
"plugin `{target}` is not installed or discoverable"
|
||||||
|
))),
|
||||||
|
_ => Err(PluginError::InvalidManifest(format!(
|
||||||
|
"plugin name `{target}` is ambiguous; use the full plugin id"
|
||||||
|
))),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn handle_slash_command(
|
pub fn handle_slash_command(
|
||||||
input: &str,
|
input: &str,
|
||||||
@@ -279,6 +560,13 @@ pub fn handle_slash_command(
|
|||||||
session: session.clone(),
|
session: session.clone(),
|
||||||
}),
|
}),
|
||||||
SlashCommand::Status
|
SlashCommand::Status
|
||||||
|
| SlashCommand::Bughunter { .. }
|
||||||
|
| SlashCommand::Commit
|
||||||
|
| SlashCommand::Pr { .. }
|
||||||
|
| SlashCommand::Issue { .. }
|
||||||
|
| SlashCommand::Ultraplan { .. }
|
||||||
|
| SlashCommand::Teleport { .. }
|
||||||
|
| SlashCommand::DebugToolCall
|
||||||
| SlashCommand::Model { .. }
|
| SlashCommand::Model { .. }
|
||||||
| SlashCommand::Permissions { .. }
|
| SlashCommand::Permissions { .. }
|
||||||
| SlashCommand::Clear { .. }
|
| SlashCommand::Clear { .. }
|
||||||
@@ -291,6 +579,7 @@ pub fn handle_slash_command(
|
|||||||
| SlashCommand::Version
|
| SlashCommand::Version
|
||||||
| SlashCommand::Export { .. }
|
| SlashCommand::Export { .. }
|
||||||
| SlashCommand::Session { .. }
|
| SlashCommand::Session { .. }
|
||||||
|
| SlashCommand::Plugins { .. }
|
||||||
| SlashCommand::Unknown(_) => None,
|
| SlashCommand::Unknown(_) => None,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -298,15 +587,88 @@ pub fn handle_slash_command(
|
|||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::{
|
use super::{
|
||||||
handle_slash_command, render_slash_command_help, resume_supported_slash_commands,
|
handle_plugins_slash_command, handle_slash_command, load_agents_from_roots,
|
||||||
slash_command_specs, SlashCommand,
|
load_skills_from_roots, render_agents_report, render_plugins_report, render_skills_report,
|
||||||
|
render_slash_command_help, resume_supported_slash_commands, slash_command_specs,
|
||||||
|
DefinitionSource, SlashCommand,
|
||||||
};
|
};
|
||||||
|
use plugins::{PluginKind, PluginManager, PluginManagerConfig, PluginMetadata, PluginSummary};
|
||||||
use runtime::{CompactionConfig, ContentBlock, ConversationMessage, MessageRole, Session};
|
use runtime::{CompactionConfig, ContentBlock, ConversationMessage, MessageRole, Session};
|
||||||
|
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!("commands-plugin-{label}-{nanos}"))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn write_external_plugin(root: &Path, name: &str, version: &str) {
|
||||||
|
fs::create_dir_all(root.join(".claude-plugin")).expect("manifest dir");
|
||||||
|
fs::write(
|
||||||
|
root.join(".claude-plugin").join("plugin.json"),
|
||||||
|
format!(
|
||||||
|
"{{\n \"name\": \"{name}\",\n \"version\": \"{version}\",\n \"description\": \"commands plugin\"\n}}"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.expect("write manifest");
|
||||||
|
}
|
||||||
|
|
||||||
|
fn write_bundled_plugin(root: &Path, name: &str, version: &str, default_enabled: bool) {
|
||||||
|
fs::create_dir_all(root.join(".claude-plugin")).expect("manifest dir");
|
||||||
|
fs::write(
|
||||||
|
root.join(".claude-plugin").join("plugin.json"),
|
||||||
|
format!(
|
||||||
|
"{{\n \"name\": \"{name}\",\n \"version\": \"{version}\",\n \"description\": \"bundled commands plugin\",\n \"defaultEnabled\": {}\n}}",
|
||||||
|
if default_enabled { "true" } else { "false" }
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.expect("write bundled manifest");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_lines)]
|
||||||
#[test]
|
#[test]
|
||||||
fn parses_supported_slash_commands() {
|
fn parses_supported_slash_commands() {
|
||||||
assert_eq!(SlashCommand::parse("/help"), Some(SlashCommand::Help));
|
assert_eq!(SlashCommand::parse("/help"), Some(SlashCommand::Help));
|
||||||
assert_eq!(SlashCommand::parse(" /status "), Some(SlashCommand::Status));
|
assert_eq!(SlashCommand::parse(" /status "), Some(SlashCommand::Status));
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/bughunter runtime"),
|
||||||
|
Some(SlashCommand::Bughunter {
|
||||||
|
scope: Some("runtime".to_string())
|
||||||
|
})
|
||||||
|
);
|
||||||
|
assert_eq!(SlashCommand::parse("/commit"), Some(SlashCommand::Commit));
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/pr ready for review"),
|
||||||
|
Some(SlashCommand::Pr {
|
||||||
|
context: Some("ready for review".to_string())
|
||||||
|
})
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/issue flaky test"),
|
||||||
|
Some(SlashCommand::Issue {
|
||||||
|
context: Some("flaky test".to_string())
|
||||||
|
})
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/ultraplan ship both features"),
|
||||||
|
Some(SlashCommand::Ultraplan {
|
||||||
|
task: Some("ship both features".to_string())
|
||||||
|
})
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/teleport conversation.rs"),
|
||||||
|
Some(SlashCommand::Teleport {
|
||||||
|
target: Some("conversation.rs".to_string())
|
||||||
|
})
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/debug-tool-call"),
|
||||||
|
Some(SlashCommand::DebugToolCall)
|
||||||
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
SlashCommand::parse("/model claude-opus"),
|
SlashCommand::parse("/model claude-opus"),
|
||||||
Some(SlashCommand::Model {
|
Some(SlashCommand::Model {
|
||||||
@@ -365,6 +727,34 @@ mod tests {
|
|||||||
target: Some("abc123".to_string())
|
target: Some("abc123".to_string())
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/plugins install demo"),
|
||||||
|
Some(SlashCommand::Plugins {
|
||||||
|
action: Some("install".to_string()),
|
||||||
|
target: Some("demo".to_string())
|
||||||
|
})
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/plugins list"),
|
||||||
|
Some(SlashCommand::Plugins {
|
||||||
|
action: Some("list".to_string()),
|
||||||
|
target: None
|
||||||
|
})
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/plugins enable demo"),
|
||||||
|
Some(SlashCommand::Plugins {
|
||||||
|
action: Some("enable".to_string()),
|
||||||
|
target: Some("demo".to_string())
|
||||||
|
})
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
SlashCommand::parse("/plugins disable demo"),
|
||||||
|
Some(SlashCommand::Plugins {
|
||||||
|
action: Some("disable".to_string()),
|
||||||
|
target: Some("demo".to_string())
|
||||||
|
})
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -374,19 +764,29 @@ mod tests {
|
|||||||
assert!(help.contains("/help"));
|
assert!(help.contains("/help"));
|
||||||
assert!(help.contains("/status"));
|
assert!(help.contains("/status"));
|
||||||
assert!(help.contains("/compact"));
|
assert!(help.contains("/compact"));
|
||||||
|
assert!(help.contains("/bughunter [scope]"));
|
||||||
|
assert!(help.contains("/commit"));
|
||||||
|
assert!(help.contains("/pr [context]"));
|
||||||
|
assert!(help.contains("/issue [context]"));
|
||||||
|
assert!(help.contains("/ultraplan [task]"));
|
||||||
|
assert!(help.contains("/teleport <symbol-or-path>"));
|
||||||
|
assert!(help.contains("/debug-tool-call"));
|
||||||
assert!(help.contains("/model [model]"));
|
assert!(help.contains("/model [model]"));
|
||||||
assert!(help.contains("/permissions [read-only|workspace-write|danger-full-access]"));
|
assert!(help.contains("/permissions [read-only|workspace-write|danger-full-access]"));
|
||||||
assert!(help.contains("/clear [--confirm]"));
|
assert!(help.contains("/clear [--confirm]"));
|
||||||
assert!(help.contains("/cost"));
|
assert!(help.contains("/cost"));
|
||||||
assert!(help.contains("/resume <session-path>"));
|
assert!(help.contains("/resume <session-path>"));
|
||||||
assert!(help.contains("/config [env|hooks|model]"));
|
assert!(help.contains("/config [env|hooks|model|plugins]"));
|
||||||
assert!(help.contains("/memory"));
|
assert!(help.contains("/memory"));
|
||||||
assert!(help.contains("/init"));
|
assert!(help.contains("/init"));
|
||||||
assert!(help.contains("/diff"));
|
assert!(help.contains("/diff"));
|
||||||
assert!(help.contains("/version"));
|
assert!(help.contains("/version"));
|
||||||
assert!(help.contains("/export [file]"));
|
assert!(help.contains("/export [file]"));
|
||||||
assert!(help.contains("/session [list|switch <session-id>]"));
|
assert!(help.contains("/session [list|switch <session-id>]"));
|
||||||
assert_eq!(slash_command_specs().len(), 15);
|
assert!(help.contains(
|
||||||
|
"/plugins [list|install <path>|enable <name>|disable <name>|uninstall <id>|update <id>]"
|
||||||
|
));
|
||||||
|
assert_eq!(slash_command_specs().len(), 23);
|
||||||
assert_eq!(resume_supported_slash_commands().len(), 11);
|
assert_eq!(resume_supported_slash_commands().len(), 11);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -434,6 +834,22 @@ mod tests {
|
|||||||
let session = Session::new();
|
let session = Session::new();
|
||||||
assert!(handle_slash_command("/unknown", &session, CompactionConfig::default()).is_none());
|
assert!(handle_slash_command("/unknown", &session, CompactionConfig::default()).is_none());
|
||||||
assert!(handle_slash_command("/status", &session, CompactionConfig::default()).is_none());
|
assert!(handle_slash_command("/status", &session, CompactionConfig::default()).is_none());
|
||||||
|
assert!(
|
||||||
|
handle_slash_command("/bughunter", &session, CompactionConfig::default()).is_none()
|
||||||
|
);
|
||||||
|
assert!(handle_slash_command("/commit", &session, CompactionConfig::default()).is_none());
|
||||||
|
assert!(handle_slash_command("/pr", &session, CompactionConfig::default()).is_none());
|
||||||
|
assert!(handle_slash_command("/issue", &session, CompactionConfig::default()).is_none());
|
||||||
|
assert!(
|
||||||
|
handle_slash_command("/ultraplan", &session, CompactionConfig::default()).is_none()
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
handle_slash_command("/teleport foo", &session, CompactionConfig::default()).is_none()
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
handle_slash_command("/debug-tool-call", &session, CompactionConfig::default())
|
||||||
|
.is_none()
|
||||||
|
);
|
||||||
assert!(
|
assert!(
|
||||||
handle_slash_command("/model claude", &session, CompactionConfig::default()).is_none()
|
handle_slash_command("/model claude", &session, CompactionConfig::default()).is_none()
|
||||||
);
|
);
|
||||||
@@ -468,5 +884,221 @@ mod tests {
|
|||||||
assert!(
|
assert!(
|
||||||
handle_slash_command("/session list", &session, CompactionConfig::default()).is_none()
|
handle_slash_command("/session list", &session, CompactionConfig::default()).is_none()
|
||||||
);
|
);
|
||||||
|
assert!(
|
||||||
|
handle_slash_command("/plugins list", &session, CompactionConfig::default()).is_none()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn renders_plugins_report_with_name_version_and_status() {
|
||||||
|
let rendered = render_plugins_report(&[
|
||||||
|
PluginSummary {
|
||||||
|
metadata: PluginMetadata {
|
||||||
|
id: "demo@external".to_string(),
|
||||||
|
name: "demo".to_string(),
|
||||||
|
version: "1.2.3".to_string(),
|
||||||
|
description: "demo plugin".to_string(),
|
||||||
|
kind: PluginKind::External,
|
||||||
|
source: "demo".to_string(),
|
||||||
|
default_enabled: false,
|
||||||
|
root: None,
|
||||||
|
},
|
||||||
|
enabled: true,
|
||||||
|
},
|
||||||
|
PluginSummary {
|
||||||
|
metadata: PluginMetadata {
|
||||||
|
id: "sample@external".to_string(),
|
||||||
|
name: "sample".to_string(),
|
||||||
|
version: "0.9.0".to_string(),
|
||||||
|
description: "sample plugin".to_string(),
|
||||||
|
kind: PluginKind::External,
|
||||||
|
source: "sample".to_string(),
|
||||||
|
default_enabled: false,
|
||||||
|
root: None,
|
||||||
|
},
|
||||||
|
enabled: false,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
assert!(rendered.contains("demo"));
|
||||||
|
assert!(rendered.contains("v1.2.3"));
|
||||||
|
assert!(rendered.contains("enabled"));
|
||||||
|
assert!(rendered.contains("sample"));
|
||||||
|
assert!(rendered.contains("v0.9.0"));
|
||||||
|
assert!(rendered.contains("disabled"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn lists_agents_from_project_and_user_roots() {
|
||||||
|
let workspace = temp_dir("agents-workspace");
|
||||||
|
let project_agents = workspace.join(".codex").join("agents");
|
||||||
|
let user_home = temp_dir("agents-home");
|
||||||
|
let user_agents = user_home.join(".codex").join("agents");
|
||||||
|
|
||||||
|
write_agent(
|
||||||
|
&project_agents,
|
||||||
|
"planner",
|
||||||
|
"Project planner",
|
||||||
|
"gpt-5.4",
|
||||||
|
"medium",
|
||||||
|
);
|
||||||
|
write_agent(
|
||||||
|
&user_agents,
|
||||||
|
"planner",
|
||||||
|
"User planner",
|
||||||
|
"gpt-5.4-mini",
|
||||||
|
"high",
|
||||||
|
);
|
||||||
|
write_agent(
|
||||||
|
&user_agents,
|
||||||
|
"verifier",
|
||||||
|
"Verification agent",
|
||||||
|
"gpt-5.4-mini",
|
||||||
|
"high",
|
||||||
|
);
|
||||||
|
|
||||||
|
let roots = vec![
|
||||||
|
(DefinitionSource::ProjectCodex, project_agents),
|
||||||
|
(DefinitionSource::UserCodex, user_agents),
|
||||||
|
];
|
||||||
|
let report = render_agents_report(
|
||||||
|
&load_agents_from_roots(&roots).expect("agent roots should load"),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert!(report.contains("Agents"));
|
||||||
|
assert!(report.contains("2 active agents"));
|
||||||
|
assert!(report.contains("Project (.codex):"));
|
||||||
|
assert!(report.contains("planner · Project planner · gpt-5.4 · medium"));
|
||||||
|
assert!(report.contains("User (~/.codex):"));
|
||||||
|
assert!(report.contains("(shadowed by Project (.codex)) planner · User planner"));
|
||||||
|
assert!(report.contains("verifier · Verification agent · gpt-5.4-mini · high"));
|
||||||
|
|
||||||
|
let _ = fs::remove_dir_all(workspace);
|
||||||
|
let _ = fs::remove_dir_all(user_home);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn lists_skills_from_project_and_user_roots() {
|
||||||
|
let workspace = temp_dir("skills-workspace");
|
||||||
|
let project_skills = workspace.join(".codex").join("skills");
|
||||||
|
let user_home = temp_dir("skills-home");
|
||||||
|
let user_skills = user_home.join(".codex").join("skills");
|
||||||
|
|
||||||
|
write_skill(&project_skills, "plan", "Project planning guidance");
|
||||||
|
write_skill(&user_skills, "plan", "User planning guidance");
|
||||||
|
write_skill(&user_skills, "help", "Help guidance");
|
||||||
|
|
||||||
|
let roots = vec![
|
||||||
|
(DefinitionSource::ProjectCodex, project_skills),
|
||||||
|
(DefinitionSource::UserCodex, user_skills),
|
||||||
|
];
|
||||||
|
let report = render_skills_report(
|
||||||
|
&load_skills_from_roots(&roots).expect("skill roots should load"),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert!(report.contains("Skills"));
|
||||||
|
assert!(report.contains("2 available skills"));
|
||||||
|
assert!(report.contains("Project (.codex):"));
|
||||||
|
assert!(report.contains("plan · Project planning guidance"));
|
||||||
|
assert!(report.contains("User (~/.codex):"));
|
||||||
|
assert!(report.contains("(shadowed by Project (.codex)) plan · User planning guidance"));
|
||||||
|
assert!(report.contains("help · Help guidance"));
|
||||||
|
|
||||||
|
let _ = fs::remove_dir_all(workspace);
|
||||||
|
let _ = fs::remove_dir_all(user_home);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn installs_plugin_from_path_and_lists_it() {
|
||||||
|
let config_home = temp_dir("home");
|
||||||
|
let source_root = temp_dir("source");
|
||||||
|
write_external_plugin(&source_root, "demo", "1.0.0");
|
||||||
|
|
||||||
|
let mut manager = PluginManager::new(PluginManagerConfig::new(&config_home));
|
||||||
|
let install = handle_plugins_slash_command(
|
||||||
|
Some("install"),
|
||||||
|
Some(source_root.to_str().expect("utf8 path")),
|
||||||
|
&mut manager,
|
||||||
|
)
|
||||||
|
.expect("install command should succeed");
|
||||||
|
assert!(install.reload_runtime);
|
||||||
|
assert!(install.message.contains("installed demo@external"));
|
||||||
|
assert!(install.message.contains("Name demo"));
|
||||||
|
assert!(install.message.contains("Version 1.0.0"));
|
||||||
|
assert!(install.message.contains("Status enabled"));
|
||||||
|
|
||||||
|
let list = handle_plugins_slash_command(Some("list"), None, &mut manager)
|
||||||
|
.expect("list command should succeed");
|
||||||
|
assert!(!list.reload_runtime);
|
||||||
|
assert!(list.message.contains("demo"));
|
||||||
|
assert!(list.message.contains("v1.0.0"));
|
||||||
|
assert!(list.message.contains("enabled"));
|
||||||
|
|
||||||
|
let _ = fs::remove_dir_all(config_home);
|
||||||
|
let _ = fs::remove_dir_all(source_root);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn enables_and_disables_plugin_by_name() {
|
||||||
|
let config_home = temp_dir("toggle-home");
|
||||||
|
let source_root = temp_dir("toggle-source");
|
||||||
|
write_external_plugin(&source_root, "demo", "1.0.0");
|
||||||
|
|
||||||
|
let mut manager = PluginManager::new(PluginManagerConfig::new(&config_home));
|
||||||
|
handle_plugins_slash_command(
|
||||||
|
Some("install"),
|
||||||
|
Some(source_root.to_str().expect("utf8 path")),
|
||||||
|
&mut manager,
|
||||||
|
)
|
||||||
|
.expect("install command should succeed");
|
||||||
|
|
||||||
|
let disable = handle_plugins_slash_command(Some("disable"), Some("demo"), &mut manager)
|
||||||
|
.expect("disable command should succeed");
|
||||||
|
assert!(disable.reload_runtime);
|
||||||
|
assert!(disable.message.contains("disabled demo@external"));
|
||||||
|
assert!(disable.message.contains("Name demo"));
|
||||||
|
assert!(disable.message.contains("Status disabled"));
|
||||||
|
|
||||||
|
let list = handle_plugins_slash_command(Some("list"), None, &mut manager)
|
||||||
|
.expect("list command should succeed");
|
||||||
|
assert!(list.message.contains("demo"));
|
||||||
|
assert!(list.message.contains("disabled"));
|
||||||
|
|
||||||
|
let enable = handle_plugins_slash_command(Some("enable"), Some("demo"), &mut manager)
|
||||||
|
.expect("enable command should succeed");
|
||||||
|
assert!(enable.reload_runtime);
|
||||||
|
assert!(enable.message.contains("enabled demo@external"));
|
||||||
|
assert!(enable.message.contains("Name demo"));
|
||||||
|
assert!(enable.message.contains("Status enabled"));
|
||||||
|
|
||||||
|
let list = handle_plugins_slash_command(Some("list"), None, &mut manager)
|
||||||
|
.expect("list command should succeed");
|
||||||
|
assert!(list.message.contains("demo"));
|
||||||
|
assert!(list.message.contains("enabled"));
|
||||||
|
|
||||||
|
let _ = fs::remove_dir_all(config_home);
|
||||||
|
let _ = fs::remove_dir_all(source_root);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn lists_auto_installed_bundled_plugins_with_status() {
|
||||||
|
let config_home = temp_dir("bundled-home");
|
||||||
|
let bundled_root = temp_dir("bundled-root");
|
||||||
|
let bundled_plugin = bundled_root.join("starter");
|
||||||
|
write_bundled_plugin(&bundled_plugin, "starter", "0.1.0", false);
|
||||||
|
|
||||||
|
let mut config = PluginManagerConfig::new(&config_home);
|
||||||
|
config.bundled_root = Some(bundled_root.clone());
|
||||||
|
let mut manager = PluginManager::new(config);
|
||||||
|
|
||||||
|
let list = handle_plugins_slash_command(Some("list"), None, &mut manager)
|
||||||
|
.expect("list command should succeed");
|
||||||
|
assert!(!list.reload_runtime);
|
||||||
|
assert!(list.message.contains("starter"));
|
||||||
|
assert!(list.message.contains("v0.1.0"));
|
||||||
|
assert!(list.message.contains("disabled"));
|
||||||
|
|
||||||
|
let _ = fs::remove_dir_all(config_home);
|
||||||
|
let _ = fs::remove_dir_all(bundled_root);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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()]);
|
||||||
|
}
|
||||||
|
}
|
||||||
2929
rust/crates/plugins/src/lib.rs
Normal file
2929
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,8 +35,19 @@ 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>,
|
||||||
@@ -44,6 +55,12 @@ pub struct RuntimeFeatureConfig {
|
|||||||
sandbox: SandboxConfig,
|
sandbox: SandboxConfig,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq, Default)]
|
||||||
|
pub struct RuntimeHookConfig {
|
||||||
|
pre_tool_use: Vec<String>,
|
||||||
|
post_tool_use: 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 +184,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,6 +240,8 @@ 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,
|
||||||
},
|
},
|
||||||
@@ -278,6 +299,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()
|
||||||
@@ -300,6 +331,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
|
||||||
@@ -326,6 +379,85 @@ impl RuntimeFeatureConfig {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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>) -> Self {
|
||||||
|
Self {
|
||||||
|
pre_tool_use,
|
||||||
|
post_tool_use,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[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 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());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
impl McpConfigCollection {
|
impl McpConfigCollection {
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn servers(&self) -> &BTreeMap<String, ScopedMcpServerConfig> {
|
pub fn servers(&self) -> &BTreeMap<String, ScopedMcpServerConfig> {
|
||||||
@@ -424,6 +556,52 @@ 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(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
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 +834,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 +926,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::{
|
||||||
@@ -836,6 +1044,8 @@ 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!(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 +1181,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();
|
||||||
|
|||||||
@@ -1,13 +1,20 @@
|
|||||||
use std::collections::BTreeMap;
|
use std::collections::BTreeMap;
|
||||||
use std::fmt::{Display, Formatter};
|
use std::fmt::{Display, Formatter};
|
||||||
|
|
||||||
|
use plugins::{HookRunner as PluginHookRunner, PluginRegistry};
|
||||||
|
|
||||||
use crate::compact::{
|
use crate::compact::{
|
||||||
compact_session, estimate_session_tokens, CompactionConfig, CompactionResult,
|
compact_session, estimate_session_tokens, CompactionConfig, CompactionResult,
|
||||||
};
|
};
|
||||||
|
use crate::config::RuntimeFeatureConfig;
|
||||||
|
use crate::hooks::HookRunner;
|
||||||
use crate::permissions::{PermissionOutcome, PermissionPolicy, PermissionPrompter};
|
use crate::permissions::{PermissionOutcome, PermissionPolicy, PermissionPrompter};
|
||||||
use crate::session::{ContentBlock, ConversationMessage, Session};
|
use crate::session::{ContentBlock, ConversationMessage, Session};
|
||||||
use crate::usage::{TokenUsage, UsageTracker};
|
use crate::usage::{TokenUsage, UsageTracker};
|
||||||
|
|
||||||
|
const DEFAULT_AUTO_COMPACTION_INPUT_TOKENS_THRESHOLD: u32 = 200_000;
|
||||||
|
const AUTO_COMPACTION_THRESHOLD_ENV_VAR: &str = "CLAUDE_CODE_AUTO_COMPACT_INPUT_TOKENS";
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
pub struct ApiRequest {
|
pub struct ApiRequest {
|
||||||
pub system_prompt: Vec<String>,
|
pub system_prompt: Vec<String>,
|
||||||
@@ -84,6 +91,12 @@ pub struct TurnSummary {
|
|||||||
pub tool_results: Vec<ConversationMessage>,
|
pub tool_results: Vec<ConversationMessage>,
|
||||||
pub iterations: usize,
|
pub iterations: usize,
|
||||||
pub usage: TokenUsage,
|
pub usage: TokenUsage,
|
||||||
|
pub auto_compaction: Option<AutoCompactionEvent>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
|
pub struct AutoCompactionEvent {
|
||||||
|
pub removed_message_count: usize,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub struct ConversationRuntime<C, T> {
|
pub struct ConversationRuntime<C, T> {
|
||||||
@@ -94,6 +107,26 @@ pub struct ConversationRuntime<C, T> {
|
|||||||
system_prompt: Vec<String>,
|
system_prompt: Vec<String>,
|
||||||
max_iterations: usize,
|
max_iterations: usize,
|
||||||
usage_tracker: UsageTracker,
|
usage_tracker: UsageTracker,
|
||||||
|
hook_runner: HookRunner,
|
||||||
|
auto_compaction_input_tokens_threshold: u32,
|
||||||
|
plugin_hook_runner: Option<PluginHookRunner>,
|
||||||
|
plugin_registry: Option<PluginRegistry>,
|
||||||
|
plugins_shutdown: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<C, T> ConversationRuntime<C, T> {
|
||||||
|
fn shutdown_registered_plugins(&mut self) -> Result<(), RuntimeError> {
|
||||||
|
if self.plugins_shutdown {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
if let Some(registry) = &self.plugin_registry {
|
||||||
|
registry
|
||||||
|
.shutdown()
|
||||||
|
.map_err(|error| RuntimeError::new(format!("plugin shutdown failed: {error}")))?;
|
||||||
|
}
|
||||||
|
self.plugins_shutdown = true;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<C, T> ConversationRuntime<C, T>
|
impl<C, T> ConversationRuntime<C, T>
|
||||||
@@ -108,6 +141,26 @@ where
|
|||||||
tool_executor: T,
|
tool_executor: T,
|
||||||
permission_policy: PermissionPolicy,
|
permission_policy: PermissionPolicy,
|
||||||
system_prompt: Vec<String>,
|
system_prompt: Vec<String>,
|
||||||
|
) -> Self {
|
||||||
|
Self::new_with_features(
|
||||||
|
session,
|
||||||
|
api_client,
|
||||||
|
tool_executor,
|
||||||
|
permission_policy,
|
||||||
|
system_prompt,
|
||||||
|
RuntimeFeatureConfig::default(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
#[allow(clippy::needless_pass_by_value)]
|
||||||
|
pub fn new_with_features(
|
||||||
|
session: Session,
|
||||||
|
api_client: C,
|
||||||
|
tool_executor: T,
|
||||||
|
permission_policy: PermissionPolicy,
|
||||||
|
system_prompt: Vec<String>,
|
||||||
|
feature_config: RuntimeFeatureConfig,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
let usage_tracker = UsageTracker::from_session(&session);
|
let usage_tracker = UsageTracker::from_session(&session);
|
||||||
Self {
|
Self {
|
||||||
@@ -118,15 +171,57 @@ where
|
|||||||
system_prompt,
|
system_prompt,
|
||||||
max_iterations: usize::MAX,
|
max_iterations: usize::MAX,
|
||||||
usage_tracker,
|
usage_tracker,
|
||||||
|
hook_runner: HookRunner::from_feature_config(&feature_config),
|
||||||
|
auto_compaction_input_tokens_threshold: auto_compaction_threshold_from_env(),
|
||||||
|
plugin_hook_runner: None,
|
||||||
|
plugin_registry: None,
|
||||||
|
plugins_shutdown: false,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::needless_pass_by_value)]
|
||||||
|
pub fn new_with_plugins(
|
||||||
|
session: Session,
|
||||||
|
api_client: C,
|
||||||
|
tool_executor: T,
|
||||||
|
permission_policy: PermissionPolicy,
|
||||||
|
system_prompt: Vec<String>,
|
||||||
|
feature_config: RuntimeFeatureConfig,
|
||||||
|
plugin_registry: PluginRegistry,
|
||||||
|
) -> Result<Self, RuntimeError> {
|
||||||
|
let plugin_hook_runner =
|
||||||
|
PluginHookRunner::from_registry(&plugin_registry).map_err(|error| {
|
||||||
|
RuntimeError::new(format!("plugin hook registration failed: {error}"))
|
||||||
|
})?;
|
||||||
|
plugin_registry
|
||||||
|
.initialize()
|
||||||
|
.map_err(|error| RuntimeError::new(format!("plugin initialization failed: {error}")))?;
|
||||||
|
let mut runtime = Self::new_with_features(
|
||||||
|
session,
|
||||||
|
api_client,
|
||||||
|
tool_executor,
|
||||||
|
permission_policy,
|
||||||
|
system_prompt,
|
||||||
|
feature_config,
|
||||||
|
);
|
||||||
|
runtime.plugin_hook_runner = Some(plugin_hook_runner);
|
||||||
|
runtime.plugin_registry = Some(plugin_registry);
|
||||||
|
Ok(runtime)
|
||||||
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn with_max_iterations(mut self, max_iterations: usize) -> Self {
|
pub fn with_max_iterations(mut self, max_iterations: usize) -> Self {
|
||||||
self.max_iterations = max_iterations;
|
self.max_iterations = max_iterations;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn with_auto_compaction_input_tokens_threshold(mut self, threshold: u32) -> Self {
|
||||||
|
self.auto_compaction_input_tokens_threshold = threshold;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_lines)]
|
||||||
pub fn run_turn(
|
pub fn run_turn(
|
||||||
&mut self,
|
&mut self,
|
||||||
user_input: impl Into<String>,
|
user_input: impl Into<String>,
|
||||||
@@ -139,6 +234,7 @@ where
|
|||||||
let mut assistant_messages = Vec::new();
|
let mut assistant_messages = Vec::new();
|
||||||
let mut tool_results = Vec::new();
|
let mut tool_results = Vec::new();
|
||||||
let mut iterations = 0;
|
let mut iterations = 0;
|
||||||
|
let mut max_turn_input_tokens = 0;
|
||||||
|
|
||||||
loop {
|
loop {
|
||||||
iterations += 1;
|
iterations += 1;
|
||||||
@@ -155,6 +251,7 @@ where
|
|||||||
let events = self.api_client.stream(request)?;
|
let events = self.api_client.stream(request)?;
|
||||||
let (assistant_message, usage) = build_assistant_message(events)?;
|
let (assistant_message, usage) = build_assistant_message(events)?;
|
||||||
if let Some(usage) = usage {
|
if let Some(usage) = usage {
|
||||||
|
max_turn_input_tokens = max_turn_input_tokens.max(usage.input_tokens);
|
||||||
self.usage_tracker.record(usage);
|
self.usage_tracker.record(usage);
|
||||||
}
|
}
|
||||||
let pending_tool_uses = assistant_message
|
let pending_tool_uses = assistant_message
|
||||||
@@ -185,19 +282,80 @@ where
|
|||||||
|
|
||||||
let result_message = match permission_outcome {
|
let result_message = match permission_outcome {
|
||||||
PermissionOutcome::Allow => {
|
PermissionOutcome::Allow => {
|
||||||
|
let pre_hook_result = self.hook_runner.run_pre_tool_use(&tool_name, &input);
|
||||||
|
if pre_hook_result.is_denied() {
|
||||||
|
let deny_message = format!("PreToolUse hook denied tool `{tool_name}`");
|
||||||
|
ConversationMessage::tool_result(
|
||||||
|
tool_use_id,
|
||||||
|
tool_name,
|
||||||
|
format_hook_message(pre_hook_result.messages(), &deny_message),
|
||||||
|
true,
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
let plugin_pre_hook_result =
|
||||||
|
self.run_plugin_pre_tool_use(&tool_name, &input);
|
||||||
|
if plugin_pre_hook_result.is_denied() {
|
||||||
|
let deny_message =
|
||||||
|
format!("PreToolUse hook denied tool `{tool_name}`");
|
||||||
|
let mut messages = pre_hook_result.messages().to_vec();
|
||||||
|
messages.extend(plugin_pre_hook_result.messages().iter().cloned());
|
||||||
|
ConversationMessage::tool_result(
|
||||||
|
tool_use_id,
|
||||||
|
tool_name,
|
||||||
|
format_hook_message(&messages, &deny_message),
|
||||||
|
true,
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
let (mut output, mut is_error) =
|
||||||
match self.tool_executor.execute(&tool_name, &input) {
|
match self.tool_executor.execute(&tool_name, &input) {
|
||||||
Ok(output) => ConversationMessage::tool_result(
|
Ok(output) => (output, false),
|
||||||
|
Err(error) => (error.to_string(), true),
|
||||||
|
};
|
||||||
|
output =
|
||||||
|
merge_hook_feedback(pre_hook_result.messages(), output, false);
|
||||||
|
output = merge_hook_feedback(
|
||||||
|
plugin_pre_hook_result.messages(),
|
||||||
|
output,
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
|
||||||
|
let hook_output = output.clone();
|
||||||
|
let post_hook_result = self.hook_runner.run_post_tool_use(
|
||||||
|
&tool_name,
|
||||||
|
&input,
|
||||||
|
&hook_output,
|
||||||
|
is_error,
|
||||||
|
);
|
||||||
|
let plugin_post_hook_result = self.run_plugin_post_tool_use(
|
||||||
|
&tool_name,
|
||||||
|
&input,
|
||||||
|
&hook_output,
|
||||||
|
is_error,
|
||||||
|
);
|
||||||
|
if post_hook_result.is_denied() {
|
||||||
|
is_error = true;
|
||||||
|
}
|
||||||
|
if plugin_post_hook_result.is_denied() {
|
||||||
|
is_error = true;
|
||||||
|
}
|
||||||
|
output = merge_hook_feedback(
|
||||||
|
post_hook_result.messages(),
|
||||||
|
output,
|
||||||
|
post_hook_result.is_denied(),
|
||||||
|
);
|
||||||
|
output = merge_hook_feedback(
|
||||||
|
plugin_post_hook_result.messages(),
|
||||||
|
output,
|
||||||
|
plugin_post_hook_result.is_denied(),
|
||||||
|
);
|
||||||
|
|
||||||
|
ConversationMessage::tool_result(
|
||||||
tool_use_id,
|
tool_use_id,
|
||||||
tool_name,
|
tool_name,
|
||||||
output,
|
output,
|
||||||
false,
|
is_error,
|
||||||
),
|
)
|
||||||
Err(error) => ConversationMessage::tool_result(
|
}
|
||||||
tool_use_id,
|
|
||||||
tool_name,
|
|
||||||
error.to_string(),
|
|
||||||
true,
|
|
||||||
),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
PermissionOutcome::Deny { reason } => {
|
PermissionOutcome::Deny { reason } => {
|
||||||
@@ -209,11 +367,14 @@ where
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let auto_compaction = self.maybe_auto_compact(max_turn_input_tokens);
|
||||||
|
|
||||||
Ok(TurnSummary {
|
Ok(TurnSummary {
|
||||||
assistant_messages,
|
assistant_messages,
|
||||||
tool_results,
|
tool_results,
|
||||||
iterations,
|
iterations,
|
||||||
usage: self.usage_tracker.cumulative_usage(),
|
usage: self.usage_tracker.cumulative_usage(),
|
||||||
|
auto_compaction,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -238,9 +399,81 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn into_session(self) -> Session {
|
pub fn into_session(mut self) -> Session {
|
||||||
self.session
|
let _ = self.shutdown_registered_plugins();
|
||||||
|
std::mem::take(&mut self.session)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn shutdown_plugins(&mut self) -> Result<(), RuntimeError> {
|
||||||
|
self.shutdown_registered_plugins()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn run_plugin_pre_tool_use(&self, tool_name: &str, input: &str) -> plugins::HookRunResult {
|
||||||
|
self.plugin_hook_runner.as_ref().map_or_else(
|
||||||
|
|| plugins::HookRunResult::allow(Vec::new()),
|
||||||
|
|runner| runner.run_pre_tool_use(tool_name, input),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn run_plugin_post_tool_use(
|
||||||
|
&self,
|
||||||
|
tool_name: &str,
|
||||||
|
input: &str,
|
||||||
|
output: &str,
|
||||||
|
is_error: bool,
|
||||||
|
) -> plugins::HookRunResult {
|
||||||
|
self.plugin_hook_runner.as_ref().map_or_else(
|
||||||
|
|| plugins::HookRunResult::allow(Vec::new()),
|
||||||
|
|runner| runner.run_post_tool_use(tool_name, input, output, is_error),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn maybe_auto_compact(&mut self, turn_input_tokens: u32) -> Option<AutoCompactionEvent> {
|
||||||
|
if turn_input_tokens < self.auto_compaction_input_tokens_threshold {
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
|
||||||
|
let result = compact_session(
|
||||||
|
&self.session,
|
||||||
|
CompactionConfig {
|
||||||
|
max_estimated_tokens: usize::try_from(self.auto_compaction_input_tokens_threshold)
|
||||||
|
.unwrap_or(usize::MAX),
|
||||||
|
..CompactionConfig::default()
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
if result.removed_message_count == 0 {
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
|
||||||
|
self.session = result.compacted_session;
|
||||||
|
Some(AutoCompactionEvent {
|
||||||
|
removed_message_count: result.removed_message_count,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<C, T> Drop for ConversationRuntime<C, T> {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
let _ = self.shutdown_registered_plugins();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn auto_compaction_threshold_from_env() -> u32 {
|
||||||
|
parse_auto_compaction_threshold(
|
||||||
|
std::env::var(AUTO_COMPACTION_THRESHOLD_ENV_VAR)
|
||||||
|
.ok()
|
||||||
|
.as_deref(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
fn parse_auto_compaction_threshold(value: Option<&str>) -> u32 {
|
||||||
|
value
|
||||||
|
.and_then(|raw| raw.trim().parse::<u32>().ok())
|
||||||
|
.filter(|threshold| *threshold > 0)
|
||||||
|
.unwrap_or(DEFAULT_AUTO_COMPACTION_INPUT_TOKENS_THRESHOLD)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn build_assistant_message(
|
fn build_assistant_message(
|
||||||
@@ -290,6 +523,32 @@ fn flush_text_block(text: &mut String, blocks: &mut Vec<ContentBlock>) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn format_hook_message(messages: &[String], fallback: &str) -> String {
|
||||||
|
if messages.is_empty() {
|
||||||
|
fallback.to_string()
|
||||||
|
} else {
|
||||||
|
messages.join("\n")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn merge_hook_feedback(messages: &[String], output: String, denied: bool) -> String {
|
||||||
|
if messages.is_empty() {
|
||||||
|
return output;
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut sections = Vec::new();
|
||||||
|
if !output.trim().is_empty() {
|
||||||
|
sections.push(output);
|
||||||
|
}
|
||||||
|
let label = if denied {
|
||||||
|
"Hook feedback (denied)"
|
||||||
|
} else {
|
||||||
|
"Hook feedback"
|
||||||
|
};
|
||||||
|
sections.push(format!("{label}:\n{}", messages.join("\n")));
|
||||||
|
sections.join("\n\n")
|
||||||
|
}
|
||||||
|
|
||||||
type ToolHandler = Box<dyn FnMut(&str) -> Result<String, ToolError>>;
|
type ToolHandler = Box<dyn FnMut(&str) -> Result<String, ToolError>>;
|
||||||
|
|
||||||
#[derive(Default)]
|
#[derive(Default)]
|
||||||
@@ -325,10 +584,12 @@ impl ToolExecutor for StaticToolExecutor {
|
|||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::{
|
use super::{
|
||||||
ApiClient, ApiRequest, AssistantEvent, ConversationRuntime, RuntimeError,
|
parse_auto_compaction_threshold, ApiClient, ApiRequest, AssistantEvent,
|
||||||
StaticToolExecutor,
|
AutoCompactionEvent, ConversationRuntime, RuntimeError, StaticToolExecutor,
|
||||||
|
DEFAULT_AUTO_COMPACTION_INPUT_TOKENS_THRESHOLD,
|
||||||
};
|
};
|
||||||
use crate::compact::CompactionConfig;
|
use crate::compact::CompactionConfig;
|
||||||
|
use crate::config::{RuntimeFeatureConfig, RuntimeHookConfig};
|
||||||
use crate::permissions::{
|
use crate::permissions::{
|
||||||
PermissionMode, PermissionPolicy, PermissionPromptDecision, PermissionPrompter,
|
PermissionMode, PermissionPolicy, PermissionPromptDecision, PermissionPrompter,
|
||||||
PermissionRequest,
|
PermissionRequest,
|
||||||
@@ -336,7 +597,13 @@ mod tests {
|
|||||||
use crate::prompt::{ProjectContext, SystemPromptBuilder};
|
use crate::prompt::{ProjectContext, SystemPromptBuilder};
|
||||||
use crate::session::{ContentBlock, MessageRole, Session};
|
use crate::session::{ContentBlock, MessageRole, Session};
|
||||||
use crate::usage::TokenUsage;
|
use crate::usage::TokenUsage;
|
||||||
|
use plugins::{PluginManager, PluginManagerConfig};
|
||||||
|
use std::fs;
|
||||||
|
#[cfg(unix)]
|
||||||
|
use std::os::unix::fs::PermissionsExt;
|
||||||
|
use std::path::Path;
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
|
use std::time::{SystemTime, UNIX_EPOCH};
|
||||||
|
|
||||||
struct ScriptedApiClient {
|
struct ScriptedApiClient {
|
||||||
call_count: usize,
|
call_count: usize,
|
||||||
@@ -398,6 +665,68 @@ mod tests {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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!("runtime-plugin-{label}-{nanos}"))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn write_lifecycle_plugin(root: &Path, name: &str) -> PathBuf {
|
||||||
|
fs::create_dir_all(root.join(".claude-plugin")).expect("manifest dir");
|
||||||
|
fs::create_dir_all(root.join("lifecycle")).expect("lifecycle dir");
|
||||||
|
let log_path = root.join("lifecycle.log");
|
||||||
|
fs::write(
|
||||||
|
root.join("lifecycle").join("init.sh"),
|
||||||
|
"#!/bin/sh\nprintf 'init\\n' >> lifecycle.log\n",
|
||||||
|
)
|
||||||
|
.expect("write init script");
|
||||||
|
fs::write(
|
||||||
|
root.join("lifecycle").join("shutdown.sh"),
|
||||||
|
"#!/bin/sh\nprintf 'shutdown\\n' >> lifecycle.log\n",
|
||||||
|
)
|
||||||
|
.expect("write shutdown script");
|
||||||
|
fs::write(
|
||||||
|
root.join(".claude-plugin").join("plugin.json"),
|
||||||
|
format!(
|
||||||
|
"{{\n \"name\": \"{name}\",\n \"version\": \"1.0.0\",\n \"description\": \"runtime lifecycle plugin\",\n \"lifecycle\": {{\n \"Init\": [\"./lifecycle/init.sh\"],\n \"Shutdown\": [\"./lifecycle/shutdown.sh\"]\n }}\n}}"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.expect("write plugin manifest");
|
||||||
|
log_path
|
||||||
|
}
|
||||||
|
|
||||||
|
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");
|
||||||
|
#[cfg(unix)]
|
||||||
|
{
|
||||||
|
let exec_mode = fs::Permissions::from_mode(0o755);
|
||||||
|
fs::set_permissions(root.join("hooks").join("pre.sh"), exec_mode.clone())
|
||||||
|
.expect("chmod pre hook");
|
||||||
|
fs::set_permissions(root.join("hooks").join("post.sh"), exec_mode)
|
||||||
|
.expect("chmod post hook");
|
||||||
|
}
|
||||||
|
fs::write(
|
||||||
|
root.join(".claude-plugin").join("plugin.json"),
|
||||||
|
format!(
|
||||||
|
"{{\n \"name\": \"{name}\",\n \"version\": \"1.0.0\",\n \"description\": \"runtime hook plugin\",\n \"hooks\": {{\n \"PreToolUse\": [\"./hooks/pre.sh\"],\n \"PostToolUse\": [\"./hooks/post.sh\"]\n }}\n}}"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.expect("write plugin manifest");
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn runs_user_to_tool_to_result_loop_end_to_end_and_tracks_usage() {
|
fn runs_user_to_tool_to_result_loop_end_to_end_and_tracks_usage() {
|
||||||
let api_client = ScriptedApiClient { call_count: 0 };
|
let api_client = ScriptedApiClient { call_count: 0 };
|
||||||
@@ -436,6 +765,7 @@ mod tests {
|
|||||||
assert_eq!(summary.tool_results.len(), 1);
|
assert_eq!(summary.tool_results.len(), 1);
|
||||||
assert_eq!(runtime.session().messages.len(), 4);
|
assert_eq!(runtime.session().messages.len(), 4);
|
||||||
assert_eq!(summary.usage.output_tokens, 10);
|
assert_eq!(summary.usage.output_tokens, 10);
|
||||||
|
assert_eq!(summary.auto_compaction, None);
|
||||||
assert!(matches!(
|
assert!(matches!(
|
||||||
runtime.session().messages[1].blocks[1],
|
runtime.session().messages[1].blocks[1],
|
||||||
ContentBlock::ToolUse { .. }
|
ContentBlock::ToolUse { .. }
|
||||||
@@ -503,6 +833,288 @@ mod tests {
|
|||||||
));
|
));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn denies_tool_use_when_pre_tool_hook_blocks() {
|
||||||
|
struct SingleCallApiClient;
|
||||||
|
impl ApiClient for SingleCallApiClient {
|
||||||
|
fn stream(&mut self, request: ApiRequest) -> Result<Vec<AssistantEvent>, RuntimeError> {
|
||||||
|
if request
|
||||||
|
.messages
|
||||||
|
.iter()
|
||||||
|
.any(|message| message.role == MessageRole::Tool)
|
||||||
|
{
|
||||||
|
return Ok(vec![
|
||||||
|
AssistantEvent::TextDelta("blocked".to_string()),
|
||||||
|
AssistantEvent::MessageStop,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
Ok(vec![
|
||||||
|
AssistantEvent::ToolUse {
|
||||||
|
id: "tool-1".to_string(),
|
||||||
|
name: "blocked".to_string(),
|
||||||
|
input: r#"{"path":"secret.txt"}"#.to_string(),
|
||||||
|
},
|
||||||
|
AssistantEvent::MessageStop,
|
||||||
|
])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut runtime = ConversationRuntime::new_with_features(
|
||||||
|
Session::new(),
|
||||||
|
SingleCallApiClient,
|
||||||
|
StaticToolExecutor::new().register("blocked", |_input| {
|
||||||
|
panic!("tool should not execute when hook denies")
|
||||||
|
}),
|
||||||
|
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
||||||
|
vec!["system".to_string()],
|
||||||
|
RuntimeFeatureConfig::default().with_hooks(RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet("printf 'blocked by hook'; exit 2")],
|
||||||
|
Vec::new(),
|
||||||
|
)),
|
||||||
|
);
|
||||||
|
|
||||||
|
let summary = runtime
|
||||||
|
.run_turn("use the tool", None)
|
||||||
|
.expect("conversation should continue after hook denial");
|
||||||
|
|
||||||
|
assert_eq!(summary.tool_results.len(), 1);
|
||||||
|
let ContentBlock::ToolResult {
|
||||||
|
is_error, output, ..
|
||||||
|
} = &summary.tool_results[0].blocks[0]
|
||||||
|
else {
|
||||||
|
panic!("expected tool result block");
|
||||||
|
};
|
||||||
|
assert!(
|
||||||
|
*is_error,
|
||||||
|
"hook denial should produce an error result: {output}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
output.contains("denied tool") || output.contains("blocked by hook"),
|
||||||
|
"unexpected hook denial output: {output:?}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn appends_post_tool_hook_feedback_to_tool_result() {
|
||||||
|
struct TwoCallApiClient {
|
||||||
|
calls: usize,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ApiClient for TwoCallApiClient {
|
||||||
|
fn stream(&mut self, request: ApiRequest) -> Result<Vec<AssistantEvent>, RuntimeError> {
|
||||||
|
self.calls += 1;
|
||||||
|
match self.calls {
|
||||||
|
1 => Ok(vec![
|
||||||
|
AssistantEvent::ToolUse {
|
||||||
|
id: "tool-1".to_string(),
|
||||||
|
name: "add".to_string(),
|
||||||
|
input: r#"{"lhs":2,"rhs":2}"#.to_string(),
|
||||||
|
},
|
||||||
|
AssistantEvent::MessageStop,
|
||||||
|
]),
|
||||||
|
2 => {
|
||||||
|
assert!(request
|
||||||
|
.messages
|
||||||
|
.iter()
|
||||||
|
.any(|message| message.role == MessageRole::Tool));
|
||||||
|
Ok(vec![
|
||||||
|
AssistantEvent::TextDelta("done".to_string()),
|
||||||
|
AssistantEvent::MessageStop,
|
||||||
|
])
|
||||||
|
}
|
||||||
|
_ => Err(RuntimeError::new("unexpected extra API call")),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut runtime = ConversationRuntime::new_with_features(
|
||||||
|
Session::new(),
|
||||||
|
TwoCallApiClient { calls: 0 },
|
||||||
|
StaticToolExecutor::new().register("add", |_input| Ok("4".to_string())),
|
||||||
|
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
||||||
|
vec!["system".to_string()],
|
||||||
|
RuntimeFeatureConfig::default().with_hooks(RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet("printf 'pre hook ran'")],
|
||||||
|
vec![shell_snippet("printf 'post hook ran'")],
|
||||||
|
)),
|
||||||
|
);
|
||||||
|
|
||||||
|
let summary = runtime
|
||||||
|
.run_turn("use add", None)
|
||||||
|
.expect("tool loop succeeds");
|
||||||
|
|
||||||
|
assert_eq!(summary.tool_results.len(), 1);
|
||||||
|
let ContentBlock::ToolResult {
|
||||||
|
is_error, output, ..
|
||||||
|
} = &summary.tool_results[0].blocks[0]
|
||||||
|
else {
|
||||||
|
panic!("expected tool result block");
|
||||||
|
};
|
||||||
|
assert!(
|
||||||
|
!*is_error,
|
||||||
|
"post hook should preserve non-error result: {output:?}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
output.contains('4'),
|
||||||
|
"tool output missing value: {output:?}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
output.contains("pre hook ran"),
|
||||||
|
"tool output missing pre hook feedback: {output:?}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
output.contains("post hook ran"),
|
||||||
|
"tool output missing post hook feedback: {output:?}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn initializes_and_shuts_down_plugins_with_runtime_lifecycle() {
|
||||||
|
let config_home = temp_dir("config");
|
||||||
|
let source_root = temp_dir("source");
|
||||||
|
let _ = write_lifecycle_plugin(&source_root, "runtime-lifecycle");
|
||||||
|
|
||||||
|
let mut manager = PluginManager::new(PluginManagerConfig::new(&config_home));
|
||||||
|
let install = manager
|
||||||
|
.install(source_root.to_str().expect("utf8 path"))
|
||||||
|
.expect("install should succeed");
|
||||||
|
let log_path = install.install_path.join("lifecycle.log");
|
||||||
|
let registry = manager.plugin_registry().expect("registry should load");
|
||||||
|
|
||||||
|
{
|
||||||
|
let runtime = ConversationRuntime::new_with_plugins(
|
||||||
|
Session::new(),
|
||||||
|
ScriptedApiClient { call_count: 0 },
|
||||||
|
StaticToolExecutor::new().register("add", |_input| Ok("4".to_string())),
|
||||||
|
PermissionPolicy::new(PermissionMode::WorkspaceWrite),
|
||||||
|
vec!["system".to_string()],
|
||||||
|
RuntimeFeatureConfig::default(),
|
||||||
|
registry,
|
||||||
|
)
|
||||||
|
.expect("runtime should initialize plugins");
|
||||||
|
|
||||||
|
let log = fs::read_to_string(&log_path).expect("init log should exist");
|
||||||
|
assert_eq!(log, "init\n");
|
||||||
|
drop(runtime);
|
||||||
|
}
|
||||||
|
|
||||||
|
let log = fs::read_to_string(&log_path).expect("shutdown log should exist");
|
||||||
|
assert_eq!(log, "init\nshutdown\n");
|
||||||
|
|
||||||
|
let _ = fs::remove_dir_all(config_home);
|
||||||
|
let _ = fs::remove_dir_all(source_root);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn executes_hooks_from_installed_plugins_during_tool_use() {
|
||||||
|
struct TwoCallApiClient {
|
||||||
|
calls: usize,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ApiClient for TwoCallApiClient {
|
||||||
|
fn stream(&mut self, request: ApiRequest) -> Result<Vec<AssistantEvent>, RuntimeError> {
|
||||||
|
self.calls += 1;
|
||||||
|
match self.calls {
|
||||||
|
1 => Ok(vec![
|
||||||
|
AssistantEvent::ToolUse {
|
||||||
|
id: "tool-1".to_string(),
|
||||||
|
name: "add".to_string(),
|
||||||
|
input: r#"{"lhs":2,"rhs":2}"#.to_string(),
|
||||||
|
},
|
||||||
|
AssistantEvent::MessageStop,
|
||||||
|
]),
|
||||||
|
2 => {
|
||||||
|
assert!(request
|
||||||
|
.messages
|
||||||
|
.iter()
|
||||||
|
.any(|message| message.role == MessageRole::Tool));
|
||||||
|
Ok(vec![
|
||||||
|
AssistantEvent::TextDelta("done".to_string()),
|
||||||
|
AssistantEvent::MessageStop,
|
||||||
|
])
|
||||||
|
}
|
||||||
|
_ => Err(RuntimeError::new("unexpected extra API call")),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let config_home = temp_dir("hook-config");
|
||||||
|
let first_source_root = temp_dir("hook-source-a");
|
||||||
|
let second_source_root = temp_dir("hook-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 load");
|
||||||
|
|
||||||
|
let mut runtime = ConversationRuntime::new_with_plugins(
|
||||||
|
Session::new(),
|
||||||
|
TwoCallApiClient { calls: 0 },
|
||||||
|
StaticToolExecutor::new().register("add", |_input| Ok("4".to_string())),
|
||||||
|
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
||||||
|
vec!["system".to_string()],
|
||||||
|
RuntimeFeatureConfig::default(),
|
||||||
|
registry,
|
||||||
|
)
|
||||||
|
.expect("runtime should load plugin hooks");
|
||||||
|
|
||||||
|
let summary = runtime
|
||||||
|
.run_turn("use add", None)
|
||||||
|
.expect("tool loop succeeds");
|
||||||
|
|
||||||
|
assert_eq!(summary.tool_results.len(), 1);
|
||||||
|
let ContentBlock::ToolResult {
|
||||||
|
is_error, output, ..
|
||||||
|
} = &summary.tool_results[0].blocks[0]
|
||||||
|
else {
|
||||||
|
panic!("expected tool result block");
|
||||||
|
};
|
||||||
|
assert!(
|
||||||
|
!*is_error,
|
||||||
|
"plugin hooks should not force an error: {output:?}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
output.contains('4'),
|
||||||
|
"tool output missing value: {output:?}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
output.contains("plugin pre one"),
|
||||||
|
"tool output missing first pre hook feedback: {output:?}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
output.contains("plugin pre two"),
|
||||||
|
"tool output missing second pre hook feedback: {output:?}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
output.contains("plugin post one"),
|
||||||
|
"tool output missing first post hook feedback: {output:?}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
output.contains("plugin post two"),
|
||||||
|
"tool output missing second post hook feedback: {output:?}"
|
||||||
|
);
|
||||||
|
|
||||||
|
let _ = fs::remove_dir_all(config_home);
|
||||||
|
let _ = fs::remove_dir_all(first_source_root);
|
||||||
|
let _ = fs::remove_dir_all(second_source_root);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn reconstructs_usage_tracker_from_restored_session() {
|
fn reconstructs_usage_tracker_from_restored_session() {
|
||||||
struct SimpleApi;
|
struct SimpleApi;
|
||||||
@@ -581,4 +1193,187 @@ mod tests {
|
|||||||
MessageRole::System
|
MessageRole::System
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(windows)]
|
||||||
|
fn shell_snippet(script: &str) -> String {
|
||||||
|
script.replace('\'', "\"")
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(not(windows))]
|
||||||
|
fn shell_snippet(script: &str) -> String {
|
||||||
|
script.to_string()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn auto_compacts_when_turn_input_threshold_is_crossed() {
|
||||||
|
struct SimpleApi;
|
||||||
|
impl ApiClient for SimpleApi {
|
||||||
|
fn stream(
|
||||||
|
&mut self,
|
||||||
|
_request: ApiRequest,
|
||||||
|
) -> Result<Vec<AssistantEvent>, RuntimeError> {
|
||||||
|
Ok(vec![
|
||||||
|
AssistantEvent::TextDelta("done".to_string()),
|
||||||
|
AssistantEvent::Usage(TokenUsage {
|
||||||
|
input_tokens: 120_000,
|
||||||
|
output_tokens: 4,
|
||||||
|
cache_creation_input_tokens: 0,
|
||||||
|
cache_read_input_tokens: 0,
|
||||||
|
}),
|
||||||
|
AssistantEvent::MessageStop,
|
||||||
|
])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let session = Session {
|
||||||
|
version: 1,
|
||||||
|
messages: vec![
|
||||||
|
crate::session::ConversationMessage::user_text("one ".repeat(30_000)),
|
||||||
|
crate::session::ConversationMessage::assistant(vec![ContentBlock::Text {
|
||||||
|
text: "two ".repeat(30_000),
|
||||||
|
}]),
|
||||||
|
crate::session::ConversationMessage::user_text("three ".repeat(30_000)),
|
||||||
|
crate::session::ConversationMessage::assistant(vec![ContentBlock::Text {
|
||||||
|
text: "four ".repeat(30_000),
|
||||||
|
}]),
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut runtime = ConversationRuntime::new(
|
||||||
|
session,
|
||||||
|
SimpleApi,
|
||||||
|
StaticToolExecutor::new(),
|
||||||
|
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
||||||
|
vec!["system".to_string()],
|
||||||
|
)
|
||||||
|
.with_auto_compaction_input_tokens_threshold(100_000);
|
||||||
|
|
||||||
|
let summary = runtime
|
||||||
|
.run_turn("trigger", None)
|
||||||
|
.expect("turn should succeed");
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
summary.auto_compaction,
|
||||||
|
Some(AutoCompactionEvent {
|
||||||
|
removed_message_count: 2,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
assert_eq!(runtime.session().messages[0].role, MessageRole::System);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn auto_compaction_does_not_repeat_after_context_is_already_compacted() {
|
||||||
|
struct SequentialUsageApi {
|
||||||
|
call_count: usize,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ApiClient for SequentialUsageApi {
|
||||||
|
fn stream(
|
||||||
|
&mut self,
|
||||||
|
_request: ApiRequest,
|
||||||
|
) -> Result<Vec<AssistantEvent>, RuntimeError> {
|
||||||
|
self.call_count += 1;
|
||||||
|
let input_tokens = if self.call_count == 1 { 120_000 } else { 64 };
|
||||||
|
Ok(vec![
|
||||||
|
AssistantEvent::TextDelta("done".to_string()),
|
||||||
|
AssistantEvent::Usage(TokenUsage {
|
||||||
|
input_tokens,
|
||||||
|
output_tokens: 4,
|
||||||
|
cache_creation_input_tokens: 0,
|
||||||
|
cache_read_input_tokens: 0,
|
||||||
|
}),
|
||||||
|
AssistantEvent::MessageStop,
|
||||||
|
])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let session = Session {
|
||||||
|
version: 1,
|
||||||
|
messages: vec![
|
||||||
|
crate::session::ConversationMessage::user_text("one ".repeat(30_000)),
|
||||||
|
crate::session::ConversationMessage::assistant(vec![ContentBlock::Text {
|
||||||
|
text: "two ".repeat(30_000),
|
||||||
|
}]),
|
||||||
|
crate::session::ConversationMessage::user_text("three ".repeat(30_000)),
|
||||||
|
crate::session::ConversationMessage::assistant(vec![ContentBlock::Text {
|
||||||
|
text: "four ".repeat(30_000),
|
||||||
|
}]),
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut runtime = ConversationRuntime::new(
|
||||||
|
session,
|
||||||
|
SequentialUsageApi { call_count: 0 },
|
||||||
|
StaticToolExecutor::new(),
|
||||||
|
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
||||||
|
vec!["system".to_string()],
|
||||||
|
)
|
||||||
|
.with_auto_compaction_input_tokens_threshold(100_000);
|
||||||
|
|
||||||
|
let first = runtime
|
||||||
|
.run_turn("trigger", None)
|
||||||
|
.expect("first turn should succeed");
|
||||||
|
assert_eq!(
|
||||||
|
first.auto_compaction,
|
||||||
|
Some(AutoCompactionEvent {
|
||||||
|
removed_message_count: 2,
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
let second = runtime
|
||||||
|
.run_turn("continue", None)
|
||||||
|
.expect("second turn should succeed");
|
||||||
|
assert_eq!(second.auto_compaction, None);
|
||||||
|
assert_eq!(runtime.session().messages[0].role, MessageRole::System);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn skips_auto_compaction_below_threshold() {
|
||||||
|
struct SimpleApi;
|
||||||
|
impl ApiClient for SimpleApi {
|
||||||
|
fn stream(
|
||||||
|
&mut self,
|
||||||
|
_request: ApiRequest,
|
||||||
|
) -> Result<Vec<AssistantEvent>, RuntimeError> {
|
||||||
|
Ok(vec![
|
||||||
|
AssistantEvent::TextDelta("done".to_string()),
|
||||||
|
AssistantEvent::Usage(TokenUsage {
|
||||||
|
input_tokens: 99_999,
|
||||||
|
output_tokens: 4,
|
||||||
|
cache_creation_input_tokens: 0,
|
||||||
|
cache_read_input_tokens: 0,
|
||||||
|
}),
|
||||||
|
AssistantEvent::MessageStop,
|
||||||
|
])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut runtime = ConversationRuntime::new(
|
||||||
|
Session::new(),
|
||||||
|
SimpleApi,
|
||||||
|
StaticToolExecutor::new(),
|
||||||
|
PermissionPolicy::new(PermissionMode::DangerFullAccess),
|
||||||
|
vec!["system".to_string()],
|
||||||
|
)
|
||||||
|
.with_auto_compaction_input_tokens_threshold(100_000);
|
||||||
|
|
||||||
|
let summary = runtime
|
||||||
|
.run_turn("trigger", None)
|
||||||
|
.expect("turn should succeed");
|
||||||
|
assert_eq!(summary.auto_compaction, None);
|
||||||
|
assert_eq!(runtime.session().messages.len(), 2);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn auto_compaction_threshold_defaults_and_parses_values() {
|
||||||
|
assert_eq!(
|
||||||
|
parse_auto_compaction_threshold(None),
|
||||||
|
DEFAULT_AUTO_COMPACTION_INPUT_TOKENS_THRESHOLD
|
||||||
|
);
|
||||||
|
assert_eq!(parse_auto_compaction_threshold(Some("4321")), 4321);
|
||||||
|
assert_eq!(
|
||||||
|
parse_auto_compaction_threshold(Some("not-a-number")),
|
||||||
|
DEFAULT_AUTO_COMPACTION_INPUT_TOKENS_THRESHOLD
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
355
rust/crates/runtime/src/hooks.rs
Normal file
355
rust/crates/runtime/src/hooks.rs
Normal file
@@ -0,0 +1,355 @@
|
|||||||
|
use std::ffi::OsStr;
|
||||||
|
use std::path::Path;
|
||||||
|
use std::process::Command;
|
||||||
|
|
||||||
|
use serde_json::json;
|
||||||
|
|
||||||
|
use crate::config::{RuntimeFeatureConfig, RuntimeHookConfig};
|
||||||
|
|
||||||
|
#[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 {
|
||||||
|
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_commands(
|
||||||
|
HookEvent::PreToolUse,
|
||||||
|
self.config.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.config.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 } => {
|
||||||
|
let message = message.unwrap_or_else(|| {
|
||||||
|
format!("{} hook denied tool `{tool_name}`", event.as_str())
|
||||||
|
});
|
||||||
|
messages.push(message);
|
||||||
|
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 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: 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;
|
||||||
|
child_stdin.write_all(stdin)?;
|
||||||
|
}
|
||||||
|
child.wait_with_output()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::{HookRunResult, HookRunner};
|
||||||
|
use crate::config::{RuntimeFeatureConfig, RuntimeHookConfig};
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn allows_exit_code_zero_and_captures_stdout() {
|
||||||
|
let runner = HookRunner::new(RuntimeHookConfig::new(
|
||||||
|
vec![shell_snippet("printf 'pre ok'")],
|
||||||
|
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(),
|
||||||
|
));
|
||||||
|
|
||||||
|
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(),
|
||||||
|
),
|
||||||
|
));
|
||||||
|
|
||||||
|
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")));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[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,19 @@ 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,
|
||||||
CLAUDE_CODE_SETTINGS_SCHEMA_NAME,
|
RuntimePluginConfig, ScopedMcpServerConfig, 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::{HookEvent, 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,
|
||||||
|
|||||||
@@ -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,6 +17,7 @@ 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", "time"] }
|
||||||
|
|||||||
@@ -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,32 +154,63 @@ 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 self.quote > 0 {
|
|
||||||
styled = format!("{}", styled.with(theme.quote));
|
|
||||||
}
|
|
||||||
styled
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn capture_target_mut<'a>(&'a mut self, output: &'a mut String) -> &'a mut String {
|
if let Some(level) = self.heading_level {
|
||||||
if let Some(table) = self.table.as_mut() {
|
style = match level {
|
||||||
&mut table.current_cell
|
1 => style.with(theme.heading),
|
||||||
} else {
|
2 => style.white(),
|
||||||
output
|
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 {
|
||||||
|
style = style.with(theme.quote);
|
||||||
|
}
|
||||||
|
|
||||||
|
format!("{style}")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn append_raw(&mut self, output: &mut String, text: &str) {
|
||||||
|
if let Some(link) = self.link_stack.last_mut() {
|
||||||
|
link.text.push_str(text);
|
||||||
|
} else if let Some(table) = self.table.as_mut() {
|
||||||
|
table.current_cell.push_str(text);
|
||||||
|
} else {
|
||||||
|
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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -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, .. }) => {
|
||||||
|
state.link_stack.push(LinkState {
|
||||||
|
destination: dest_url.to_string(),
|
||||||
|
text: String::new(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
Event::End(TagEnd::Link) => {
|
||||||
|
if let Some(link) = state.link_stack.pop() {
|
||||||
|
let label = if link.text.is_empty() {
|
||||||
|
link.destination.clone()
|
||||||
|
} else {
|
||||||
|
link.text
|
||||||
|
};
|
||||||
let rendered = format!(
|
let rendered = format!(
|
||||||
"{}",
|
"{}",
|
||||||
format!("[{dest_url}]")
|
format!("[{label}]({})", link.destination)
|
||||||
.underlined()
|
.underlined()
|
||||||
.with(self.color_theme.link)
|
.with(self.color_theme.link)
|
||||||
);
|
);
|
||||||
state.capture_target_mut(output).push_str(&rendered);
|
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,16 @@ 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) {
|
#[allow(clippy::unused_self)]
|
||||||
|
fn start_heading(&self, state: &mut RenderState, level: u8, output: &mut String) {
|
||||||
|
state.heading_level = Some(level);
|
||||||
|
if !output.is_empty() {
|
||||||
output.push('\n');
|
output.push('\n');
|
||||||
let prefix = match level {
|
}
|
||||||
1 => "# ",
|
|
||||||
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 +455,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() {
|
||||||
|
"code".to_string()
|
||||||
|
} else {
|
||||||
|
code_language.to_string()
|
||||||
|
};
|
||||||
let _ = writeln!(
|
let _ = writeln!(
|
||||||
output,
|
output,
|
||||||
"{}",
|
"{}",
|
||||||
format!("╭─ {code_language}").with(self.color_theme.heading)
|
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 +490,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 +577,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 +588,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 +693,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 +707,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 +759,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();
|
||||||
|
|||||||
@@ -6,10 +6,13 @@ license.workspace = true
|
|||||||
publish.workspace = true
|
publish.workspace = true
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
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"] }
|
||||||
serde_json = "1"
|
serde_json = "1"
|
||||||
|
tokio = { version = "1", features = ["rt-multi-thread"] }
|
||||||
|
|
||||||
[lints]
|
[lints]
|
||||||
workspace = true
|
workspace = true
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user