You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Maxim Zhiltsov 1dcba5a843
Align server api, sdk and cli versions to 2.1.0 (#4913)
3 years ago
..
requirements Align server api, sdk and cli versions to 2.1.0 (#4913) 3 years ago
src/cvat_cli Align server api, sdk and cli versions to 2.1.0 (#4913) 3 years ago
.gitignore Add 2nd layer of SDK (#19) 4 years ago
MANIFEST.in CLI package (#59) 4 years ago
README.md SDK alpha 1 release (#4903) 3 years ago
developer_guide.md CLI package (#59) 4 years ago
pyproject.toml Add 2nd layer of SDK (#19) 4 years ago
setup.py Changed links openvinotoolkit > cvat-ai (#3) 4 years ago

README.md

Command-line client for CVAT

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] [--https] [--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)
  --https               force https connection (default: try to detect automatically)
  --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