Skip to main content

Command-line client for CVAT

Project description

Command-line client for CVAT

A simple command line interface for working with CVAT tasks. 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.

Overview of functionality:

  • Create a new task (supports name, bug tracker, project, labels JSON, local/share/remote files)
  • Delete tasks (supports deleting a list of task IDs)
  • List all tasks (supports basic CSV or JSON output)
  • Download JPEG frames (supports a list of frame IDs)
  • Dump annotations (supports all formats via format string)
  • Upload annotations for a task in the specified format (e.g. 'YOLO ZIP 1.0')
  • Export and download a whole task
  • Import a task

Installation

pip install cvat-cli

Usage

$ cvat-cli --help

usage: cvat-cli [-h] [--version] [--auth USER:[PASS]]
  [--server-host SERVER_HOST] [--server-port SERVER_PORT] [--debug]
  {create,delete,ls,frames,dump,upload,export,import} ...

Perform common operations related to CVAT tasks.

positional arguments:
  {create,delete,ls,frames,dump,upload,export,import}

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --auth USER:[PASS]    defaults to the current user and supports the PASS
                        environment variable or password prompt
                        (default: current user)
  --server-host SERVER_HOST
                        host (default: localhost)
  --server-port SERVER_PORT
                        port (default: 8080)
  --debug               show debug output

Examples

Create a task with local images:

cvat-cli --auth user 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 \
    ls

Project details


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.21.3.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

cvat_cli-2.21.3-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cvat_cli-2.21.3.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for cvat_cli-2.21.3.tar.gz
Algorithm Hash digest
SHA256 313bcffe33bb2b28d6aa3a256dc555bb806076e228e0c0aeb355e8383e126c53
MD5 8854df472bc0198b4ec796ca4d3987cc
BLAKE2b-256 61d9b60227eef0b8843c6c88b4961a2ac964c711fb29c2f8514557aa9dec5ab9

See more details on using hashes here.

Provenance

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

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

Attestations:

File details

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

File metadata

  • Download URL: cvat_cli-2.21.3-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for cvat_cli-2.21.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c47b8bb61a05bf90594656a8a7a603592c3e088982a54ba28341af42e63fae39
MD5 513ebf04df0b41264e2348224453ae60
BLAKE2b-256 3af7bb460602acb5dda0ab18ccc09ee67e612caaf672b479547f178aec92430e

See more details on using hashes here.

Provenance

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

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

Attestations:

Supported by

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