Skip to main content

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 agenteye CLI, distinct from the collector daemon (agenteye-collector). The PyPI package and the installed command are both agenteye.

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] [--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

Add --json to any command for machine-readable output:

agenteye events --session-id run-001 --all --json | jq '.events[].payload'

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

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).

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agenteye-0.1.0.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agenteye-0.1.0-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

Details for the file agenteye-0.1.0.tar.gz.

File metadata

  • Download URL: agenteye-0.1.0.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for agenteye-0.1.0.tar.gz
Algorithm Hash digest
SHA256 90aa1701f72d427c60ef78c480ae759e608be658fe61c3e744d341ad89477bdb
MD5 c43153cf296ded94a1775a040b3d1d10
BLAKE2b-256 9561f2d5205c20143f2b2f261eb2a1cb05a853f6e9241bc0c22e61d3ff33f99d

See more details on using hashes here.

Provenance

The following attestation bundles were made for agenteye-0.1.0.tar.gz:

Publisher: release-cli.yml on FailproofAI/agenteye

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file agenteye-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: agenteye-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for agenteye-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 496c68817409cec30145f4795edd05d85bc0b09fa62636110cc9b430fdea3dca
MD5 a897f71cecbe6f24fe70298e785bedfa
BLAKE2b-256 69d1fef42f99e6006a00d9b28c92af8c647fde56993ef2de7109c54c5c8b5300

See more details on using hashes here.

Provenance

The following attestation bundles were made for agenteye-0.1.0-py3-none-any.whl:

Publisher: release-cli.yml on FailproofAI/agenteye

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page