CLI Commands Reference - Avala Python SDK

This page documents all available commands in the Avala CLI.

`configure`

Configure API credentials for the CLI.

avala configure

Interactively prompts for API key and base URL, then outputs shell export statements.

`datasets`

Manage datasets.

`datasets list`

List datasets with optional filters.

avala datasets list [OPTIONS]

Options:

--data-type TEXT — Filter by data type (image, video, lidar, mcap, splat)
--name TEXT — Filter by name (case-insensitive substring match)
--status TEXT — Filter by status (creating, created)
--visibility TEXT — Filter by visibility (private, public)
--limit INTEGER — Maximum number of results

`datasets get`

Get details for a specific dataset.

avala datasets get <uid>

`datasets create`

Create a new dataset.

avala datasets create [OPTIONS]

Required options:

--name TEXT — Display name for the dataset
--slug TEXT — URL-friendly identifier
--data-type CHOICE — Data type: image, video, lidar, mcap, or splat

Optional:

--is-sequence — Dataset contains sequences (flag)
--visibility CHOICE — private or public (default: private)
--create-metadata / --no-create-metadata — Create dataset metadata (default: true)
--provider-config TEXT — Provider config as JSON string
--owner TEXT — Dataset owner username or email

`projects`

Manage annotation projects.

`projects list`

List projects.

avala projects list [--limit INTEGER]

`projects get`

Get project details.

avala projects get <uid>

`tasks`

Manage tasks.

`tasks list`

List tasks.

avala tasks list [--limit INTEGER]

`tasks get`

Get task details.

avala tasks get <uid>

`exports`

Manage data exports.

`exports list`

List exports.

avala exports list [--limit INTEGER]

`exports get`

Get export details and download URL.

avala exports get <uid>

`exports create`

Create a new export.

avala exports create [OPTIONS]

Options:

--dataset TEXT — Dataset UID
--project TEXT — Project UID

`agents`

Manage agents.

`agents list`

List agents.

avala agents list [--limit INTEGER]

`agents get`

Get agent details.

avala agents get <uid>

`agents create`

Create a new agent.

avala agents create [OPTIONS]

Required options:

--name TEXT — Agent name

Optional:

--events TEXT — Comma-separated list of event types
--callback-url TEXT — Webhook callback URL (HTTPS)
--description TEXT — Agent description
--project TEXT — Project UID to scope the agent to
--task-types TEXT — Comma-separated list of task types

Returns the agent secret on creation — save it immediately.

`agents delete`

Delete an agent.

avala agents delete <uid>

Prompts for confirmation before deleting.

`agents executions`

List executions for an agent.

avala agents executions <uid> [--limit INTEGER]

`agents test`

Test an agent.

avala agents test <uid>

`storage-configs`

Manage cloud storage configurations.

`storage-configs list`

List storage configurations.

avala storage-configs list

`storage-configs create`

Create a new storage configuration.

avala storage-configs create [OPTIONS]

Required options:

--name TEXT — Configuration name
--provider CHOICE — Cloud provider: aws_s3 or gc_storage

AWS S3 options:

--s3-bucket-name TEXT
--s3-bucket-region TEXT
--s3-bucket-prefix TEXT
--s3-access-key-id TEXT
--s3-secret-access-key TEXT

Google Cloud Storage options:

--gc-bucket-name TEXT
--gc-prefix TEXT
--gc-auth-json TEXT — Auth JSON content

`storage-configs test`

Test connectivity for a storage configuration.

avala storage-configs test <uid>

`storage-configs delete`

Delete a storage configuration.

avala storage-configs delete <uid>

`inference-providers`

Manage inference providers.

`inference-providers list`

List inference providers.

avala inference-providers list [--limit INTEGER]

`inference-providers get`

Get provider details.

avala inference-providers get <uid>

`inference-providers create`

Create a new inference provider.

avala inference-providers create [OPTIONS]

Required options:

--name TEXT — Provider name
--provider-type CHOICE — Provider type: http or sagemaker
--config TEXT — Provider config as JSON string

Optional:

--description TEXT — Provider description
--project TEXT — Project UID to scope the provider to

`inference-providers delete`

Delete an inference provider.

avala inference-providers delete <uid>

`inference-providers test`

Test connectivity for an inference provider.

avala inference-providers test <uid>

`auto-label`

Manage auto-labeling jobs.

`auto-label list`

List auto-label jobs.

avala auto-label list [OPTIONS]

Options:

--project TEXT — Filter by project UID
--limit INTEGER — Maximum number of results

`auto-label get`

Get auto-label job details.

avala auto-label get <uid>

