Metadata-Version: 2.1
Name: qbraid-cli
Version: 0.8.0.dev0
Summary: Command Line Interface for interacting with all parts of the qBraid platform.
Author-email: qBraid Development Team <contact@qbraid.com>
License: Proprietary
Project-URL: Homepage, https://www.qbraid.com/
Project-URL: Documentation, https://docs.qbraid.com/projects/cli/en/latest/cli/qbraid.html
Project-URL: Bug Tracker, https://github.com/qBraid/qBraid-Lab/issues
Project-URL: Discord, https://discord.gg/KugF6Cnncm
Project-URL: Launch on Lab, https://account.qbraid.com/?gitHubUrl=https://github.com/qBraid/qBraid-Lab.git
Keywords: qbraid,cli,quantum,cloud
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: typer[all]
Requires-Dist: rich
Requires-Dist: requests
Requires-Dist: jupyter_client
Requires-Dist: qbraid==0.5.1
Provides-Extra: jobs
Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx~=5.3.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme~=1.3.0; extra == "docs"
Requires-Dist: docutils~=0.18.1; extra == "docs"

<img width="full" alt="qbraid_cli" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid-cli-banner.png">

[![Documentation](https://img.shields.io/badge/Documentation-DF0982)](https://docs.qbraid.com/projects/cli/en/latest/cli/qbraid.html)
[![PyPI version](https://img.shields.io/pypi/v/qbraid-cli.svg?color=blue)](https://pypi.org/project/qbraid-cli/)
[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/qBraid/qBraid-Lab/issues)
[![Discord](https://img.shields.io/discord/771898982564626445.svg?color=pink)](https://discord.gg/TPBU2sa8Et)

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](https://docs.qbraid.com/projects/lab/en/latest/lab/overview.html) 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](https://docs.qbraid.com/projects/lab/en/latest/lab/notebooks.html) using the ``!`` operator. See [quantum jobs example](https://github.com/qBraid/qbraid-lab-demo/blob/045c7a8fbdcae66a7e64533dd9fe0e981dc02cf4/qbraid_lab/quantum_jobs/aws_quantum_jobs.ipynb).

- [Launch qBraid Lab &rarr;](https://lab.qbraid.com/)
- [Make an account &rarr;](https://account.qbraid.com/)

For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/projects/lab/en/latest/lab/getting_started.html).

## Basic Commands

```bash
$ 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:

```bash
$ qbraid <command> <subcommand> [options and parameters]
```

For example, to list installed environments, the command would be:

```bash
$ qbraid envs list
```

To view help documentation, use one of the following:

```bash
$ qbraid help
$ qbraid <command> help
$ qbraid <command> <subcommand> help
```

For example:

```bash
$ 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:

```bash
$ qbraid --version
```
