qbraid-cli 0.13.0a1

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

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

Resources:

• User Guide
• API Reference

Getting Started

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

• Launch qBraid Lab →
• Make an account →

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:

1. Create a qBraid account or log in to your existing account by visiting account.qbraid.com
2. Copy your API Key token from the left side of your account page:
3. 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