Skip to main content

phoenix/js/packages/phoenix-cli at main · Arize-ai/phoenix

GitHub
Phoenix CLI is a command-line interface for your Phoenix projects. Fetch traces, list datasets, export experiment results, and access prompts directly from your terminal—or pipe them into AI coding agents like Claude Code, Cursor, Codex, and Gemini CLI. You can use Phoenix CLI for:
  • Immediate Debugging: Fetch the most recent trace of a failed or unexpected run with a single command
  • Bulk Export: Export large numbers of traces or experiment results to JSON files for offline analysis
  • Dataset & Experiment Access: List datasets and retrieve full experiment data including runs, evaluations, and trace IDs
  • Prompt Introspection: View and export prompt templates for analysis, optimization, or use with other tools
  • Terminal Workflows: Integrate trace and experiment data into your existing tools, piping output to Unix utilities like jq
  • AI Coding Assistants: Use with Claude Code, Cursor, Windsurf, or other AI-powered tools to analyze traces, experiments, and optimize prompts
Don’t see a use-case covered? @arizeai/phoenix-cli is open-source! Issues and PRs welcome.

Installation

Or run directly with npx:

Quick Start

Environment Variables

CLI flags take priority over environment variables.

Profiles

A profile saves the endpoint, project, API key, and headers for a Phoenix instance under a name like prod or staging. Activate a profile and every px command picks up those settings without re-exporting environment variables. Environment variables and CLI flags still override the active profile, so existing scripts keep working.

px profile create <name>

Create a new profile.

px profile list

List all profiles. The active profile is marked in a current column (kubectl-style).

px profile show [name]

Show a profile (defaults to the active one).

px profile use <name>

Set the active profile. Reports the transition (Switched active profile: staging → prod); a no-op if the profile is already active.

px profile edit <name>

Open a profile in $PHOENIX_EDITOR if set, otherwise $EDITOR, falling back to vi. The CLI validates the JSON on save and re-opens the editor on validation failure. Edits are discarded if the editor exits non-zero.

px profile delete <name>

Delete a profile. Deleting the active profile leaves no profile active — set a new one with px profile use <name>.

Editor autocomplete via JSON Schema

@arizeai/phoenix-cli publishes a JSON Schema for the settings file. Add a $schema key to enable autocomplete and validation in editors that support JSON Schema:

Commands

px project list

List all available projects.

px trace list [directory]

Fetch recent traces from the configured project.

px trace get <trace-id>

Fetch a specific trace by ID.

px span list [file]

Fetch individual spans from the configured project with comprehensive filtering.

px span add-note <span-id>

Notes are a reserved annotation type. Unlike other annotations, notes are open-ended and multiple notes can be attached to the same span.

px session list

List sessions (multi-turn conversations) for a project.

px session get <session-id>

View a session’s conversation flow, including all traces (turns) in the session.

px session annotate <session-id>

Add or update an annotation on a session. Address the session by GlobalID or by user-provided session_id.
At least one of --label, --score, or --explanation is required.

px session add-note <session-id>

Add a free-text note to a session. Address the session by GlobalID or by user-provided session_id. A session can carry multiple notes; each receives a unique identifier. Requires Phoenix server >= 14.17.0.

px dataset list

List all available datasets.

px dataset get <dataset-identifier>

Fetch examples from a dataset.

px experiment list --dataset <name-or-id>

List experiments for a dataset, optionally exporting full data to files.

px experiment get <experiment-id>

Fetch a single experiment with all run data, including inputs, outputs, evaluations, and trace IDs.

px prompt list

List all available prompts.

px prompt get <prompt_identifier>

Show a Phoenix prompt. Supports multiple output formats including a text format optimized for piping to AI coding assistants.
The text format outputs prompt content with XML-style role tags, ideal for piping to AI assistants:

px api graphql <query>

Make authenticated GraphQL queries against the Phoenix API. Output is {"data": {...}} JSON — pipe with jq '.data.<field>' to extract values. Only queries are permitted; mutations and subscriptions are rejected before hitting the server.

Discover the schema with introspection

Use introspection to explore what fields and types are available without leaving your terminal:

Projects

Available fields: id, name, traceCount, recordCount, tokenCountTotal, tokenCountPrompt, tokenCountCompletion, createdAt, updatedAt.

Datasets

Available fields: id, name, description, exampleCount, experimentCount, evaluatorCount, createdAt, updatedAt.

Experiments

Experiments are nested under datasets in the GraphQL schema:
To inspect individual run outputs, errors, and trace IDs:
Available run fields: traceId, output, error, latencyMs, startTime, endTime.

Evaluators

Instance summary

┌─ Trace: abc123def456 │ │ Input: What is the weather in San Francisco? │ Output: The weather is currently sunny… │ │ Spans: │ └─ ✓ agent_run (CHAIN) - 1250ms │ ├─ ✓ llm_call (LLM) - 800ms │ └─ ✓ tool_execution (TOOL) - 400ms └─
Spans include OpenInference semantic attributes like llm.model_name, llm.token_count.*, input.value, output.value, tool.name, and exception.*.

Examples

Debug failed traces

Find slowest traces

Find errored spans

Inspect LLM spans with annotations

Extract LLM models used

Count errors

List datasets and experiments

Analyze experiment results

Work with prompts

Query the GraphQL API directly

Use with AI Coding Assistants

Phoenix CLI is designed to work seamlessly with AI coding assistants like Claude Code, Cursor, and Windsurf.

Claude Code

Ask Claude Code:
Claude Code will discover the CLI via px --help and fetch your traces for analysis.

Prompt Optimization with Claude Code

Pipe your Phoenix prompts directly to Claude Code for analysis and optimization suggestions:
You can also ask Claude Code to work with your prompts interactively:

Cursor / Windsurf

Run the CLI in the terminal and ask the AI to interpret:
For prompt work:

Retrieve Traces via CLI

User guide for fetching traces from the command line

@arizeai/phoenix-client

TypeScript client for the Phoenix API

License

Apache 2.0