cvat/cvat-cli

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:

  • create - create a new project
  • delete - delete projects
  • 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