# 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/67/f0/6c5e84336d2e06a265482d3760c3d6ba07cdca4a04d9f6362c88a5dd1ca4/cvat_cli-2.25.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.25.0",
"project_urls": {
"Homepage": "https://github.com/cvat-ai/cvat/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3d7dab80840e4861c6e63f9adc3772aaf664abcbaa7e0c2ccffdf479b895dd1",
"md5": "0ddc3a7d774fc932fb9ba693ce3ef281",
"sha256": "a08ea59f6a5ed7cf98c51876c2f728f6c17c016d15c896e106cb61a194088bd7"
},
"downloads": -1,
"filename": "cvat_cli-2.25.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ddc3a7d774fc932fb9ba693ce3ef281",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18886,
"upload_time": "2025-01-09T18:18:17",
"upload_time_iso_8601": "2025-01-09T18:18:17.070692Z",
"url": "https://files.pythonhosted.org/packages/f3/d7/dab80840e4861c6e63f9adc3772aaf664abcbaa7e0c2ccffdf479b895dd1/cvat_cli-2.25.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67f06c5e84336d2e06a265482d3760c3d6ba07cdca4a04d9f6362c88a5dd1ca4",
"md5": "f891caec44da0158d3f9ae8f83f03fe8",
"sha256": "9ef1fef2846cb659711b1e2851e3ddef71b58a621fcf96bfce61162bf005299f"
},
"downloads": -1,
"filename": "cvat_cli-2.25.0.tar.gz",
"has_sig": false,
"md5_digest": "f891caec44da0158d3f9ae8f83f03fe8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15821,
"upload_time": "2025-01-09T18:18:22",
"upload_time_iso_8601": "2025-01-09T18:18:22.641826Z",
"url": "https://files.pythonhosted.org/packages/67/f0/6c5e84336d2e06a265482d3760c3d6ba07cdca4a04d9f6362c88a5dd1ca4/cvat_cli-2.25.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-09 18:18:22",
"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
