arize-projects

Arize AX Projects

Manage projects in the Arize AI platform using the ax CLI.

Prerequisites

The user must have:

1. Arize AX CLI installed (pip install arize-ax-cli)
2. CLI configured with valid credentials (ax config init)

Core Project Commands

List Projects

ax projects list

Options:

• --space-id <id> - Space ID to list projects from (uses config default if not set)
• --limit, -n <count> - Maximum number of projects to return (default: 15)
• --cursor <token> - Pagination cursor for next page
• --output, -o <format> - Output format: table (default), json, csv, parquet, or a file path
• --profile, -p <name> - Configuration profile to use
• --verbose, -v - Enable verbose logs

Examples:

# List projects (default table format)
ax projects list

# List as JSON
ax projects list --output json

# List from a specific space
ax projects list --space-id sp_abc123

# Limit results
ax projects list -n 5

# Use production profile
ax projects list --profile production

Extracting Project IDs:

# Get all project IDs and names as JSON
ax projects list --output json | jq '.[] | {id: .id, name: .name}'

# Find a project ID by name
ax projects list --output json | jq -r '.[] | select(.name == "My Project") | .id'

# Save project ID to a variable
PROJECT_ID=$(ax projects list --output json | jq -r '.[] | select(.name == "My Project") | .id')
echo "Found project: $PROJECT_ID"

Without jq (using grep):

# Find project by name
ax projects list --output json | grep -B 1 '"name": "My Project"' | grep "id" | cut -d'"' -f4

Resolving Project Names to IDs

The CLI commands (get, delete) require a project ID, not a name. When a user refers to a project by name, resolve the ID first using projects list:

1. Run ax projects list --output json
2. Parse the JSON to find the project matching the requested name
3. Use the resolved ID for subsequent commands

If no exact match is found, check for partial or case-insensitive matches and confirm with the user before proceeding. If multiple matches exist, present the options and ask the user to choose.