# 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:
```console
$ 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:
```bash
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:
```bash
cvat-cli --auth admin:password \
--server-host cvat.my.server.com --server-port 30123 \
task ls
```
Raw data
{
"_id": null,
"home_page": "https://github.com/cvat-ai/cvat/",
"name": "cvat-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/95/c5/785dabb0a9db8ba8b359e597b6b4d892fb0a64f8b6b4295e8e8b92c59dd5/cvat_cli-2.48.0.tar.gz",
"platform": null,
"description": "# Command-line client for CVAT\n\nA simple command line interface for working with CVAT. At the moment it\nimplements a basic feature set but may serve as the starting point for a more\ncomprehensive CVAT administration tool in the future.\n\nThe following subcommands are supported:\n\n- Projects:\n - `create` - create a new project\n - `delete` - delete projects\n - `ls` - list all projects\n\n- Tasks:\n - `create` - create a new task\n - `create-from-backup` - create a task from a backup file\n - `delete` - delete tasks\n - `ls` - list all tasks\n - `frames` - download frames from a task\n - `export-dataset` - export a task as a dataset\n - `import-dataset` - import annotations into a task from a dataset\n - `backup` - back up a task\n - `auto-annotate` - automatically annotate a task using a local function\n\n- Functions (Enterprise/Cloud only):\n - `create-native` - create a function that can be powered by an agent\n - `delete` - delete a function\n - `run-agent` - process requests for a native function\n\n## Installation\n\n`pip install cvat-cli`\n\n## Usage\n\nThe general form of a CLI command is:\n\n```console\n$ cvat-cli <common options> <resource> <action> <options>\n```\n\nwhere:\n\n- `<common options>` are options shared between all subcommands;\n- `<resource>` is a CVAT resource, such as `task`;\n- `<action>` is the action to do with the resource, such as `create`;\n- `<options>` is any options specific to a particular resource and action.\n\nYou can list available subcommands and options using the `--help` option:\n\n```\n$ cvat-cli --help # get help on available common options and resources\n$ cvat-cli <resource> --help # get help on actions for the given resource\n$ cvat-cli <resource> <action> --help # get help on action-specific options\n```\n\n## Examples\n\nCreate a task with local images:\n\n```bash\ncvat-cli --auth user task create\n --labels '[{\"name\": \"car\"}, {\"name\": \"person\"}]'\n \"test_task\"\n \"local\"\n \"image1.jpg\" \"image2.jpg\"\n```\n\nList tasks on a custom server with auth:\n\n```bash\ncvat-cli --auth admin:password \\\n --server-host cvat.my.server.com --server-port 30123 \\\n task ls\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Command-line client for CVAT",
"version": "2.48.0",
"project_urls": {
"Homepage": "https://github.com/cvat-ai/cvat/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "beb2739409465dcbdc365c7ca449926de0207350875251c87c8e1b21039732d2",
"md5": "e7e7abd501a349ca4cbc1d4ed97f9cfc",
"sha256": "61682a675e8c2fb5881630e7a9cda69e48a743292e8ea81bdb851856b594daf0"
},
"downloads": -1,
"filename": "cvat_cli-2.48.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7e7abd501a349ca4cbc1d4ed97f9cfc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 25766,
"upload_time": "2025-10-27T18:44:43",
"upload_time_iso_8601": "2025-10-27T18:44:43.166360Z",
"url": "https://files.pythonhosted.org/packages/be/b2/739409465dcbdc365c7ca449926de0207350875251c87c8e1b21039732d2/cvat_cli-2.48.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "95c5785dabb0a9db8ba8b359e597b6b4d892fb0a64f8b6b4295e8e8b92c59dd5",
"md5": "54222ec8e6339e8bc9c07e5c91b61e72",
"sha256": "b2698faca0ee2a33fe4c50d7f723597ffbd37637ea45cb9c9265fa97b9f4ac2c"
},
"downloads": -1,
"filename": "cvat_cli-2.48.0.tar.gz",
"has_sig": false,
"md5_digest": "54222ec8e6339e8bc9c07e5c91b61e72",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 22817,
"upload_time": "2025-10-27T18:44:46",
"upload_time_iso_8601": "2025-10-27T18:44:46.694387Z",
"url": "https://files.pythonhosted.org/packages/95/c5/785dabb0a9db8ba8b359e597b6b4d892fb0a64f8b6b4295e8e8b92c59dd5/cvat_cli-2.48.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-27 18:44:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cvat-ai",
"github_project": "cvat",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "cvat-cli"
}
JSON
