Skip to main content
The ax projects commands are currently in BETA. The API may change without notice. A one-time warning is emitted on first use. The update command is in ALPHA.
The ax projects commands let you create, retrieve, and manage projects on the Arize platform.

ax projects list

List all projects in a space.
ax projects list [--space <id>] [--name <filter>] [--limit <n>] [--cursor <cursor>] [--output <fmt>] [--verbose]
OptionDescription
--name, -nCase-insensitive substring filter on project name
--space, -sSpace name or ID
--limit, -lMaximum number of projects to return (default: 15)
--cursor, -cPagination cursor for the next page
--output, -oOutput format (table, json, csv, parquet) or file path
--verbose, -vEnable verbose logs
Example:
ax projects list --space sp_abc123

ax projects create

Create a new project.
ax projects create --name <name> --space <id> [--output <fmt>] [--verbose]
OptionDescription
--name, -nName for the new project (required; prompted if omitted)
--space, -sSpace name or ID to create the project in (required; prompted if omitted)
--output, -oOutput format (table, json, csv, parquet) or file path
--verbose, -vEnable verbose logs
Example:
ax projects create --name "my-project" --space sp_abc123

ax projects get

Retrieve a project by name or ID.
ax projects get <name-or-id> [--space <id>] [--output <fmt>] [--verbose]
OptionDescription
--space, -sSpace name or ID (required when using a project name instead of ID)
--output, -oOutput format (table, json, csv, parquet) or file path
--verbose, -vEnable verbose logs
Examples:
ax projects get proj_abc123
ax projects get my-project --space my-space

ax projects update

Rename a project.
ax projects update <name-or-id> --name <new-name> [--space <id>] [--output <fmt>] [--verbose]
OptionDescription
--name, -nNew name for the project (required; prompted if omitted)
--space, -sSpace name or ID (required when using a project name instead of ID)
--output, -oOutput format (table, json, csv, parquet) or file path
--verbose, -vEnable verbose logs
Examples:
ax projects update proj_abc123 --name "renamed-project"
ax projects update my-project --space my-space --name "renamed-project"

ax projects delete

Delete a project.
ax projects delete <name-or-id> [--space <id>] [--force] [--verbose]
OptionDescription
--space, -sSpace name or ID (required when using a project name instead of ID)
--force, -fSkip the confirmation prompt
--verbose, -vEnable verbose logs
Examples:
ax projects delete proj_abc123
ax projects delete my-project --space my-space --force