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.
68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
# 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
|
|
|
|
```bash
|
|
$ 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:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
cvat-cli --auth admin:password \
|
|
--server-host cvat.my.server.com --server-port 30123 \
|
|
ls
|
|
```
|