Publish and install qBraid projects: repositories, environments and agent skills. Use get —setup —inspect-repository —json to inspect a resolved setup before installing it.

Usage:

$ qbraid projects [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • cleanup: Preview previous environment cleanup.
  • list: List qBraid Hub projects.
  • get: Get project metadata.
  • install: Install a reviewed project.
  • create: Create a private project.
  • configure: Configure project setup.
  • publish: Manage project publication.

qbraid projects cleanup

Preview previous environment cleanup.

Preserve current and unfinished copies; removal requires explicit confirmation.

Usage:

$ qbraid projects cleanup [OPTIONS] {slug} {working_directory}

Arguments:

  • slug <str>: Project slug. [required]
  • working_directory <dir>: Prepared project checkout. [required]

Options:

  • --apply: Remove the previewed older environments.
  • --yes: Confirm removal with —expected-plan.
  • --expected-plan <str>: Exact cleanup preview plan ID.
  • --json: Output the plan/result as JSON.
  • --help: Show this message and exit.

qbraid projects list

List qBraid Hub projects.

Usage:

$ qbraid projects list [OPTIONS]

Options:

  • -s, --search <str>: Search query across title and description
  • -f, --featured: Show only featured projects
  • -c, --category <str>: Filter by category
  • -v, --visibility <str>: Filter by visibility: ‘public’ or ‘private’
  • --json: Emit JSON only.
  • --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 <str>: The slug of the project to fetch. [required]

Options:

  • --no-fmt: Disable rich formatting (output raw data) [default: True]
  • --setup: Review the current resolved agent setup and immutable revision (read-only).
  • --json: Emit JSON only.
  • --inspect-repository: With —setup, inspect pinned agent configuration paths without checkout.
  • --help: Show this message and exit.

qbraid projects install

Install a reviewed project.

Install the reviewed repository, environments and project-local skills for all agents.

Usage:

$ qbraid projects install [OPTIONS] {slug}

Arguments:

  • slug <str>: Project slug. [required]

Options:

  • -t, --target-dir <str>: Parent directory for the reviewed checkout.
  • --no-envs: Skip environments only with —legacy-env-only.
  • --agent-setup <str>: Prepare just claude, codex or codeq; never launches.
  • --reviewed-revision <str>: Revision obtained after get —setup —inspect-repository —json.
  • --legacy-env-only: Explicitly use the older repo + environments installer.
  • --json: Emit the installation summary as JSON only.
  • --help: Show this message and exit.

qbraid projects create

Create a private project.

Create a private project definition; use publish request after checking its dependencies.

Usage:

$ qbraid projects create [OPTIONS]

Options:

  • --file <file>: JSON project definition with githubUrl/title and linked resource slugs. [required]
  • --json: Emit JSON only.
  • --help: Show this message and exit.

qbraid projects configure

Configure project setup.

Configure the main page, linked skills and author setup of an existing project.

Usage:

$ qbraid projects configure [OPTIONS] {slug}

Arguments:

  • slug <str>: The existing project to configure (author only). [required]

Options:

  • --artifact <str>: An explicitly public artifact you manage; never publishes it.
  • --readme: Use the repository README as the main page.
  • --skill <list[str]>: Link a registry skill; repeat for all required skills.
  • --clear-skills: Remove the project’s linked skills.
  • --instructions-file <file>: UTF-8 author instructions. An empty file clears them.
  • --repo-ref <str>: Repository branch, tag or commit to resolve when reviewing setup.
  • --env <list[str]>: Required environment slug; repeat for all direct environments.
  • --env-group <list[str]>: Required environment group; repeat for all groups.
  • --help: Show this message and exit.

qbraid projects publish

Manage project publication.

Request, inspect or withdraw project publication.

Usage:

$ qbraid projects publish [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • request: Request project publication.
  • status: Show creator-visible publication status.
  • cancel: Withdraw project publication.

qbraid projects publish request

Request project publication.

Submit the project definition to the existing public catalogue review queue.

Usage:

$ qbraid projects publish request [OPTIONS] {slug}

Arguments:

  • slug <str>: [required]

Options:

  • --json
  • --help: Show this message and exit.

qbraid projects publish status

Show creator-visible publication status.

Usage:

$ qbraid projects publish status [OPTIONS] {slug}

Arguments:

  • slug <str>: [required]

Options:

  • --json
  • --help: Show this message and exit.

qbraid projects publish cancel

Withdraw project publication.

Withdraw a request or unpublish the definition without deleting resources.

Usage:

$ qbraid projects publish cancel [OPTIONS] {slug}

Arguments:

  • slug <str>: [required]

Options:

  • --json
  • --help: Show this message and exit.