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

# Overview

<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
  <img src="https://mintcdn.com/qbraidco/MWMLuPZDp_BcNo9C/cli/_static/cli_banner.png?fit=max&auto=format&n=MWMLuPZDp_BcNo9C&q=85&s=cfbe5e37bda2f531b10b7b515f2ba410" alt="qBraid-CLI" style={{ width: "200", height: "auto", margin: "0" }} width="3840" height="640" data-path="cli/_static/cli_banner.png" />
</div>

<div style={{ textAlign: "center", marginTop: "-8px" }}>
  *Universal command line interface for interacting with all parts of the qBraid
  platform.*
</div>

The **qBraid CLI** is a versatile command-line interface tool designed for seamless interaction
with qBraid cloud services and quantum software management tools.

## Getting Started

The qBraid-CLI comes pre-installed and pre-configured in qBraid Lab:

* [Launch qBraid Lab →](https://lab.qbraid.com/)
* [Make an account →](https://account.qbraid.com/)

For help, see qBraid Lab User Guide: [Getting Started](/v2/lab/user-guide/getting-started).

### Local Setup

If you prefer to use qBraid-CLI on your local machine, you can install it from PyPI with:

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

<Warning>
  qbraid-cli versions \<0.12 are *not* compatible with qBraid API V2. See [migration guide](/v2/api-reference/rest/migration).

  To ensure compatibility with the new platform, use **qbraid-cli** ≥ 0.12.0.
</Warning>

To manage qBraid [environments](/v2/lab/user-guide/environments) using the CLI, you must also install the `envs` extra:

```bash theme={null}
pip install 'qbraid-cli[envs]'
```

After installation, you must configure your account credentials to use the CLI locally:

1. Create a qBraid account or log in to your existing account by visiting
   [account.qbraid.com](https://account.qbraid.com/)
2. Navigate to **Account** > **API Keys** in the left-sidebar, and then click "Create API Key".
3. Save your API key from step 2 in local configuration file `~/.qbraid/qbraidrc` using:

```bash theme={null}
$ qbraid configure
```

**Important for Windows Users:**

If you encounter a warning like:

```bash theme={null}
WARNING: The script qbraid.exe is installed in 'C:\Users\<YourUsername>\AppData\Local\Packages\PythonSoftwareFoundation.Python.<version>\LocalCache\local-packages\Python<version>\Scripts' which is not on PATH.
```

You need to add the directory containing qbraid.exe to your system's PATH.

1. Copy the directory path provided in the warning.
2. Follow these steps:

* Open the Start Menu, search for "Environment Variables," and select "Edit the system environment variables."
* In the System Properties window, click the Environment Variables button.
* Under "User variables," locate the Path variable, click Edit, and add the copied directory.

3. Save the changes and restart your terminal.

## Basic Commands

```bash theme={null}
$ qbraid
----------------------------------
  * Welcome to the qBraid CLI! *
----------------------------------

        ____            _     _
   __ _| __ ) _ __ __ _(_) __| |
  / _` |  _ \| '__/ _` | |/ _` |
 | (_| | |_) | | | (_| | | (_| |
  \__,_|____/|_|  \__,_|_|\__,_|
     |_|


- Use 'qbraid --help' to see available commands.

- Use 'qbraid --version' to see the current version.

Reference Docs: https://docs.qbraid.com/v2/cli/user-guide/overview
```

A qBraid CLI command has the following structure:

```bash theme={null}
$ qbraid <command> <subcommand> [options and parameters]
```

For example, to list installed environments, the command would be:

```bash theme={null}
$ qbraid envs list
```

To view help documentation, use one of the following:

```bash theme={null}
$ qbraid --help
$ qbraid <command> --help
$ qbraid <command> <subcommand> --help
```

For example:

```bash theme={null}
$ qbraid --help

Usage: qbraid [OPTIONS] COMMAND [ARGS]...

The qBraid CLI.

Options
  --version                     Show the version and exit.
  --install-completion          Install completion for the current shell.
  --show-completion             Show completion for the current shell, to copy it or customize the installation.
  --help                        Show this message and exit.

Commands
  account                       Manage qBraid account
  admin                         CI/CD commands for qBraid maintainers.
  configure                     Configure qBraid CLI options.
  account                       Manage qBraid account.
  devices                       Manage qBraid quantum devices.
  envs                          Manage qBraid environments.
  jobs                          Manage qBraid quantum jobs.
  kernels                       Manage qBraid kernels.
  pip                           Run pip command in active qBraid environment.
```

To get the version of the qBraid CLI:

```bash theme={null}
$ qbraid --version
```