| Name | qbraid-cli JSON |
| Version |
0.10.1
JSON |
| download |
| home_page | None |
| Summary | Command Line Interface for interacting with all parts of the qBraid platform. |
| upload_time | 2025-02-20 23:55:49 |
| 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/cli/user-guide/overview)
[](https://pypi.org/project/qbraid-cli/)
[](https://pypi.org/project/qbraid-cli/)
[](https://pepy.tech/project/qbraid-cli)
[](https://github.com/qBraid/community/issues)
[](https://stackoverflow.com/questions/tagged/qbraid)
Command Line Interface for interacting with all parts of the qBraid platform.
The **qBraid CLI** is a versatile command-line interface tool designed for seamless interaction with qBraid cloud services and quantum software management tools. Initially exclusive to the [qBraid Lab](https://docs.qbraid.com/lab/user-guide/overview) platform, the CLI now supports local installations as well. This enhancement broadens access to features like [qBraid Quantum Jobs](https://docs.qbraid.com/cli/user-guide/quantum-jobs), enabling direct, pre-configured access to QPUs from IonQ, Oxford Quantum Circuits, QuEra, Rigetti, and IQM, as well as on-demand simulators from qBraid, AWS, IonQ, QuEra, and NEC. See [pricing](https://docs.qbraid.com/home/pricing) for more.
*Resources*:
- [User Guide](https://docs.qbraid.com/cli/user-guide/overview)
- [API Reference](https://docs.qbraid.com/cli/api-reference/qbraid)
## Getting Started
The qBraid-CLI comes pre-installed and pre-configured in qBraid Lab:
- [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/lab/user-guide/getting-started).
You can also install the qBraid-CLI from PyPI with:
```bash
pip install qbraid-cli
```
To manage qBraid [environments](https://docs.qbraid.com/lab/user-guide/environments) using the CLI, you must also install the `envs` extra:
```bash
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](https://account.qbraid.com/)
2. Copy your API Key token from the left side of
your [account page](https://account.qbraid.com/):
3. Save your API key from step 2 in local configuration file `~/.qbraid/qbraidrc` using:
```bash
$ qbraid configure
```
For more on API keys, see [documentation](https://docs.qbraid.com/home/account#api-keys).
## Basic Commands
```bash
$ 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/cli/api-reference/qbraid
```
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
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
account Manage qBraid account
admin CI/CD commands for qBraid maintainers.
configure Configure qBraid CLI options.
account Manage qBraid account.
chat Interact with qBraid AI chat service.
devices Manage qBraid quantum devices.
envs Manage qBraid environments.
files Manage qBraid cloud storage files.
jobs Manage qBraid quantum jobs.
kernels Manage qBraid kernels.
pip Run pip command in active qBraid environment.
```
To get the version of the qBraid CLI:
```bash
$ qbraid --version
```
## Magic Commands
You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/lab/user-guide/notebooks) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:
```bash
$ 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:
```python
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.
```python
In [2]: %qbraid chat -f code -p "Write a Qiskit bell circuit"
```
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/60/91/cfe409e06afb6324d5875fa79a5085711598673b0e5487805e30bf78fba0/qbraid_cli-0.10.1.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/cli/user-guide/overview)\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/community/issues)\n[](https://stackoverflow.com/questions/tagged/qbraid)\n\nCommand Line Interface for interacting with all parts of the qBraid platform.\n\nThe **qBraid CLI** is a versatile command-line interface tool designed for seamless interaction with qBraid cloud services and quantum software management tools. Initially exclusive to the [qBraid Lab](https://docs.qbraid.com/lab/user-guide/overview) platform, the CLI now supports local installations as well. This enhancement broadens access to features like [qBraid Quantum Jobs](https://docs.qbraid.com/cli/user-guide/quantum-jobs), enabling direct, pre-configured access to QPUs from IonQ, Oxford Quantum Circuits, QuEra, Rigetti, and IQM, as well as on-demand simulators from qBraid, AWS, IonQ, QuEra, and NEC. See [pricing](https://docs.qbraid.com/home/pricing) for more.\n\n*Resources*:\n- [User Guide](https://docs.qbraid.com/cli/user-guide/overview)\n- [API Reference](https://docs.qbraid.com/cli/api-reference/qbraid)\n\n## Getting Started\n\nThe qBraid-CLI comes pre-installed and pre-configured in qBraid Lab:\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/lab/user-guide/getting-started).\n\nYou can also install the qBraid-CLI from PyPI with:\n\n```bash\npip install qbraid-cli\n```\n\nTo manage qBraid [environments](https://docs.qbraid.com/lab/user-guide/environments) using the CLI, you must also install the `envs` extra:\n\n```bash\npip install 'qbraid-cli[envs]'\n```\n\n## Local configuration\n\nAfter installation, you must configure your account credentials to use the CLI locally:\n\n1. Create a qBraid account or log in to your existing account by visiting\n [account.qbraid.com](https://account.qbraid.com/)\n2. Copy your API Key token from the left side of\n your [account page](https://account.qbraid.com/):\n3. Save your API key from step 2 in local configuration file `~/.qbraid/qbraidrc` using:\n\n```bash\n$ qbraid configure\n```\n\nFor more on API keys, see [documentation](https://docs.qbraid.com/home/account#api-keys).\n\n## Basic Commands\n\n```bash\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/cli/api-reference/qbraid\n```\n\nA qBraid CLI command has the following structure:\n\n```bash\n$ qbraid <command> <subcommand> [options and parameters]\n```\n\nFor example, to list installed environments, the command would be:\n\n```bash\n$ qbraid envs list\n```\n\nTo view help documentation, use one of the following:\n\n```bash\n$ qbraid --help\n$ qbraid <command> --help\n$ qbraid <command> <subcommand> --help\n```\n\nFor example:\n\n```bash\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 account Manage qBraid account\n admin CI/CD commands for qBraid maintainers.\n configure Configure qBraid CLI options.\n account Manage qBraid account.\n chat Interact with qBraid AI chat service.\n devices Manage qBraid quantum devices.\n envs Manage qBraid environments.\n files Manage qBraid cloud storage files.\n jobs Manage qBraid quantum jobs.\n kernels Manage qBraid kernels.\n pip Run pip command in active qBraid environment.\n```\n\nTo get the version of the qBraid CLI:\n\n```bash\n$ qbraid --version\n```\n\n## Magic Commands\n\nYou can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/lab/user-guide/notebooks) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:\n\n```bash\n$ qbraid configure magic\n```\n\nThe 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:\n\n```python\nIn [1]: %load_ext qbraid_magic\n```\n\nNow you can continue to use the qBraid-CLI as normal from within your Jupyter notebook using the magic ``%`` operator, e.g.\n\n```python\nIn [2]: %qbraid chat -f code -p \"Write a Qiskit bell circuit\"\n```\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "Command Line Interface for interacting with all parts of the qBraid platform.",
"version": "0.10.1",
"project_urls": {
"Bug Tracker": "https://github.com/qBraid/community/issues",
"Discord": "https://discord.gg/KugF6Cnncm",
"Documentation": "https://docs.qbraid.com/cli/api-reference/qbraid",
"Homepage": "https://docs.qbraid.com/cli/user-guide/overview"
},
"split_keywords": [
"qbraid",
" cli",
" quantum",
" cloud"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "16b4e2d91ff530c70e64b247b892f9c622480cdea7ba2b0d75eee30bb5b0ac60",
"md5": "a165b2dc9a7cfd9281fae2d9243f53d2",
"sha256": "5d1a46f53df553c05799918b93b5fe45b16d46ae78568d659106c7f0ff0d7d73"
},
"downloads": -1,
"filename": "qbraid_cli-0.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a165b2dc9a7cfd9281fae2d9243f53d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 40921,
"upload_time": "2025-02-20T23:55:48",
"upload_time_iso_8601": "2025-02-20T23:55:48.094994Z",
"url": "https://files.pythonhosted.org/packages/16/b4/e2d91ff530c70e64b247b892f9c622480cdea7ba2b0d75eee30bb5b0ac60/qbraid_cli-0.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6091cfe409e06afb6324d5875fa79a5085711598673b0e5487805e30bf78fba0",
"md5": "8970cea30e347795582f8ce906b1b288",
"sha256": "cf2af478f73cd3cc61580a5ca729a998c8d776db28110964b20815b986d68a37"
},
"downloads": -1,
"filename": "qbraid_cli-0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "8970cea30e347795582f8ce906b1b288",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 247052,
"upload_time": "2025-02-20T23:55:49",
"upload_time_iso_8601": "2025-02-20T23:55:49.435582Z",
"url": "https://files.pythonhosted.org/packages/60/91/cfe409e06afb6324d5875fa79a5085711598673b0e5487805e30bf78fba0/qbraid_cli-0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-20 23:55:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qBraid",
"github_project": "community",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "qbraid-cli"
}
