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/qbraidrcusing:
$ 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
Agent updates
Send yourself Slack or email updates and read Slack replies using existing qBraid credentials:
qbraid comms slack send "Tests passed" --json
qbraid comms email send --subject "Progress" --file report.txt --json
qbraid comms slack read --json
See communication commands for Slack connection, stdin input, pagination, and deployment requirements.
Release files for qbraid-cli 0.16.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qbraid_cli-0.16.5.tar.gz | 136.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qbraid_cli-0.16.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 287.3 kB
Release files / qbraid_cli-0.16.5.tar.gz
| Download URL | qbraid_cli-0.16.5.tar.gz |
|---|---|
| Size | 136.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5682fd3d5ad475bb03cdfd4b512fdc18dc3ea621329c0de2b68cf7b696ecab1a
|
|
BLAKE2b-256 checksum How to use checksums |
676f9c7dea73cc6ac89e68412e9f991db4112d49efd0e67633e56f9274dd92d1
|
| Upload date | |
|
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.5-py3-none-any.whl
| Download URL | qbraid_cli-0.16.5-py3-none-any.whl |
|---|---|
| Size | 150.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ccb5140eed9258f898aae08c882ef42420082329faa668defdfcbc227a328d5d
|
|
BLAKE2b-256 checksum How to use checksums |
e02247788772f52bebf06ee9286a87d84edd7bd3911103796b98b78fcdbcf85e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
