> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/cvat-ai/cvat/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install and verify the CVAT CLI tool

The CVAT CLI (Command-Line Interface) is a Python-based tool that allows you to interact with CVAT from your terminal. It provides commands for managing projects, tasks, datasets, and more.

## Requirements

Before installing CVAT CLI, ensure you have:

* **Python 3.10 or higher**
* **pip** (Python package installer)
* Access to a CVAT server (local or remote)

## Installation

Install the CVAT CLI using pip:

```bash theme={null}
pip install cvat-cli
```

This will install:

* `cvat-cli` - The CLI tool
* `cvat-sdk` - The underlying Python SDK
* Required dependencies (attrs, Pillow)

### Install from Source

To install the latest development version from source:

```bash theme={null}
git clone https://github.com/cvat-ai/cvat.git
cd cvat/cvat-cli
pip install -e .
```

## Verifying Installation

After installation, verify that the CLI is properly installed:

```bash theme={null}
cvat-cli --version
```

This should display the installed version number.

### Check Available Commands

To see all available commands and options:

```bash theme={null}
cvat-cli --help
```

To get help on a specific resource (e.g., tasks):

```bash theme={null}
cvat-cli task --help
```

To get help on a specific action:

```bash theme={null}
cvat-cli task create --help
```

## Command Structure

All CVAT CLI commands follow this general pattern:

```bash theme={null}
cvat-cli <common options> <resource> <action> <options>
```

Where:

* `<common options>` - Global options like authentication and server settings
* `<resource>` - The CVAT resource (e.g., `task`, `project`)
* `<action>` - The operation to perform (e.g., `create`, `ls`, `delete`)
* `<options>` - Action-specific options and arguments

## Upgrading

To upgrade to the latest version:

```bash theme={null}
pip install --upgrade cvat-cli
```

## Uninstalling

To remove the CVAT CLI:

```bash theme={null}
pip uninstall cvat-cli
```

## Troubleshooting

### Command Not Found

If `cvat-cli` is not recognized after installation:

1. Ensure pip's binary directory is in your PATH
2. Try using `python -m cvat_cli` instead
3. Restart your terminal session

### SSL Certificate Errors

If you encounter SSL certificate verification errors when connecting to a server:

```bash theme={null}
cvat-cli --insecure <resource> <action>
```

<Warning>
  Only use `--insecure` with trusted servers, as it disables SSL certificate verification.
</Warning>

### Version Conflicts

If you have dependency conflicts, consider using a virtual environment:

```bash theme={null}
python -m venv cvat-env
source cvat-env/bin/activate  # On Windows: cvat-env\Scripts\activate
pip install cvat-cli
```

## Next Steps

Now that you have installed the CLI, learn how to:

* [Configure authentication and server settings](/cli/configuration)
* [Work with projects](/cli/project-commands)
* [Manage tasks](/cli/task-commands)
* [See complete examples](/cli/examples)