cvat/utils/cli

Command line interface (CLI)

Description 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, 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)

Usage

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

Perform common operations related to CVAT tasks.

positional arguments:
  {create,delete,ls,frames,dump}

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

Examples

• List all tasks cli.py ls
• Create a task cli.py create "new task" --labels labels.json local file1.jpg file2.jpg
• Delete some tasks cli.py delete 100 101 102
• Dump annotations cli.py dump --format "CVAT XML 1.1 for images" 103 output.xml