Skip to content

docs: document uv prerequisite #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
XinweiHe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document uv prerequisite #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down