qbraid-cli 0.8.0.dev0__tar.gz → 0.8.0.dev3__tar.gz

qbraid-cli-0.8.0.dev3/.env.example

@@ -0,0 +1,3 @@
+QBRAID_API_KEY= # YOURAPIKEY
+QBRAID_ENVS_PATH= # default: ~/.qbraid/environments
+QBRAID_CONFIG_FILE= # default: ~/.qbraid/qbraidrc

qbraid-cli-0.8.0.dev3/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+<!-- Please link or tag any issues that is PR closes -->
+
+## Changes

qbraid-cli-0.8.0.dev3/.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+name: Build Docs
+
+on:
+  pull_request:
+    branches: ['main']
+  push:
+    branches: ['main']
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+        cache: pip
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools
+        python -m pip install -r docs/requirements.txt
+    - name: Build & install package
+      run: |
+        python -m build .
+        python -m pip install dist/*.whl
+    - name: Generate docs assets
+      run: |
+        python -c "import pathlib; pathlib.Path('docs/tree').mkdir(parents=True, exist_ok=True)"
+        python -c "import glob, os; [os.remove(f) for f in glob.glob('docs/tree/*.rst')]"
+        typer qbraid_cli.main utils docs --name=qbraid --output=docs/tree/qbraid.md
+        m2r docs/tree/qbraid.md
+        python -c "import os; os.remove('docs/tree/qbraid.md')"
+        python tools/split_rst.py docs/tree/qbraid.rst
+    - name: Build docs
+      run: |
+        sphinx-build -W -b html docs docs/build/html

qbraid-cli-0.8.0.dev3/.github/workflows/format.yml

@@ -0,0 +1,34 @@
+name: Formatting check
+
+on:
+  pull_request:
+      branches: ['main']
+  workflow_dispatch:
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install black isort pylint
+      - name: Check isort, black, pylint
+        run: |
+          black --check qbraid_cli tests tools
+          isort --check-only qbraid_cli tests tools
+          # if pylint qbraid_cli tests tools --disable=C0415,R0914,W0511 2>&1 | grep 'Your code has been rated at 10\.00/10' > /dev/null; then
+          #   echo "Perfect pylint score!"
+          # else
+          #   echo "Pylint score is not 10/10."
+          #   exit 1
+          # fi
+      - name: Check copyright headers
+        run: |
+          python tools/verify_headers.py qbraid_cli tests tools --skip qbraid_cli/_version.py

qbraid-cli-0.8.0.dev3/.github/workflows/main.yml

@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  pull_request:
+    branches: ['main']
+  push:
+    branches: ['main']
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.11']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - name: Upgrade pip and install build tools
+        run: |
+          pip install --upgrade pip
+          pip install setuptools wheel build
+      - name: Build the package
+        run: |
+          python -m build
+      - name: Upload built package
+        uses: actions/upload-artifact@v3
+        with:
+          name: built-package
+          path: dist/*.whl
+
+  test:
+    needs: build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - name: Download built package
+        uses: actions/download-artifact@v3
+        with:
+          name: built-package
+          path: dist
+      - name: Install package
+        run: |
+          if ($env:RUNNER_OS -eq "Windows") {
+            Get-ChildItem dist/*.whl | ForEach-Object { pip install $_.FullName }
+          } else {
+            pip install dist/*.whl
+          }
+        shell: pwsh
+      - name: Install testing dependencies
+        run: |
+          pip install pytest
+      - name: Run tests with pytest
+        run: |
+          pytest
+        env:
+          QBRAID_API_KEY: ${{ secrets.QBRAID_API_KEY }}

{qbraid-cli-0.8.0.dev0 → qbraid-cli-0.8.0.dev3}/.github/workflows/publish.yml

@@ -8,6 +8,7 @@ on:
 jobs:
   pypi-publish:
     name: Build dist & upload to PyPI
+    environment: publish
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

{qbraid-cli-0.8.0.dev0 → qbraid-cli-0.8.0.dev3}/.gitignore

@@ -28,6 +28,7 @@ MANIFEST
 
 # ignore autogenerated _version.py file
 qbraid_cli/_version.py
+docs/tree/*
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -160,4 +161,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

qbraid-cli-0.8.0.dev3/.readthedocs.yml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+  commands:
+    - pip install -r docs/requirements.txt
+    - python -m build .
+    - python -m pip install dist/*.whl
+    - mkdir -p docs/tree
+    - rm -f docs/tree/*.rst
+    - typer qbraid_cli.main utils docs --name=qbraid --output=docs/tree/qbraid.md
+    - m2r docs/tree/qbraid.md
+    - rm docs/tree/qbraid.md
+    - python tools/split_rst.py docs/tree/qbraid.rst
+    - sphinx-build -W -b html docs $READTHEDOCS_OUTPUT/html

qbraid-cli-0.8.0.dev3/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing
+
+Welcome! We're delighted that you're interested in contributing. Your help is essential for keeping the project great.
+
+## Getting Started
+
+Before you start working on a new feature or a fix, here's how you can contribute:
+
+1. **Fork the repository**: Visit the GitHub page of our project and use the "Fork" button to create a copy of the project in your own GitHub account.
+2. **Create a Development Branch**: After forking, clone the repository to your local machine and create a new branch for your development. Use a descriptive name for your branch, such as `feature-<feature-name>` or `bugfix-<bug-description>`.
+3. **Commit Your Changes**: Make your changes in your development branch and commit them. Be sure to write clear, concise commit messages.
+4. **Push to Your Fork**: Push your changes to your forked repository on GitHub.
+5. **Create a Pull Request**: Go to the original project repository and click on "Pull Requests", then click the "New Pull Request" button
+
+### Development install
+
+You can install the qBraid-CLI from source by cloning this repository and running a pip install command in the root directory:
+
+```bash
+git clone https://github.com/qBraid/qBraid-CLI.git
+cd qBraid-CLI
+pip install -e .
+```
+
+*Note*: The current CLI configuration assumes a Linux-based filesystem. However, our goal is to move towards a platform agnostic version soon.
+
+You can verify that the setup has been successful by checking the qBraid-CLI version with the following command:
+
+```bash
+qbraid --version
+```
+
+To view available `make` commands, run:
+
+```shell
+make help
+```
+
+## Testing
+
+Install test dependencies:
+
+```shell
+pip install pytest
+```
+
+And run tests:
+
+```shell
+pytest tests
+```
+
+You can also run tests with make:
+
+```shell
+make test
+```
+
+## Build docs
+
+To generate the API reference documentation locally, install the necessary requirements:
+
+```shell
+pip install -r docs/requirements.txt
+```
+
+And then run
+
+```shell
+make docs
+```
+
+Alternatively, you can generate command tree `.rst` files step-by-step:
+
+```shell
+mkdir docs/tree
+typer qbraid_cli.main utils docs --name=qbraid --output=docs/tree/qbraid.md
+m2r docs/tree/qbraid.md
+rm docs/tree/qbraid.md
+python tools/split_rst.py docs/tree/qbraid.rst
+```
+
+And then, build the docs:
+
+```shell
+sphinx-build -W -b html docs docs/build/html
+```
+
+You can view the generated documentation in your browser (on OS X) using:
+
+```shell
+open docs/build/html/index.html
+```
+
+## Code style
+
+For code style, our project uses a combination of [isort](https://github.com/PyCQA/isort), [pylint](https://github.com/pylint-dev/pylint),
+and [black](https://github.com/psf/black). Specific configurations for these tools should be added to [`pyproject.toml`](pyproject.toml).
+
+Install linters:
+
+```shell
+pip install black isort pylint
+```
+
+Run the following and make changes as needed to satisfy format checks:
+
+```shell
+black qbraid_cli tests tools
+isort qbraid_cli tests tools
+pylint qbraid_cli tests tools
+```

{qbraid-cli-0.8.0.dev0 → qbraid-cli-0.8.0.dev3}/MANIFEST.IN

@@ -1,4 +1,5 @@
 include *.txt *.md
 recursive-include docs *.txt *.rst *.py *.png *.ico
-recursive-include src *.py *.sh
-prune docs/build/
+recursive-include qbraid_cli *.py
+prune docs/build/
+prune docs/cli/

qbraid-cli-0.8.0.dev3/Makefile

@@ -0,0 +1,52 @@
+.PHONY: help docs clean build check_dependencies
+
+DOCS_DIR := docs
+BUILD_DIR := $(DOCS_DIR)/build
+TREE_DIR := $(DOCS_DIR)/tree
+DIST_DIR := dist
+SRC_DIR := qbraid_cli
+TOOLS_DIR := tools
+TESTS_DIR := tests
+
+.DEFAULT_GOAL := help
+
+help: ## Display this help message
+	@echo "Available commands:"
+	@echo
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-30s\033[0m %s\n", $$1, $$2}'
+	@echo
+
+docs: check_dependencies_docs check_build_version ## Generate documentation
+	@python -c "import pathlib; pathlib.Path('$(TREE_DIR)').mkdir(parents=True, exist_ok=True)"
+	@python -c "import glob, os; [os.remove(f) for f in glob.glob('$(TREE_DIR)/*.rst')]"
+	@typer qbraid_cli.main utils docs --name=qbraid --output=$(TREE_DIR)/qbraid.md
+	@m2r $(TREE_DIR)/qbraid.md
+	@python -c "import os; os.remove('$(TREE_DIR)/qbraid.md')"
+	@python $(TOOLS_DIR)/split_rst.py $(TREE_DIR)/qbraid.rst
+	@sphinx-build -W -b html $(DOCS_DIR) $(BUILD_DIR)
+
+test: check_dependencies_test ## Run tests with pytest
+	@python -m pytest $(TESTS_DIR)
+
+clean: ## Clean up generated docs and build artifacts
+	@python -c "import shutil; shutil.rmtree('$(BUILD_DIR)', ignore_errors=True)"
+	@python -c "import shutil; shutil.rmtree('$(TREE_DIR)', ignore_errors=True)"
+	@python -c "import shutil; shutil.rmtree('$(DIST_DIR)', ignore_errors=True)"
+	@python -c "import os; os.remove('$(SRC_DIR)/_version.py') if os.path.exists('$(SRC_DIR)/_version.py') else None"
+
+build: check_dependencies_build ## Build the package
+	@python -m build .
+
+check_build_version:
+	@python -c "import os; assert os.path.exists('$(SRC_DIR)/_version.py'), 'Error: $(SRC_DIR)/_version.py does not exist. Please \'make build\' before proceeding.'"
+
+check_dependencies_docs:
+	@command -v typer >/dev/null 2>&1 || { echo >&2 "Error: Python 'typer-cli' module is not installed. Please install it to proceed."; exit 1; }
+	@command -v m2r >/dev/null 2>&1 || { echo >&2 "Error: Python 'm2r' module is not installed. Please install it to proceed."; exit 1; }
+	@command -v sphinx-build >/dev/null 2>&1 || { echo >&2 "Error: Python 'sphinx' module is not installed. Please install it to proceed."; exit 1; }
+
+check_dependencies_test:
+	@python -c "import pytest" 2>/dev/null || { echo >&2 "Error: Python 'pytest' module is not installed. Please install it to proceed."; exit 1; }
+
+check_dependencies_build:
+	@python -c "import build" 2>/dev/null || { echo >&2 "Error: Python 'build' module is not installed. Please install it to proceed."; exit 1; }

{qbraid-cli-0.8.0.dev0/qbraid_cli.egg-info → qbraid-cli-0.8.0.dev3}/PKG-INFO

@@ -1,20 +1,22 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.0.dev0
+Version: 0.8.0.dev3
 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: Documentation, https://docs.qbraid.com/projects/cli/en/stable/guide/overview.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: License :: Other/Proprietary License
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -24,28 +26,32 @@ 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
+Requires-Dist: typer>=0.12.1
+Requires-Dist: rich>=10.11.0
+Requires-Dist: jupyter_client<9.0.0,>=7.0.0
+Requires-Dist: qbraid-core>=0.1.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"
+Requires-Dist: pytest; 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"
+Requires-Dist: sphinx~=7.2.6; extra == "docs"
+Requires-Dist: sphinx-rtd-theme<2.1,>=1.3; extra == "docs"
+Requires-Dist: docutils<0.21; extra == "docs"
+Requires-Dist: toml; extra == "docs"
+Requires-Dist: build; 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)
+[![Documentation](https://img.shields.io/badge/Documentation-DF0982)](https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html)
 [![PyPI version](https://img.shields.io/pypi/v/qbraid-cli.svg?color=blue)](https://pypi.org/project/qbraid-cli/)
+[![Python verions](https://img.shields.io/pypi/pyversions/qbraid-cli.svg?color=blue)](https://pypi.org/project/qbraid-cli/)
+[![Downloads](https://static.pepy.tech/badge/qbraid-cli)](https://pepy.tech/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)
+[![Discord](https://img.shields.io/discord/771898982564626445.svg?color=pink)](https://discord.gg/KugF6Cnncm)
 
 Command Line Interface for interacting with all parts of the qBraid platform.
 
@@ -62,63 +68,73 @@ For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/p
 
 ## Basic Commands
 
-```bash
+```shell
 $ qbraid
--------------------------------
-* Welcome to the qBraid CLI! *
--------------------------------
+----------------------------------
+  * Welcome to the qBraid CLI! * 
+----------------------------------
+
+        ____            _     _  
+   __ _| __ ) _ __ __ _(_) __| | 
+  / _` |  _ \| '__/ _` | |/ _` | 
+ | (_| | |_) | | | (_| | | (_| | 
+  \__,_|____/|_|  \__,_|_|\__,_| 
+     |_|                         
 
-  - Use `qbraid -h` to see available commands.
 
-  - Use `qbraid --version` to display the current version.
+- Use 'qbraid --help' to see available commands.
 
-Reference Docs: https://docs.qbraid.com/projects/cli/en/latest/cli/qbraid.html
+- 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:
 
-```bash
+```shell
 $ qbraid <command> <subcommand> [options and parameters]
 ```
 
 For example, to list installed environments, the command would be:
 
-```bash
+```shell
 $ qbraid envs list
 ```
 
 To view help documentation, use one of the following:
 
-```bash
-$ qbraid help
-$ qbraid <command> help
-$ qbraid <command> <subcommand> help
+```shell
+$ qbraid --help
+$ qbraid <command> --help
+$ qbraid <command> <subcommand> --help
 ```
 
 For example:
 
-```bash
-$ qbraid help
-
-Group
-    qbraid
+```shell
+$ qbraid --help
 
-Subgroups
-    envs             : Manage qBraid environments.
-    kernels          : Manage qBraid kernels.
-    jobs             : Manage qBraid Quantum Jobs.
+Usage: qbraid [OPTIONS] COMMAND [ARGS]...
 
-Arguments
-    -V, --version    : Show version and exit
+The qBraid CLI.
 
-Global Arguments
-    -h, --help       : Show this help message and exit.
+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.
 
-Reference Docs: https://docs.qbraid.com/en/latest/cli/qbraid.html
+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:
 
-```bash
+```shell
 $ qbraid --version
 ```

{qbraid-cli-0.8.0.dev0 → qbraid-cli-0.8.0.dev3}/README.md

@@ -1,9 +1,11 @@
 <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)
+[![Documentation](https://img.shields.io/badge/Documentation-DF0982)](https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html)
 [![PyPI version](https://img.shields.io/pypi/v/qbraid-cli.svg?color=blue)](https://pypi.org/project/qbraid-cli/)
+[![Python verions](https://img.shields.io/pypi/pyversions/qbraid-cli.svg?color=blue)](https://pypi.org/project/qbraid-cli/)
+[![Downloads](https://static.pepy.tech/badge/qbraid-cli)](https://pepy.tech/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)
+[![Discord](https://img.shields.io/discord/771898982564626445.svg?color=pink)](https://discord.gg/KugF6Cnncm)
 
 Command Line Interface for interacting with all parts of the qBraid platform.
 
@@ -20,63 +22,73 @@ For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/p
 
 ## Basic Commands
 
-```bash
+```shell
 $ qbraid
--------------------------------
-* Welcome to the qBraid CLI! *
--------------------------------
+----------------------------------
+  * 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
+- 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:
 
-```bash
+```shell
 $ qbraid <command> <subcommand> [options and parameters]
 ```
 
 For example, to list installed environments, the command would be:
 
-```bash
+```shell
 $ qbraid envs list
 ```
 
 To view help documentation, use one of the following:
 
-```bash
-$ qbraid help
-$ qbraid <command> help
-$ qbraid <command> <subcommand> help
+```shell
+$ qbraid --help
+$ qbraid <command> --help
+$ qbraid <command> <subcommand> --help
 ```
 
 For example:
 
-```bash
-$ qbraid help
-
-Group
-    qbraid
+```shell
+$ qbraid --help
 
-Subgroups
-    envs             : Manage qBraid environments.
-    kernels          : Manage qBraid kernels.
-    jobs             : Manage qBraid Quantum Jobs.
+Usage: qbraid [OPTIONS] COMMAND [ARGS]...
 
-Arguments
-    -V, --version    : Show version and exit
+The qBraid CLI.
 
-Global Arguments
-    -h, --help       : Show this help message and exit.
+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.
 
-Reference Docs: https://docs.qbraid.com/en/latest/cli/qbraid.html
+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:
 
-```bash
+```shell
 $ qbraid --version
 ```