Skip to content

Commit 45499eb

Browse files
committed
add the pip command
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
1 parent bf5c401 commit 45499eb

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

content/docs/quick-start.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,20 @@ description: "Get up and running with AgentEvals in under 5 minutes."
66

77
## Installation
88

9-
Grab a wheel from the [releases page](https://github.com/agentevals-dev/agentevals/releases). The **core** wheel has the CLI and REST API. The **bundle** wheel adds streaming and the embedded web UI.
9+
**From PyPI** (recommended): the published package includes the **CLI**, **REST API**, and **embedded web UI**.
1010

1111
```bash
12-
pip install agentevals-<version>-py3-none-any.whl
12+
pip install agentevals-cli
13+
```
14+
15+
Optional extras:
1316

14-
# For live streaming support:
15-
pip install "agentevals-<version>-py3-none-any.whl[live]"
17+
```bash
18+
pip install "agentevals-cli[live]" # MCP server (`agentevals mcp`)
1619
```
1720

21+
**GitHub [releases page](https://github.com/agentevals-dev/agentevals/releases)** also ships **core** wheels (CLI and API only) and **bundle** wheels (with the embedded UI) if you need a specific version or offline `pip install ./path/to.whl`. For MCP support, install with the `[live]` extra the same way as from PyPI (for example `pip install "./your-wheel.whl[live]"`).
22+
1823
**From source** with `uv` or Nix:
1924

2025
```bash
@@ -29,15 +34,15 @@ See [DEVELOPMENT.md](https://github.com/agentevals-dev/agentevals/blob/main/DEVE
2934
Run an evaluation against a sample trace:
3035

3136
```bash
32-
uv run agentevals run samples/helm.json \
37+
agentevals run samples/helm.json \
3338
--eval-set samples/eval_set_helm.json \
3439
-m tool_trajectory_avg_score
3540
```
3641

3742
List available evaluators:
3843

3944
```bash
40-
uv run agentevals evaluator list
45+
agentevals evaluator list
4146
```
4247

4348
## Live UI Quick Start

0 commit comments

Comments
 (0)