Skip to main content

Command-line client for CVAT

A simple command line interface for working with CVAT. At the moment it implements a basic feature set but may serve as the starting point for a more comprehensive CVAT administration tool in the future.

The following subcommands are supported:

  • Projects:

    • backup - back up a project
    • create - create a new project
    • create-from-backup - create a project from a backup file
    • delete - delete projects
    • export-dataset - export a project as a dataset
    • import-dataset - import annotations into a project from a dataset
    • ls - list all projects
  • Tasks:

    • create - create a new task
    • create-from-backup - create a task from a backup file
    • delete - delete tasks
    • ls - list all tasks
    • frames - download frames from a task
    • export-dataset - export a task as a dataset
    • import-dataset - import annotations into a task from a dataset
    • backup - back up a task
    • auto-annotate - automatically annotate a task using a local function
  • Functions (Enterprise/Cloud only):

    • create-native - create a function that can be powered by an agent
    • delete - delete a function
    • run-agent - process requests for a native function

Installation

pip install cvat-cli

Usage

The general form of a CLI command is:

$ cvat-cli <common options> <resource> <action> <options>

where:

  • <common options> are options shared between all subcommands;
  • <resource> is a CVAT resource, such as task;
  • <action> is the action to do with the resource, such as create;
  • <options> is any options specific to a particular resource and action.

You can list available subcommands and options using the --help option:

$ cvat-cli --help # get help on available common options and resources
$ cvat-cli <resource> --help # get help on actions for the given resource
$ cvat-cli <resource> <action> --help # get help on action-specific options

Examples

Create a task with local images:

cvat-cli --auth user task create
    --labels '[{"name": "car"}, {"name": "person"}]'
    "test_task"
    "local"
    "image1.jpg" "image2.jpg"

List tasks on a custom server with auth:

cvat-cli --auth admin:password \
    --server-host cvat.my.server.com --server-port 30123 \
    task ls

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cvat_cli-2.70.0.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cvat_cli-2.70.0-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file cvat_cli-2.70.0.tar.gz.

File metadata

  • Download URL: cvat_cli-2.70.0.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cvat_cli-2.70.0.tar.gz
Algorithm Hash digest
SHA256 e7d33f56da44c8443dda141a70c741168066f8bf48d0f1eb8cf61908d06ee3ed
MD5 bd6fea3677a0297ae62c92e3a42cdea0
BLAKE2b-256 92a8295304861916e52cbbf65598a7996b8ce2681f7f05676b902e09a0b36cf7

See more details on using hashes here.

Provenance

The following attestation bundles were made for cvat_cli-2.70.0.tar.gz:

Publisher: publish-artifacts.yml on cvat-ai/cvat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cvat_cli-2.70.0-py3-none-any.whl.

File metadata

  • Download URL: cvat_cli-2.70.0-py3-none-any.whl
  • Upload date:
  • Size: 28.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cvat_cli-2.70.0-py3-none-any.whl
Algorithm Hash digest
SHA256 275441c9500cbfb49cb12570a3cf486764473ded846354caa109303abb7f2007
MD5 6ed9474f228ca2ec4b698d0ffb26eee6
BLAKE2b-256 7f57e0246c40ace6e2165f4c35d676acc802c46f2cc20aa440a6e87acee06575

See more details on using hashes here.

Provenance

The following attestation bundles were made for cvat_cli-2.70.0-py3-none-any.whl:

Publisher: publish-artifacts.yml on cvat-ai/cvat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page