Skip to main content

Documentation Index

Fetch the complete documentation index at: https://arizeai-433a7140.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Available in @arizeai/phoenix-cli 1.4.0+ The px profile command group lets you store named connection profiles — each bundling an endpoint, project, API key, and custom headers under a single name like prod or staging. Activate a profile once and every px command picks it up automatically, so you no longer need to re-export environment variables when switching between Phoenix instances.

​
Profile resolution order

CLI flags → environment variables → active profile → built-in defaults
Existing scripts that set PHOENIX_HOST / PHOENIX_API_KEY / etc. keep working without modification.

​
Managing profiles

# Create a profile (interactive prompts fill in the details)
px profile create prod

# Create a profile with all values supplied upfront
px profile create staging \
  --endpoint https://staging.phoenix.example.com \
  --project my-project \
  --api-key $STAGING_API_KEY

# Switch the active profile
px profile use prod

# List all profiles (active profile is marked)
px profile list

# Inspect a specific profile
px profile show prod

# Edit a profile in $EDITOR
px profile edit staging

# Delete a profile
px profile delete staging

​
Check which profile is active

px auth status now surfaces the active profile name alongside the resolved endpoint and authentication state: 
px auth status
# Endpoint:       https://prod.phoenix.example.com
# Active profile: prod
# Auth:           API key configured

​
Editor autocomplete via JSON Schema

The CLI publishes a JSON Schema for the settings file (~/.px/profiles.json). Add a $schema key to enable autocomplete and validation in editors that support JSON Schema: 
{
  "$schema": "https://unpkg.com/@arizeai/phoenix-cli/schemas/phoenix-cli-settings.json",
  "activeProfile": "prod",
  "profiles": {
    "prod": {
      "endpoint": "https://prod.phoenix.example.com",
      "apiKey": "...",
      "project": "production"
    }
  }
}