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.4
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.4.tar.gz | 136.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qbraid_cli-0.16.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 286.4 kB
Release files / qbraid_cli-0.16.4.tar.gz
| Download URL | qbraid_cli-0.16.4.tar.gz |
|---|---|
| Size | 136.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
81d57be19d054688f3be5a7a1d655cc304b7ad35337bce0cd85beb149b17dbf6
|
|
BLAKE2b-256 checksum How to use checksums |
bc993fcc6d284c9ce08b4612d0f0f899e3348e0c411a7575de9659fcc5c15b3f
|
| 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.4-py3-none-any.whl
| Download URL | qbraid_cli-0.16.4-py3-none-any.whl |
|---|---|
| Size | 150.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce89746264600ad39948d23345be983856394f075895ef119fee6cb2a1de1324
|
|
BLAKE2b-256 checksum How to use checksums |
f25984e5408937a5996ea0afc4743be8fa2e524c05b20e68e3eb0ed0e3a7b1ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
