Command-line client for the AgentEye dashboard API
Project description
AgentEye CLI (agenteye)
A command-line client for the AgentEye dashboard API. It lets a developer —
or the coding agent working alongside them — authenticate and query agent
sessions, event logs, and evaluations from the terminal, with a --json flag on
every command for scripting.
This is the
agenteyeCLI, distinct from the collector daemon (agenteye-collector). The PyPI package and the installed command are bothagenteye.
Install
pipx install agenteye # recommended (isolated)
# or: uv tool install agenteye / pip install agenteye
Install isolated (pipx / uv tool) — the AgentEye Python SDK shares the agenteye
distribution name, so isolation avoids a clash in a shared virtualenv.
For development in this repo:
cd cli
uv sync --extra dev
uv run agenteye --help
Authentication
The CLI talks to your dashboard (set --base-url or AGENTEYE_DASHBOARD_URL) and logs in with
an emailed one-time code:
agenteye login --email you@example.com
# enter the 6-digit code; the session is stored in ~/.agenteye/cli.json (mode 0600)
agenteye whoami
agenteye logout
Sessions expire (24h by default); re-run agenteye login when prompted.
Commands
agenteye sessions [--since 24h] [--status error] [--agent-id <id>] [--score helpfulness:..0.5] [--all]
agenteye events --session-id <id> [--event-type tool_use,tool_result] [--all]
agenteye logs ... # alias of events
agenteye evals --score helpfulness:0.5..0.8 --latest-per-session
agenteye session show <id>
agenteye session export <id> -o out.json
agenteye re-evaluate <id>
agenteye jobs # in-flight evaluation queue
agenteye environments [--source events|evals]
agenteye version # print the CLI version
agenteye help # show top-level help
Every command and subcommand has --help / -h; agenteye -h documents auth, exit codes, and
the global options. Global options go before the command (agenteye --json events, not
agenteye events --json).
Add --json for machine-readable output, and --fields to project just the keys you need:
agenteye --json events --session-id run-001 --all | jq '.events[].payload'
agenteye --json sessions --since 7d --fields session_id,status,scores
Configuration
| Setting | Flag | Env var | Default |
|---|---|---|---|
| Dashboard URL | --base-url |
AGENTEYE_DASHBOARD_URL |
required (no default) |
| Session token | --token |
AGENTEYE_CLI_TOKEN |
from ~/.agenteye/cli.json |
| JSON output | --json |
AGENTEYE_CLI_JSON |
off |
| Skip TLS verification | --insecure / --secure |
AGENTEYE_INSECURE |
off (saved at login) |
| Disable usage telemetry | (none) | AGENTEYE_ANALYTICS_DISABLED (or DO_NOT_TRACK) |
telemetry on |
Precedence is flag > environment variable > config file. The dashboard URL is
required (no default) — set --base-url or AGENTEYE_DASHBOARD_URL, or it's saved
after your first login. The config directory honours AGENTEYE_HOME (same as the SDK
and collector).
For a dashboard with a self-signed or internal TLS certificate, add --insecure to skip
certificate verification (saved at login, so you set it once). This disables protection
against man-in-the-middle attacks — prefer a valid certificate outside internal/testing use.
Telemetry
The CLI sends anonymous usage analytics (which commands run, success/exit status, and duration)
to help prioritise improvements. No data, URLs, tokens, emails, or query values are ever sent,
and operators are identified only by an opaque id. It's on by default — disable it with
AGENTEYE_ANALYTICS_DISABLED=1 (or the cross-tool DO_NOT_TRACK=1). Sending is time-bounded, so it
never delays a command. See enterprise-docs/cli.md for the full privacy details.
Exit codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 2 | Usage error (bad arguments) |
| 3 | Cannot reach the dashboard |
| 4 | Not logged in / session expired |
| 5 | Authenticated but missing permission |
Tests
cd cli
uv run --extra dev pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agenteye-0.1.5.tar.gz.
File metadata
- Download URL: agenteye-0.1.5.tar.gz
- Upload date:
- Size: 34.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0aaa079946196690d280bab942a441728f37650c5791390b051b71524072b47
|
|
| MD5 |
bf769264fa67139f8cd129668a144ac4
|
|
| BLAKE2b-256 |
f466067437b53e0fd052bb7255a8c004088d6fc9c6daeea5f8818e66b17fc558
|
Provenance
The following attestation bundles were made for agenteye-0.1.5.tar.gz:
Publisher:
release-cli.yml on FailproofAI/agenteye
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
agenteye-0.1.5.tar.gz -
Subject digest:
b0aaa079946196690d280bab942a441728f37650c5791390b051b71524072b47 - Sigstore transparency entry: 1677435520
- Sigstore integration time:
-
Permalink:
FailproofAI/agenteye@c28c6bbe8ff6d983dc0f9af758f0afdaabca8abe -
Branch / Tag:
refs/heads/main - Owner: https://github.com/FailproofAI
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-cli.yml@c28c6bbe8ff6d983dc0f9af758f0afdaabca8abe -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file agenteye-0.1.5-py3-none-any.whl.
File metadata
- Download URL: agenteye-0.1.5-py3-none-any.whl
- Upload date:
- Size: 35.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
43e4ba5f440e1cdc652b454e74d700f0e9fc42dbf0fb2c9a831d2919693efc89
|
|
| MD5 |
5abf281677d68bda0377bfceedf75618
|
|
| BLAKE2b-256 |
9b5377b7567c561cb22f70621fee8ea0f2b4318140723697f540078294b84cde
|
Provenance
The following attestation bundles were made for agenteye-0.1.5-py3-none-any.whl:
Publisher:
release-cli.yml on FailproofAI/agenteye
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
agenteye-0.1.5-py3-none-any.whl -
Subject digest:
43e4ba5f440e1cdc652b454e74d700f0e9fc42dbf0fb2c9a831d2919693efc89 - Sigstore transparency entry: 1677435530
- Sigstore integration time:
-
Permalink:
FailproofAI/agenteye@c28c6bbe8ff6d983dc0f9af758f0afdaabca8abe -
Branch / Tag:
refs/heads/main - Owner: https://github.com/FailproofAI
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-cli.yml@c28c6bbe8ff6d983dc0f9af758f0afdaabca8abe -
Trigger Event:
workflow_dispatch
-
Statement type: