Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qbraid.com/llms.txt

Use this file to discover all available pages before exploring further.

Manage Jupyter kernel specs for qBraid environments. Each environment can have its own kernel visible in JupyterLab’s launcher. Use this when you want to: • Make an environment available as a Jupyter kernel • Fix a broken kernel that points to a missing environment • Clean up orphaned kernels from deleted environments Usage: 
$ qbraid kernels [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list: List all available kernels.
  • add: Add a kernel to Jupyter.
  • remove: Remove a kernel from Jupyter.
  • status: Check kernel status for an environment.
  • repair: Repair a kernel’s Python path.
  • clean: Remove orphaned kernels.

​
qbraid kernels list

List all available kernels. Usage: 
$ qbraid kernels list [OPTIONS]
Options:
  • --help: Show this message and exit.

​
qbraid kernels add

Add a kernel to Jupyter. Usage: 
$ qbraid kernels add [OPTIONS] ENVIRONMENT
Arguments:
  • ENVIRONMENT: Name of environment for which to add ipykernel. Values from ‘qbraid envs list’. [required]
Options:
  • --help: Show this message and exit.

​
qbraid kernels remove

Remove a kernel from Jupyter. Usage: 
$ qbraid kernels remove [OPTIONS] ENVIRONMENT
Arguments:
  • ENVIRONMENT: Name of environment for which to remove ipykernel. Values from ‘qbraid envs list’. [required]
Options:
  • --help: Show this message and exit.

​
qbraid kernels status

Check kernel status for an environment. Usage: 
$ qbraid kernels status [OPTIONS] ENVIRONMENT
Arguments:
  • ENVIRONMENT: Environment name or env_id to check kernel status. [required]
Options:
  • --help: Show this message and exit.

​
qbraid kernels repair

Repair a kernel’s Python path. Fixes kernel.json with the correct Python path. Usage: 
$ qbraid kernels repair [OPTIONS] ENVIRONMENT
Arguments:
  • ENVIRONMENT: Environment name or env_id to repair kernel. [required]
Options:
  • --help: Show this message and exit.

​
qbraid kernels clean

Remove orphaned kernels. Removes kernels whose Python environment no longer exists. Without arguments, scans all kernels and prompts to remove broken ones. With a kernel name, removes it directly without checking validity. Usage: 
$ qbraid kernels clean [OPTIONS] [SLUG]
Arguments:
  • [SLUG]: Kernel name to remove directly (no validation check).
Options:
  • -y, --yes: Skip confirmation prompt
  • --help: Show this message and exit.