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

Uploaded Source

Built Distribution

cvat_cli-2.22.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cvat_cli-2.22.0.tar.gz
  • Upload date:
  • Size: 10.1 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.22.0.tar.gz
Algorithm Hash digest
SHA256 213797b8dc63693919f0268b2542bf62fc1051fe9eb3b9888c5304acd6910768
MD5 1a5490fd28124b082a12ce418ec8fbe7
BLAKE2b-256 f3322209fd3736e1a69968da8c4af0c0092bf1dc3db17218b4e66a5721d9f8a7

See more details on using hashes here.

Provenance

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

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

Attestations:

File details

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

File metadata

  • Download URL: cvat_cli-2.22.0-py3-none-any.whl
  • Upload date:
  • Size: 10.6 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.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 32de9ad9ea305d11721bd12e6406dff19c7cac2f85886ad8c93be98d34a0b767
MD5 78159048a3617b14e856c005d410bb1e
BLAKE2b-256 7bd74e3d3e80823572bdd309b67788c4bfd91a6762400b401d3d69fef5896b12

See more details on using hashes here.

Provenance

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