Projects

The ax projects commands are currently in BETA. The API may change without notice. A one-time warning is emitted on first use.

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]

Option	Description
`--name`, `-n`	Case-insensitive substring filter on project name
`--space`, `-s`	Space name or ID
`--limit`, `-l`	Maximum number of projects to return (default: 15)
`--cursor`, `-c`	Pagination cursor for the next page
`--output`, `-o`	Output format (`table`, `json`, `csv`, `parquet`) or file path
`--verbose`, `-v`	Enable verbose logs

Example:

ax projects list --space sp_abc123

Create a new project.

ax projects create --name <name> --space <id> [--output <fmt>] [--verbose]

Option	Description
`--name`, `-n`	Name for the new project (required; prompted if omitted)
`--space`, `-s`	Space name or ID to create the project in (required; prompted if omitted)
`--output`, `-o`	Output format (`table`, `json`, `csv`, `parquet`) or file path
`--verbose`, `-v`	Enable verbose logs

Example:

ax projects create --name "my-project" --space sp_abc123

Retrieve a project by name or ID.

ax projects get <name-or-id> [--space <id>] [--output <fmt>] [--verbose]

Option	Description
`--space`, `-s`	Space name or ID (required when using a project name instead of ID)
`--output`, `-o`	Output format (`table`, `json`, `csv`, `parquet`) or file path
`--verbose`, `-v`	Enable verbose logs

Examples:

ax projects get proj_abc123
ax projects get my-project --space my-space

Rename a project.

ax projects update <name-or-id> --name <new-name> [--space <id>] [--output <fmt>] [--verbose]

Option	Description
`--name`, `-n`	New name for the project (required; prompted if omitted)
`--space`, `-s`	Space name or ID (required when using a project name instead of ID)
`--output`, `-o`	Output format (`table`, `json`, `csv`, `parquet`) or file path
`--verbose`, `-v`	Enable verbose logs

Examples:

ax projects update proj_abc123 --name "renamed-project"
ax projects update my-project --space my-space --name "renamed-project"

Delete a project.

ax projects delete <name-or-id> [--space <id>] [--force] [--verbose]

Option	Description
`--space`, `-s`	Space name or ID (required when using a project name instead of ID)
`--force`, `-f`	Skip the confirmation prompt
`--verbose`, `-v`	Enable verbose logs

Examples:

ax projects delete proj_abc123
ax projects delete my-project --space my-space --force