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

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for mzhiltso from gravatar.com mzhiltso

Credits

Author: CVAT.ai Corporation

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.10

Classifiers

Report project as malware

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.71.0.tar.gz (24.5 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.71.0-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cvat_cli-2.71.0.tar.gz
Algorithm Hash digest
SHA256 48a26b35f47b923d77a68bcb30416f26d7786ff61504671638a2e7474bef1bec
MD5 244df8637729f894d15b746bb0191640
BLAKE2b-256 9bbbaa92bb0778f1b7c868abaf484ef83307b3a1f76db78af38782409dfaa2fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for cvat_cli-2.71.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.71.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for cvat_cli-2.71.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c3610f3fa02bf03310103394da360ec3273558f3dc33def45b6f8b680e512c5
MD5 2df03c17624670fa6eccff56504e0c7f
BLAKE2b-256 89244c82e3ba97cb4c7c6e3409631e0a6c469a5754fba95741ad36a71aa2e973

See more details on using hashes here.

Provenance

The following attestation bundles were made for cvat_cli-2.71.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

This release

2.71.0

2.70.0

2.69.0

2.68.0

2.67.0

2.66.0

2.65.0

2.64.0

2.63.0

2.62.0

2.61.0

2.60.0

2.59.1

2.59.0

2.58.0

2.57.0

2.56.1

2.56.0

2.55.0

2.54.0

2.53.0

2.52.0

2.51.0

2.50.0

2.49.0

2.48.1

2.48.0

2.47.0

2.46.1

2.46.0

2.45.0

2.44.3

2.44.2

2.44.1

2.44.0

2.43.0

2.42.0

2.41.0

2.40.1

2.40.0

2.39.0

2.38.0

2.37.0

2.36.0

2.35.0

2.34.0

2.33.0

2.32.0

2.31.0

2.30.0

2.29.0

2.28.0

2.27.0

2.26.1

2.26.0

2.25.0

2.24.0

2.23.1

2.23.0

2.22.0

2.21.3

2.21.2

2.21.1

2.21.0

2.20.0

2.19.1

2.19.0

2.18.0

2.17.0

2.16.3

2.16.2

2.16.1

2.16.0

2.15.0

2.14.4

2.14.3

2.14.2

2.14.1

2.14.0

2.13.0

2.12.1

2.12.0

2.11.3

2.11.2

2.11.1

2.11.0

2.10.3

2.10.2

2.10.1

2.10.0

2.9.2

2.9.1

2.9.0

2.8.2

2.8.1

2.8.0

2.7.6

2.7.2

2.7.1

2.7.0

2.6.2

2.6.1

2.6.0

2.5.2

2.5.0

2.4.7

2.4.6

2.4.5

2.4.4

2.4.0

2.3.0

2.1.0.post1

2.1.0

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