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.

Hub projects are GitHub-hosted templates with optional pre-configured environments. Use ‘qbraid projects install <slug>’ to clone a project and install its environments in one step. Usage: 
$ qbraid projects [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list: List qBraid Hub projects.
  • get: Get project metadata.
  • install: Install a Hub project.

​
qbraid projects list

List qBraid Hub projects. Usage: 
$ qbraid projects list [OPTIONS]
Options:
  • -s, --search TEXT: Search query across title and description
  • -f, --featured: Show only featured projects
  • -c, --category TEXT: Filter by category
  • -v, --visibility TEXT: Filter by visibility: ‘public’ or ‘private’
  • --help: Show this message and exit.

​
qbraid projects get

Get project metadata. Fetches metadata for a single qBraid Hub project. Usage: 
$ qbraid projects get [OPTIONS] SLUG
Arguments:
  • SLUG: The slug of the project to fetch. [required]
Options:
  • --no-fmt: Disable rich formatting (output raw data) [default: True]
  • --help: Show this message and exit.

​
qbraid projects install

Install a Hub project. Clone the repo and install envs. Automatically handles platform and Python version mismatches:
  • Platform mismatch: creates a similar local environment instead
  • Python mismatch + uv available: installs the required Python, then downloads
  • Python mismatch + no uv: creates a similar local environment instead
Usage: 
$ qbraid projects install [OPTIONS] SLUG
Arguments:
  • SLUG: The slug of the project to install. [required]
Options:
  • -t, --target-dir TEXT: Directory to clone the project into (defaults to ~/).
  • --no-envs: Skip installing the project’s associated environments.
  • --help: Show this message and exit.