qbraid-cli

Command Line Interface for interacting with all parts of the qBraid platform.

Resources:

Getting Started

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

For help, see qBraid Lab User Guide: Getting Started.

You can also install the qBraid-CLI from PyPI with:

pip install qbraid-cli

To manage qBraid environments using the CLI, you must also install the envs extra:

pip install 'qbraid-cli[envs]'

Local configuration

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

Create a qBraid account or log in to your existing account by visiting account.qbraid.com
Copy your API Key token from the left side of your account page:
Save your API key from step 2 in local configuration file ~/.qbraid/qbraidrc using:

$ qbraid configure

For more on API keys, see documentation.

Basic Commands

$ 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/api-reference/qbraid

A qBraid CLI command has the following structure:

$ qbraid <command> <subcommand> [options and parameters]

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

$ qbraid envs list

To view help documentation, use one of the following:

$ qbraid --help
$ qbraid <command> --help
$ qbraid <command> <subcommand> --help

To get the version of the qBraid CLI:

$ qbraid --version

Magic Commands

You can also access the CLI directly from within Notebooks using IPython magic commands. First, configure the qBraid magic commands extension using:

$ qbraid configure magic

The above command can also be executed from within a Jupyter notebook using the ! operator. Then, from within a notebook cell, load the qBraid magic IPython extension using:

In [1]: %load_ext qbraid_magic

Now you can continue to use the qBraid-CLI as normal from within your Jupyter notebook using the magic % operator, e.g.

In [2]: %qbraid jobs list

Metadata

Release files for qbraid-cli 0.16.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qbraid-cli 0.16.1
File	Size	Uploaded
qbraid_cli-0.16.1.tar.gz	132.2 kB	Sep 19, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for qbraid-cli 0.16.1
File	Interpreter	ABI	Platform	Reset
qbraid_cli-0.16.1-py3-none-any.whl 145.9 kB Sep 19, 2026	Python 3	none	any	Details

Total release size: 278.1 kB

Release files / qbraid_cli-0.16.1.tar.gz

Download URL	qbraid_cli-0.16.1.tar.gz
Size	132.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`e78c2f4fe385adbdcaecb6eed8acb3d006cacaf1d00b260a6fa00d61315fb185`
BLAKE2b-256 checksum How to use checksums	`e4d00e8624c206bc0761b1717ec1407fdf2871cfb6377b35e2095e9d3dbf18fc`
Upload date	Sep 19, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / qbraid_cli-0.16.1-py3-none-any.whl

Download URL	qbraid_cli-0.16.1-py3-none-any.whl
Size	145.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`fac44785d3d331d9bc26724eaa03bc5aed2838681f8d84d4c67dd2053bbf56af`
BLAKE2b-256 checksum How to use checksums	`f0994aaa3a9a9b0b325d064082bf1695ac144624858e645923e23334aeb8772c`
Upload date	Sep 19, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`