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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file qbraid_cli-0.14.0.tar.gz.
File metadata
- Download URL: qbraid_cli-0.14.0.tar.gz
- Upload date:
- Size: 124.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
54ac4a01da318a7f0d4f3cc285aa7e3f3806a060f194edf49be9befacd0c10f2
|
|
| MD5 |
27c1ba48ebbd3e58fd0219208e6c3378
|
|
| BLAKE2b-256 |
efb76954d93b6923dcd6af2b71bb8dbbe2e7678b244f6807de9d0d57102abcf2
|
File details
Details for the file qbraid_cli-0.14.0-py3-none-any.whl.
File metadata
- Download URL: qbraid_cli-0.14.0-py3-none-any.whl
- Upload date:
- Size: 138.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7945880d94f80bab986661da47c838ed1ce56b9b171f8fdb913d941d3c71cea9
|
|
| MD5 |
d8c177eacd48d1f14006652369219329
|
|
| BLAKE2b-256 |
3049d7ba64ebb8a845e0d7a65799ac81987763c726c7700f4fafbb1952887299
|
