| Name | qbraid-cli JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | Command Line Interface for interacting with all parts of the qBraid platform. |
| upload_time | 2024-04-24 01:27:44 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Proprietary |
| keywords |
qbraid
cli
quantum
cloud
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img width="full" alt="qbraid_cli" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid-cli-banner.png">
[](https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html)
[](https://pypi.org/project/qbraid-cli/)
[](https://pypi.org/project/qbraid-cli/)
[](https://pepy.tech/project/qbraid-cli)
[](https://github.com/qBraid/qBraid-Lab/issues)
[](https://discord.gg/KugF6Cnncm)
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 →](https://lab.qbraid.com/)
- [Make an account →](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
```shell
$ 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/projects/cli/en/stable/guide/overview.html
```
A qBraid CLI command has the following structure:
```shell
$ qbraid <command> <subcommand> [options and parameters]
```
For example, to list installed environments, the command would be:
```shell
$ qbraid envs list
```
To view help documentation, use one of the following:
```shell
$ qbraid --help
$ qbraid <command> --help
$ qbraid <command> <subcommand> --help
```
For example:
```shell
$ qbraid --help
Usage: qbraid [OPTIONS] COMMAND [ARGS]...
The qBraid CLI.
Options
--version Show the version and exit.
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or customize the installation.
--help Show this message and exit.
Commands
configure Configure qBraid CLI options.
credits Manage qBraid credits.
devices Manage qBraid quantum devices.
envs Manage qBraid environments.
jobs Manage qBraid quantum jobs.
kernels Manage qBraid kernels.
```
To get the version of the qBraid CLI:
```shell
$ qbraid --version
```
Raw data
{
"_id": null,
"home_page": null,
"name": "qbraid-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "qbraid, cli, quantum, cloud",
"author": null,
"author_email": "qBraid Development Team <contact@qbraid.com>",
"download_url": "https://files.pythonhosted.org/packages/85/b7/f1c37069bafecdde82eb4c916e7ae4e1d63f54fecd7ca3a6280d6a33c135/qbraid_cli-0.8.0.tar.gz",
"platform": null,
"description": "<img width=\"full\" alt=\"qbraid_cli\" src=\"https://qbraid-static.s3.amazonaws.com/logos/qbraid-cli-banner.png\">\n\n[](https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html)\n[](https://pypi.org/project/qbraid-cli/)\n[](https://pypi.org/project/qbraid-cli/)\n[](https://pepy.tech/project/qbraid-cli)\n[](https://github.com/qBraid/qBraid-Lab/issues)\n[](https://discord.gg/KugF6Cnncm)\n\nCommand Line Interface for interacting with all parts of the qBraid platform.\n\nThe **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.\n\n## Getting Started\n\nTo 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).\n\n- [Launch qBraid Lab →](https://lab.qbraid.com/)\n- [Make an account →](https://account.qbraid.com/)\n\nFor help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/projects/lab/en/latest/lab/getting_started.html).\n\n## Basic Commands\n\n```shell\n$ qbraid\n----------------------------------\n * Welcome to the qBraid CLI! * \n----------------------------------\n\n ____ _ _ \n __ _| __ ) _ __ __ _(_) __| | \n / _` | _ \\| '__/ _` | |/ _` | \n | (_| | |_) | | | (_| | | (_| | \n \\__,_|____/|_| \\__,_|_|\\__,_| \n |_| \n\n\n- Use 'qbraid --help' to see available commands.\n\n- Use 'qbraid --version' to see the current version.\n\nReference Docs: https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html\n```\n\nA qBraid CLI command has the following structure:\n\n```shell\n$ qbraid <command> <subcommand> [options and parameters]\n```\n\nFor example, to list installed environments, the command would be:\n\n```shell\n$ qbraid envs list\n```\n\nTo view help documentation, use one of the following:\n\n```shell\n$ qbraid --help\n$ qbraid <command> --help\n$ qbraid <command> <subcommand> --help\n```\n\nFor example:\n\n```shell\n$ qbraid --help\n\nUsage: qbraid [OPTIONS] COMMAND [ARGS]...\n\nThe qBraid CLI.\n\nOptions\n --version Show the version and exit.\n --install-completion Install completion for the current shell.\n --show-completion Show completion for the current shell, to copy it or customize the installation.\n --help Show this message and exit.\n\nCommands\n configure Configure qBraid CLI options.\n credits Manage qBraid credits.\n devices Manage qBraid quantum devices.\n envs Manage qBraid environments.\n jobs Manage qBraid quantum jobs.\n kernels Manage qBraid kernels.\n```\n\nTo get the version of the qBraid CLI:\n\n```shell\n$ qbraid --version\n```\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "Command Line Interface for interacting with all parts of the qBraid platform.",
"version": "0.8.0",
"project_urls": {
"Bug Tracker": "https://github.com/qBraid/qBraid-Lab/issues",
"Discord": "https://discord.gg/KugF6Cnncm",
"Documentation": "https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html",
"Homepage": "https://www.qbraid.com/",
"Launch on Lab": "https://account.qbraid.com/?gitHubUrl=https://github.com/qBraid/qBraid-Lab.git"
},
"split_keywords": [
"qbraid",
" cli",
" quantum",
" cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "744c16f390cf1db574d9f9153c30c45812ecc18cc7e33952ed742fe79f83335a",
"md5": "00c0400e2dcc2b2634b1c1409f0c04c1",
"sha256": "50992588af438eb86294b5ba8468b635189a5afaf46a9b2986cebb6e896241f3"
},
"downloads": -1,
"filename": "qbraid_cli-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00c0400e2dcc2b2634b1c1409f0c04c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 32560,
"upload_time": "2024-04-24T01:27:42",
"upload_time_iso_8601": "2024-04-24T01:27:42.073262Z",
"url": "https://files.pythonhosted.org/packages/74/4c/16f390cf1db574d9f9153c30c45812ecc18cc7e33952ed742fe79f83335a/qbraid_cli-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85b7f1c37069bafecdde82eb4c916e7ae4e1d63f54fecd7ca3a6280d6a33c135",
"md5": "2fafb04a066f85d2656d246c93849558",
"sha256": "7dceaf250ec0fc980cbdc4e564892b01789d2b9effee2036cd611d30cecb86c2"
},
"downloads": -1,
"filename": "qbraid_cli-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "2fafb04a066f85d2656d246c93849558",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 286259,
"upload_time": "2024-04-24T01:27:44",
"upload_time_iso_8601": "2024-04-24T01:27:44.140349Z",
"url": "https://files.pythonhosted.org/packages/85/b7/f1c37069bafecdde82eb4c916e7ae4e1d63f54fecd7ca3a6280d6a33c135/qbraid_cli-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 01:27:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qBraid",
"github_project": "qBraid-Lab",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qbraid-cli"
}