`auto-label create`

Create a new auto-label job.

avala auto-label create [OPTIONS]

Required options:

--project TEXT — Project UID

Optional:

--model-type CHOICE — Inference model: sam3 or yolo
--confidence-threshold FLOAT — Minimum confidence (0.0-1.0)
--labels TEXT — Comma-separated list of labels to filter
--dry-run — Run inference without saving results (flag)

`auto-label cancel`

Cancel an auto-label job.

avala auto-label cancel <uid>

`quality-targets`

Manage quality targets.

`quality-targets list`

List quality targets for a project.

avala quality-targets list --project <project-uid> [--limit INTEGER]

`quality-targets get`

Get quality target details.

avala quality-targets get --project <project-uid> <uid>

`quality-targets create`

Create a new quality target.

avala quality-targets create [OPTIONS]

Required options:

--project TEXT — Project UID
--name TEXT — Target name
--metric TEXT — Metric to monitor
--threshold FLOAT — Threshold value

Optional:

--operator TEXT — Comparison operator (gt, lt, gte, lte)
--severity CHOICE — Alert severity: warning or critical

`quality-targets delete`

Delete a quality target.

avala quality-targets delete --project <project-uid> <uid>

`quality-targets evaluate`

Evaluate all quality targets for a project.

avala quality-targets evaluate --project <project-uid>

`consensus`

Manage consensus scoring.

`consensus summary`

Get consensus summary for a project.

avala consensus summary --project <project-uid>

`consensus scores`

List consensus scores for a project.

avala consensus scores --project <project-uid> [--limit INTEGER]

`consensus compute`

Compute consensus scores for a project.

avala consensus compute --project <project-uid>

`consensus config`

Get or update consensus configuration.

avala consensus config --project <project-uid> [OPTIONS]

Options (all optional — omit to view current config):

--iou-threshold FLOAT — IoU threshold (0.0-1.0)
--min-agreement-ratio FLOAT — Minimum agreement ratio (0.0-1.0)
--min-annotations INTEGER — Minimum annotations required

`webhooks`

Manage webhooks.

`webhooks list`

List webhooks.

avala webhooks list [--limit INTEGER]

`webhooks get`

Get webhook details.

avala webhooks get <uid>

`webhooks create`

Create a new webhook.

avala webhooks create [OPTIONS]

Required options:

--target-url TEXT — Webhook target URL (HTTPS)
--events TEXT — Comma-separated list of event types

Optional:

--secret TEXT — HMAC signing secret (auto-generated if omitted)

Returns the webhook secret on creation — save it immediately.

`webhooks delete`

Delete a webhook.

avala webhooks delete <uid>

`webhooks test`

Test a webhook.

avala webhooks test <uid>

`webhooks deliveries`

List webhook deliveries.

avala webhooks deliveries [--limit INTEGER]

`fleet`

Fleet management commands.

`fleet devices`

Manage fleet devices.

`fleet devices list`

List devices.

avala fleet devices list [OPTIONS]

Options:

--status TEXT — Filter by status (online, offline, maintenance)
--type TEXT — Filter by device type
--limit INTEGER — Maximum number of results

`fleet devices get`

Get device details.

avala fleet devices get <uid>

`fleet devices register`

avala fleet devices register [OPTIONS]

Required options:

--name TEXT — Device name
--type TEXT — Device type

Optional:

--tags TEXT — Comma-separated tags
--firmware-version TEXT — Firmware version

Returns a device token — save it immediately.

`fleet devices update`

Update a device.

avala fleet devices update <uid> [OPTIONS]

Options:

--status TEXT — Device status
--name TEXT — Device name
--tags TEXT — Comma-separated tags

`fleet devices delete`

Delete a device.

avala fleet devices delete <uid>

`fleet recordings`

Manage fleet recordings.

`fleet recordings list`

List recordings.

avala fleet recordings list [OPTIONS]

Options:

--device TEXT — Filter by device UID
--status TEXT — Filter by status (uploading, processing, ready, error, archived)
--limit INTEGER — Maximum number of results

`fleet recordings get`

Get recording details.

avala fleet recordings get <uid>

`fleet events`

Manage fleet events.

`fleet events list`

List events.

avala fleet events list [OPTIONS]

Options:

--device TEXT — Filter by device UID
--recording TEXT — Filter by recording UID
--type TEXT — Filter by event type
--limit INTEGER — Maximum number of results

`fleet events get`

Get event details.

avala fleet events get <uid>

`fleet events create`

Create a new event.

avala fleet events create [OPTIONS]

Required options:

