Skip to main content
Manage cloud compute servers, profiles, and SSH access. Start GPU or CPU servers on qBraid infrastructure. SSH in from any terminal, connect your IDE (VS Code, Cursor), or launch AI agents on remote hardware. Persistent storage across sessions. Use this when you want to:
  • Run heavy workloads on cloud GPUs without local setup
  • SSH into a cloud dev environment from your terminal
  • Connect VS Code or Cursor to a remote server
  • Launch AI agents on more powerful hardware
Quick start:
Usage:
Options:
  • --help: Show this message and exit.
Commands:
  • up: Start server and configure SSH.
  • down: Stop the running server.
  • status: Check server status.
  • list: List compute profiles.
  • sessions: List compute sessions.
  • usage: Show compute usage summary.
  • profiles: Manage compute profiles.
  • server: Manage compute servers.
  • ssh: SSH access to compute servers.

​
qbraid compute up

Start server and configure SSH. Waits for the server to be ready. This is a convenience command that combines:
  • qbraid compute server start <profile> —wait
  • qbraid compute ssh setup
Example:
Usage:
Arguments:
  • profile_slug: Profile slug to start [required]
Options:
  • -c, --cluster <str>: Cluster ID
  • -t, --timeout <int>: Server start timeout [default: 120]
  • --no-ssh: Skip SSH configuration
  • --help: Show this message and exit.

​
qbraid compute down

Stop the running server. Example:
Usage:
Options:
  • -c, --cluster <str>: Cluster ID
  • -f, --force: Skip confirmation
  • --cleanup-ssh: Remove SSH config
  • --help: Show this message and exit.

​
qbraid compute status

Check server status. Quick status check (alias for ‘server status’). Usage:
Options:
  • -c, --cluster <str>: Cluster ID
  • --help: Show this message and exit.

​
qbraid compute list

List compute profiles. Quick list profiles (alias for ‘profiles list’). Usage:
Options:
  • -g, --gpu: Show only GPU profiles
  • -a, --available: Show only available profiles
  • -l, --limit <int>: Number of results [default: 20]
  • --help: Show this message and exit.

​
qbraid compute sessions

List compute sessions. Usage:
Options:
  • -l, --limit <int>: Number of sessions to show [default: 10]
  • -s, --status <str>: Filter by status (active, ended)
  • -t, --type <str>: Filter by type (cpu, gpu)
  • -d, --days <int>: Show sessions from last N days
  • --help: Show this message and exit.

​
qbraid compute usage

Show compute usage summary. Usage:
Options:
  • -d, --days <int>: Number of days (default: 30)
  • --tz <str>: Timezone (e.g. America/New_York)
  • --daily: Show daily breakdown
  • --help: Show this message and exit.

​
qbraid compute profiles

Manage compute profiles. Usage:
Options:
  • --help: Show this message and exit.
Commands:
  • list: List available compute profiles.
  • info: Get detailed profile information.
  • create-try: Create a try-mode profile.
  • create-save: Create a save-mode profile.
  • build-status: Check build status for a save-mode profile.
  • delete: Delete a user-owned profile.

​
qbraid compute profiles list

List available compute profiles. Usage:
Options:
  • -p, --plan <str>: Filter by plan tier
  • -g, --gpu: Filter GPU profiles
  • -c, --has-capacity: Filter by capacity
  • --cluster <str>: Filter by cluster
  • -l, --limit <int>: Results per page [default: 50]
  • --help: Show this message and exit.

​
qbraid compute profiles info

Get detailed profile information. Usage:
Arguments:
  • slug: Profile slug [required]
Options:
  • --help: Show this message and exit.

​
qbraid compute profiles create-try

Create a try-mode profile. Standard+ plan required. Try-mode profiles use on-the-fly overlay injection - no build step required. Usage:
Options:
  • -i, --image <str>: Base Docker image (required) [required]
  • -n, --name <str>: Display name
  • -d, --description <str>: Description
  • --cpu <float>: CPU cores (guarantee and limit)
  • -m, --mem <str>: Memory (e.g., ‘8G’)
  • -g, --gpu: Enable GPU
  • --ide <str>: IDE type: lab, vscode, ssh [default: lab]
  • -f, --features <str>: Features (e.g., ‘claude,codeq’)
  • --help: Show this message and exit.

​
qbraid compute profiles create-save

Create a save-mode profile. Pro+ plan required. Save-mode profiles trigger a Cloud Build to create a permanent overlay image. Use —wait to wait for the build to complete. Usage:
Options:
  • -i, --image <str>: Base Docker image (required) [required]
  • -n, --name <str>: Display name
  • -d, --description <str>: Description
  • --cpu <float>: CPU cores (guarantee and limit)
  • -m, --mem <str>: Memory (e.g., ‘8G’)
  • -g, --gpu: Enable GPU
  • --ide <str>: IDE type: lab, vscode, ssh [default: lab]
  • -f, --features <str>: Features (e.g., ‘claude,codeq’)
  • -w, --wait: Wait for build to complete
  • -t, --timeout <int>: Build timeout in seconds [default: 600]
  • --help: Show this message and exit.

