Skip to main content
Usage: 
$ qbraid envs [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • activate: Activate qBraid environment.
  • add-path: Register an external Python environment…
  • available: List available pre-built environments for…
  • create: Create a new qBraid environment.
  • info: Get detailed information about an…
  • install: Install a pre-built environment from cloud…
  • list: List installed qBraid environments.
  • publish: Request to publish environment to the…
  • publish-approve: (Admin) Approve and publish an environment…
  • publish-cancel: Cancel a pending publish request.
  • publish-deny: (Admin) Deny a publish request.
  • publish-review: (Admin) Mark an environment as under review.
  • publish-status: Check the publishing status of an…
  • remove: Delete a qBraid environment.
  • remove-path: Unregister an external environment from…
  • share: Share an environment with another user.
  • shared: List users who have access to an environment.
  • sync: Synchronize environment registry with…
  • unshare: Revoke access to a shared environment.
  • upload: Upload environment to qBraid cloud storage…

​
qbraid envs activate

Activate qBraid environment. NOTE: Currently only works on qBraid Lab platform, and select few other OS types. Usage: 
$ qbraid envs activate [OPTIONS] NAME
Arguments:
  • NAME: Name of the environment. Values from ‘qbraid envs list’. [required]
Options:
  • --help: Show this message and exit.

​
qbraid envs add-path

Register an external Python environment with qBraid. This allows you to use existing Python environments (conda, venv, etc.) with qBraid commands like kernel management and activation. Examples: qbraidenvsadd−path/path/to/myenv−−aliasmyenvqbraid envs add-path /path/to/my_env --alias myenv qbraid envs add-path ~/conda/envs/quantum —name quantum_abc123 Usage: 
$ qbraid envs add-path [OPTIONS] PATH
Arguments:
  • PATH: [required]
Options:
  • -a, --alias TEXT: Alias for the environment
  • -n, --name TEXT: Name/slug for the environment
  • -y, --yes
  • --help: Show this message and exit.

​
qbraid envs available

List available pre-built environments for installation. Usage: 
$ qbraid envs available [OPTIONS]
Options:
  • --help: Show this message and exit.

​
qbraid envs create

Create a new qBraid environment. Usage: 
$ qbraid envs create [OPTIONS]
Options:
  • -n, --name TEXT: Name of the environment to create
  • -d, --description TEXT: Short description of the environment
  • -f, --file TEXT: Path to a .yml file containing the environment details
  • -y, --yes: Automatically answer ‘yes’ to all prompts
  • --add-kernels: Add kernel to Jupyter’s global kernel registry
  • --help: Show this message and exit.

​
qbraid envs info

Get detailed information about an environment. Accepts either a local env_id or a cloud slug. Shows information from both local registry and cloud catalog when available. Examples: qbraid envs info qiskit_1.0 # By slug (cloud + local if installed) qbraid envs info a1b2 # By env_id (local only) $ qbraid envs info my_custom_abc123 # Custom environment Usage: 
$ qbraid envs info [OPTIONS] IDENTIFIER
Arguments:
  • IDENTIFIER: Environment identifier (env_id or slug) [required]
Options:
  • --help: Show this message and exit.

​
qbraid envs install

Install a pre-built environment from cloud storage. Usage: 
$ qbraid envs install [OPTIONS] ENV_SLUG
Arguments:
  • ENV_SLUG: Environment slug to install (from ‘qbraid envs available’) [required]
Options:
  • -t, --temp: Install as temporary environment (faster, non-persistent)
  • --target TEXT: Custom target directory (defaults to ~/.qbraid/environments or /opt/environments)
  • -y, --yes: Automatically overwrite existing environment without prompting
  • --help: Show this message and exit.

​
qbraid envs list

List installed qBraid environments. Usage: 
$ qbraid envs list [OPTIONS]
Options:
  • --help: Show this message and exit.

​
qbraid envs publish

Request to publish environment to the public catalog. This submits your uploaded environment for admin review. Once approved, it will be publicly visible and installable by all users. The environment must be uploaded first with ‘qbraid envs upload’. Examples: $ qbraid envs publish my_env_abc123 Usage: 
$ qbraid envs publish [OPTIONS] SLUG
Arguments:
  • SLUG: Environment slug (from upload) [required]
Options:
  • --help: Show this message and exit.

​
qbraid envs publish-approve

(Admin) Approve and publish an environment to the public catalog. This makes the environment publicly visible and installable by all users. Examples: $ qbraid envs publish-approve my_env_abc123 Usage: 
$ qbraid envs publish-approve [OPTIONS] SLUG
Arguments:
  • SLUG: Environment slug to approve [required]
Options:
  • --help: Show this message and exit.

​
qbraid envs publish-cancel

Cancel a pending publish request. This withdraws your publish request before it’s approved. You can resubmit later with ‘qbraid envs publish’. Examples: $ qbraid envs publish-cancel my_env_abc123 Usage: 
$ qbraid envs publish-cancel [OPTIONS] SLUG
Arguments:
  • SLUG: Environment slug [required]
Options:
  • --help: Show this message and exit.

​
qbraid envs publish-deny

(Admin) Deny a publish request. The owner will be notified with the denial reason. Examples: qbraidenvspublish−denymyenvabc123qbraid envs publish-deny my_env_abc123 qbraid envs publish-deny my_env_abc123 —message “Missing documentation” Usage: 
$ qbraid envs publish-deny [OPTIONS] SLUG
Arguments:
  • SLUG: Environment slug to deny [required]
Options:
  • -m, --message TEXT: Reason for denial (sent to owner)
  • --help: Show this message and exit.

​
qbraid envs publish-review

(Admin) Mark an environment as under review. This transitions the environment from ‘requested’ to ‘pending’ status, indicating an admin is actively reviewing it. Examples: $ qbraid envs publish-review my_env_abc123 Usage: 
$ qbraid envs publish-review [OPTIONS] SLUG
Arguments:
  • SLUG: Environment slug to review [required]
Options:
  • --help: Show this message and exit.

​
qbraid envs publish-status

Check the publishing status of an environment. Status values: - none: Not submitted for publishing - requested: Waiting for admin review - pending: Under admin review - approved: Published to public catalog - denied: Publish request was denied Examples: $ qbraid envs publish-status my_env_abc123 Usage: 
$ qbraid envs publish-status [OPTIONS] SLUG
Arguments:
  • SLUG: Environment slug to check [required]
Options:
  • --help: Show this message and exit.

​
qbraid envs remove

Delete a qBraid environment. Usage: 
$ qbraid envs remove [OPTIONS]
Options:
  • -n, --name TEXT: Name of the environment to remove [required]
  • -y, --yes: Automatically answer ‘yes’ to all prompts
  • --help: Show this message and exit.

​
qbraid envs remove-path

Unregister an external environment from qBraid. This only removes the environment from qBraid’s registry. The actual environment files are NOT deleted. Usage: 
$ qbraid envs remove-path [OPTIONS] NAME
Arguments:
  • NAME: Name or alias of environment to unregister [required]
Options:
  • -y, --yes
  • --help: Show this message and exit.

​
qbraid envs share

Share an environment with another user. By default, grants read and execute permissions (user can view and install). Use —write to also allow modifications. The environment must be uploaded first with ‘qbraid envs upload’. Examples: qbraidenvssharemyenvabc123colleague@example.comqbraid envs share my_env_abc123 colleague@example.com qbraid envs share my_env_abc123 collaborator@example.com —write $ qbraid envs share my_env_abc123 viewer@example.com —no-execute Usage: 
$ qbraid envs share [OPTIONS] SLUG EMAIL
Arguments:
  • SLUG: Environment slug to share [required]
  • EMAIL: Email of user to share with [required]
Options:
  • --read / --no-read: Grant read permission (view environment) [default: read]
  • --write: Grant write permission (modify environment)
  • --execute / --no-execute: Grant execute permission (install environment) [default: execute]
  • --help: Show this message and exit.

​
qbraid envs shared

List users who have access to an environment. Shows all users with read or write access to the specified environment. Examples: $ qbraid envs shared my_env_abc123 Usage: 
$ qbraid envs shared [OPTIONS] SLUG
Arguments:
  • SLUG: Environment slug to check [required]
Options:
  • --help: Show this message and exit.

​
qbraid envs sync

Synchronize environment registry with filesystem. This will:
  • Remove registry entries for deleted environments
  • Auto-discover new environments in default paths
  • Verify all registered paths still exist
Usage: 
$ qbraid envs sync [OPTIONS]
Options:
  • --help: Show this message and exit.

​
qbraid envs unshare

Revoke access to a shared environment. This removes all permissions for the specified user. Examples: $ qbraid envs unshare my_env_abc123 former_colleague@example.com Usage: 
$ qbraid envs unshare [OPTIONS] SLUG EMAIL
Arguments:
  • SLUG: Environment slug [required]
  • EMAIL: Email of user to revoke access from [required]
Options:
  • --help: Show this message and exit.

​
qbraid envs upload

Upload environment to qBraid cloud storage (private by default). This uploads your local environment to make it available for sharing with specific users. Use ‘qbraid envs publish’ after upload to request public visibility. Examples: qbraidenvsuploadmycustomenvqbraid envs upload my_custom_env qbraid envs upload a1b2 —overwrite Usage: 
$ qbraid envs upload [OPTIONS] IDENTIFIER
Arguments:
  • IDENTIFIER: Environment name (if unique) or env_id to upload [required]
Options:
  • -o, --overwrite: Overwrite existing uploaded environment
  • --help: Show this message and exit.