--recording TEXT — Recording UID
--device TEXT — Device UID
--type TEXT — Event type
--label TEXT — Event label
--timestamp TEXT — Event timestamp (ISO 8601)

Optional:

--severity TEXT — Severity (info, warning, error, critical)

`fleet rules`

Manage fleet rules.

`fleet rules list`

List rules.

avala fleet rules list [--limit INTEGER]

`fleet rules get`

Get rule details.

avala fleet rules get <uid>

`fleet rules create`

Create a new rule.

avala fleet rules create [OPTIONS]

Required options:

--name TEXT — Rule name
--condition-file PATH — JSON file containing rule condition, actions, and optional scope

Optional:

--enabled / --disabled — Enable or disable the rule (default: enabled)

`fleet rules update`

Update a rule.

avala fleet rules update <uid> [OPTIONS]

Options:

--name TEXT — Rule name
--enabled / --disabled — Enable or disable the rule

`fleet rules delete`

Delete a rule.

avala fleet rules delete <uid>

`fleet alerts`

Manage fleet alerts.

`fleet alerts list`

List alerts.

avala fleet alerts list [OPTIONS]

Options:

--status TEXT — Filter by status (open, acknowledged, resolved)
--severity TEXT — Filter by severity (info, warning, error, critical)
--limit INTEGER — Maximum number of results

`fleet alerts get`

Get alert details.

avala fleet alerts get <uid>

`fleet alerts acknowledge`

Acknowledge an alert.

avala fleet alerts acknowledge <uid>

`fleet alerts resolve`

Resolve an alert.

avala fleet alerts resolve <uid> [--note TEXT]

Options:

--note TEXT — Resolution note

Getting Started

Core Concepts

Guides

CLI Tool

​configure

​datasets

​datasets list

​datasets get

​datasets create

​projects

​projects list

​projects get

​tasks

​tasks list

​tasks get

​exports

​exports list

​exports get

​exports create

​agents

​agents list

​agents get

​agents create

​agents delete

​agents executions

​agents test

​storage-configs

​storage-configs list

​storage-configs create

​storage-configs test

​storage-configs delete

​inference-providers

​inference-providers list

​inference-providers get

​inference-providers create

​inference-providers delete

​inference-providers test

​auto-label

​auto-label list

​auto-label get

​auto-label create

​auto-label cancel

​quality-targets

​quality-targets list

​quality-targets get

​quality-targets create

​quality-targets delete

​quality-targets evaluate

​consensus

​consensus summary

​consensus scores

​consensus compute

​consensus config

​webhooks

​webhooks list

​webhooks get

​webhooks create

​webhooks delete

​webhooks test

​webhooks deliveries

​fleet

​fleet devices

​fleet devices list

​fleet devices get

​fleet devices register

​fleet devices update

​fleet devices delete

​fleet recordings

​fleet recordings list

​fleet recordings get

​fleet events

​fleet events list

​fleet events get

​fleet events create

​fleet rules

​fleet rules list

​fleet rules get

​fleet rules create

​fleet rules update

​fleet rules delete

`configure`

`datasets`

`datasets list`

`datasets get`

`datasets create`

`projects`

`projects list`

`projects get`

`tasks`

`tasks list`

`tasks get`

`exports`

`exports list`

`exports get`

`exports create`

`agents`

`agents list`

`agents get`

`agents create`

`agents delete`

`agents executions`

`agents test`

`storage-configs`

`storage-configs list`

`storage-configs create`

`storage-configs test`

`storage-configs delete`

`inference-providers`

`inference-providers list`

`inference-providers get`

`inference-providers create`

`inference-providers delete`

`inference-providers test`

`auto-label`

`auto-label list`

`auto-label get`

`auto-label create`

`auto-label cancel`

`quality-targets`

`quality-targets list`

`quality-targets get`

`quality-targets create`

`quality-targets delete`

`quality-targets evaluate`

`consensus`

`consensus summary`

`consensus scores`

`consensus compute`

`consensus config`

`webhooks`

`webhooks list`

`webhooks get`

`webhooks create`

`webhooks delete`

`webhooks test`

`webhooks deliveries`

`fleet`

`fleet devices`

`fleet devices list`

`fleet devices get`

`fleet devices register`

`fleet devices update`

`fleet devices delete`

`fleet recordings`

`fleet recordings list`

`fleet recordings get`

`fleet events`

`fleet events list`

`fleet events get`

`fleet events create`

`fleet rules`

`fleet rules list`

`fleet rules get`

`fleet rules create`

`fleet rules update`

`fleet rules delete`

`fleet alerts`

`fleet alerts list`

`fleet alerts get`

`fleet alerts acknowledge`