​
qbraid compute profiles build-status

Check build status for a save-mode profile. Usage:
Arguments:
  • slug: Profile slug [required]
Options:
  • --help: Show this message and exit.

​
qbraid compute profiles delete

Delete a user-owned profile. Usage:
Arguments:
  • slug: Profile slug to delete [required]
Options:
  • -f, --force: Skip confirmation
  • --help: Show this message and exit.

​
qbraid compute server

Manage compute servers. Usage:
Options:
  • --help: Show this message and exit.
Commands:
  • status: Check server status.
  • start: Start a server.
  • stop: Stop a running server or on-demand instance.
  • terminate: Terminate (delete) an on-demand instance.
  • url: Print the full server URL with auth token.
  • stop-all: Stop all servers across all organizations.

​
qbraid compute server status

Check server status. Usage:
Options:
  • -c, --cluster <str>: Cluster ID
  • --show-url: Show full server URL with auth token
  • --help: Show this message and exit.

​
qbraid compute server start

Start a server. Pass a profile slug to provision a new instance, or an existing on-demand instance ID to resume a stopped one. Usage:
Arguments:
  • target: Profile slug (new instance) or instance ID (resume a stopped one) [required]
Options:
  • -c, --cluster <str>: Cluster ID
  • -w, --wait: Wait for server to be ready
  • -t, --timeout <int>: Wait timeout in seconds [default: 120]
  • --ssh: Configure SSH after start
  • --help: Show this message and exit.

​
qbraid compute server stop

Stop a running server or on-demand instance. On-demand BMA instances are detected automatically. If more than one is running, you’ll be prompted to choose; pass —instance to target one directly. With no BMA instances, stops the legacy cluster server. Usage:
Options:
  • -c, --cluster <str>: Cluster ID
  • -i, --instance <str>: BMA instance ID to stop (auto-detected if omitted)
  • -f, --force: Skip confirmation
  • --help: Show this message and exit.

​
qbraid compute server terminate

Terminate (delete) an on-demand instance. DESTRUCTIVE: unlike ‘stop’ (which preserves the disk and is resumable), terminate permanently deletes the instance AND its disk — data cannot be recovered. Applies to on-demand BMA instances only. Usage:
Options:
  • -i, --instance <str>: On-demand instance ID to terminate
  • -f, --force: Skip confirmations (DANGEROUS)
  • --help: Show this message and exit.

​
qbraid compute server url

Print the full server URL with auth token. Use this to get a clickable URL for browser access or to pass the token to other tools. The token is intentionally shown in full. Usage:
Options:
  • -c, --cluster <str>: Cluster ID
  • --help: Show this message and exit.

​
qbraid compute server stop-all

Stop all servers across all organizations. Usage:
Options:
  • -c, --cluster <str>: Cluster ID
  • -f, --force: Skip confirmation
  • --help: Show this message and exit.

​
qbraid compute ssh

SSH access to compute servers. Usage:
Options:
  • --help: Show this message and exit.
Commands:
  • setup: Configure SSH for the server.
  • connect: SSH into the running server.
  • token: Get SSH session token.
  • config: Show or edit SSH configuration.
  • remove: Remove SSH configuration for a host.

​
qbraid compute ssh setup

Configure SSH for the server. Sets up SSH config with a ProxyCommand that tunnels SSH through the jupyter-server-proxy WebSocket endpoint. No websocat required. On-demand BMA instances are handled automatically: if one is running it’s configured under its own alias; pass —instance to target a specific one. Each instance gets an independent alias so several can be reachable at once. Usage:
Options:
  • -c, --cluster <str>: Cluster ID
  • -i, --instance <str>: On-demand instance ID (auto-detected if omitted)
  • -t, --tool <str>: Configure for specific tool: vscode, cursor, claude-code, codex
  • -a, --alias <str>: SSH config alias (default: qbraid-{cluster})
  • --help: Show this message and exit.

​
qbraid compute ssh connect

SSH into the running server. This opens an interactive SSH session to the server. Pass —instance to connect to a specific on-demand instance (resolves to its per-instance alias from ‘ssh setup —instance’). Usage:
Options:
  • -a, --alias <str>: SSH config alias (auto-detected if not set)
  • -i, --instance <str>: On-demand instance ID to connect to
  • --help: Show this message and exit.

​
qbraid compute ssh token

Get SSH session token. Retrieves a JupyterHub session token for SSH access. Usage:
Options:
  • -c, --cluster <str>: Cluster ID
  • -r, --raw: Output raw token only
  • --help: Show this message and exit.

​
qbraid compute ssh config

Show or edit SSH configuration. Usage:
Options:
  • -e, --edit: Open config in editor
  • --help: Show this message and exit.

​
qbraid compute ssh remove

Remove SSH configuration for a host. Usage:
Arguments:
  • alias: SSH alias to remove [required]
Options:
  • -f, --force: Skip confirmation
  • --help: Show this message and exit.