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 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: qbraid compute up <profile> # Start server + configure SSH qbraid compute status # Check server status qbraid compute ssh connect # SSH into running server qbraid compute down # Stop server Usage: 
$ qbraid compute [OPTIONS] COMMAND [ARGS]...
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: qbraid compute up 2vCPU_4GB Usage: 
$ qbraid compute up [OPTIONS] PROFILE_SLUG
Arguments:
  • PROFILE_SLUG: Profile slug to start [required]
Options:
  • -c, --cluster TEXT: Cluster ID
  • -t, --timeout INTEGER: Server start timeout [default: 120]
  • --no-ssh: Skip SSH configuration
  • --help: Show this message and exit.

​
qbraid compute down

Stop the running server. Example: qbraid compute down qbraid compute down —cleanup-ssh Usage: 
$ qbraid compute down [OPTIONS]
Options:
  • -c, --cluster TEXT: 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: 
$ qbraid compute status [OPTIONS]
Options:
  • -c, --cluster TEXT: Cluster ID
  • --help: Show this message and exit.

​
qbraid compute list

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

​
qbraid compute sessions

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

​
qbraid compute usage

Show compute usage summary. Usage: 
$ qbraid compute usage [OPTIONS]
Options:
  • -d, --days INTEGER: Number of days (default: 30)
  • --tz TEXT: Timezone (e.g. America/New_York)
  • --daily: Show daily breakdown
  • --help: Show this message and exit.

​
qbraid compute profiles

Manage compute profiles. Usage: 
$ qbraid compute profiles [OPTIONS] COMMAND [ARGS]...
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: 
$ qbraid compute profiles list [OPTIONS]
Options:
  • -p, --plan TEXT: Filter by plan tier
  • -g, --gpu: Filter GPU profiles
  • -c, --has-capacity: Filter by capacity
  • --cluster TEXT: Filter by cluster
  • -l, --limit INTEGER: Results per page [default: 50]
  • --help: Show this message and exit.

​
qbraid compute profiles info

Get detailed profile information. Usage: 
$ qbraid compute profiles info [OPTIONS] SLUG
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: 
$ qbraid compute profiles create-try [OPTIONS]
Options:
  • -i, --image TEXT: Base Docker image (required) [required]
  • -n, --name TEXT: Display name
  • -d, --description TEXT: Description
  • --cpu FLOAT: CPU cores (guarantee and limit)
  • -m, --mem TEXT: Memory (e.g., ‘8G’)
  • -g, --gpu: Enable GPU
  • --ide TEXT: IDE type: lab, vscode, ssh [default: lab]
  • -f, --features TEXT: 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: 
$ qbraid compute profiles create-save [OPTIONS]
Options:
  • -i, --image TEXT: Base Docker image (required) [required]
  • -n, --name TEXT: Display name
  • -d, --description TEXT: Description
  • --cpu FLOAT: CPU cores (guarantee and limit)
  • -m, --mem TEXT: Memory (e.g., ‘8G’)
  • -g, --gpu: Enable GPU
  • --ide TEXT: IDE type: lab, vscode, ssh [default: lab]
  • -f, --features TEXT: Features (e.g., ‘claude,codeq’)
  • -w, --wait: Wait for build to complete
  • -t, --timeout INTEGER: 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: 
$ qbraid compute profiles build-status [OPTIONS] SLUG
Arguments:
  • SLUG: Profile slug [required]
Options:
  • --help: Show this message and exit.

​
qbraid compute profiles delete

Delete a user-owned profile. Usage: 
$ qbraid compute profiles delete [OPTIONS] SLUG
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: 
$ qbraid compute server [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • status: Check server status.
  • start: Start a server with the specified profile.
  • stop: Stop the current server.
  • 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: 
$ qbraid compute server status [OPTIONS]
Options:
  • -c, --cluster TEXT: Cluster ID
  • --show-url: Show full server URL with auth token
  • --help: Show this message and exit.

​
qbraid compute server start

Start a server with the specified profile. Usage: 
$ qbraid compute server start [OPTIONS] PROFILE_SLUG
Arguments:
  • PROFILE_SLUG: Profile slug to start [required]
Options:
  • -c, --cluster TEXT: Cluster ID
  • -w, --wait: Wait for server to be ready
  • -t, --timeout INTEGER: Wait timeout in seconds [default: 120]
  • --ssh: Configure SSH after start
  • --help: Show this message and exit.

​
qbraid compute server stop

Stop the current server. Usage: 
$ qbraid compute server stop [OPTIONS]
Options:
  • -c, --cluster TEXT: Cluster ID
  • -f, --force: Skip confirmation
  • --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: 
$ qbraid compute server url [OPTIONS]
Options:
  • -c, --cluster TEXT: Cluster ID
  • --help: Show this message and exit.

​
qbraid compute server stop-all

Stop all servers across all organizations. Usage: 
$ qbraid compute server stop-all [OPTIONS]
Options:
  • -c, --cluster TEXT: Cluster ID
  • -f, --force: Skip confirmation
  • --help: Show this message and exit.

​
qbraid compute ssh

SSH access to compute servers. Usage: 
$ qbraid compute ssh [OPTIONS] COMMAND [ARGS]...
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. Usage: 
$ qbraid compute ssh setup [OPTIONS]
Options:
  • -c, --cluster TEXT: Cluster ID
  • -t, --tool TEXT: Configure for specific tool: vscode, cursor, claude-code, codex
  • -a, --alias TEXT: SSH config alias (default: qbraid-)
  • --help: Show this message and exit.

​
qbraid compute ssh connect

SSH into the running server. This opens an interactive SSH session to the server. Usage: 
$ qbraid compute ssh connect [OPTIONS]
Options:
  • -a, --alias TEXT: SSH config alias (auto-detected if not set)
  • --help: Show this message and exit.

​
qbraid compute ssh token

Get SSH session token. Retrieves a JupyterHub session token for SSH access. Usage: 
$ qbraid compute ssh token [OPTIONS]
Options:
  • -c, --cluster TEXT: Cluster ID
  • -r, --raw: Output raw token only
  • --help: Show this message and exit.

​
qbraid compute ssh config

Show or edit SSH configuration. Usage: 
$ qbraid compute ssh config [OPTIONS]
Options:
  • -e, --edit: Open config in editor
  • --help: Show this message and exit.

​
qbraid compute ssh remove

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