From 832dc52b4d6b34b910825577bfc6410cdddfc360 Mon Sep 17 00:00:00 2001 From: XinweiHe Date: Wed, 24 Jun 2026 05:07:56 -0700 Subject: [PATCH] docs: document uv prerequisite (silent no-op without it) The hooks run via 'uv run --script' to fetch the tracing SDK on demand; the '|| python3' fallback runs without the deps and fails open, so a user without uv installs the plugin but captures nothing with no error. Add a Requirements section so that's not a silent footgun. Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 6957893..3da589f 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,21 @@ Each conversation turn becomes a trace in TraceRoot showing the LLM call, tool i --- +## Requirements + +This plugin runs its hooks with [`uv`](https://docs.astral.sh/uv/), which fetches the tracing SDK on demand (no global install needed). You must have `uv` available on your `PATH`: + +```bash +# macOS / Linux +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +`uv` provisions Python 3.11+ automatically, so no separate Python install is required. + +> **Note:** Without `uv`, the plugin still installs but **silently captures nothing** (the hooks fail open with no traces and no error). If you've installed it and see no traces in TraceRoot, check that `uv` is on your `PATH` first. + +--- + ## Installation ### Plugin marketplace (recommended)