qbraid-cli 0.8.0.dev0

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

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

The qBraid CLI is a specialized command-line interface tool designed exclusively for use within the qBraid Lab platform. It is not intended for local installations or use outside the qBraid Lab environment. This tool ensures seamless integration and optimized performance specifically tailored for qBraid Lab's unique cloud-based quantum computing ecosystem.

Getting Started

To use the qBraid CLI, login to qBraid (or create an account), launch Lab, and then open Terminal. You can also access the CLI directly from within Notebooks using the ! operator. See quantum jobs example.

• Launch qBraid Lab →
• Make an account →

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

Basic Commands

$ qbraid
-------------------------------
* Welcome to the qBraid CLI! *
-------------------------------

  - Use `qbraid -h` to see available commands.

  - Use `qbraid --version` to display the current version.

Reference Docs: https://docs.qbraid.com/projects/cli/en/latest/cli/qbraid.html

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

For example:

$ qbraid help

Group
    qbraid

Subgroups
    envs             : Manage qBraid environments.
    kernels          : Manage qBraid kernels.
    jobs             : Manage qBraid Quantum Jobs.

Arguments
    -V, --version    : Show version and exit

Global Arguments
    -h, --help       : Show this help message and exit.

Reference Docs: https://docs.qbraid.com/en/latest/cli/qbraid.html

To get the version of the qBraid CLI:

$ qbraid --version