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.

Launch, monitor, and control AI coding agents. Run Claude Code, OpenCode, or Codex in managed tmux sessions. Send instructions, stream transcripts, handle permissions, and orchestrate multiple agents — all from one place. Works locally and on remote compute servers via SSH. Use this when you want to: • Spin up agents on specific repos or projects • Watch what agents are doing in real-time • Approve or deny tool-use permissions remotely • Manage agents running on cloud compute machines • Resume previous coding sessions Getting started: qbraid agents launch # Interactive launch qbraid agents list # Show active sessions qbraid agents watch <name> # Stream live activity qbraid agents send <name> —text ”…” # Send instructions Usage:
$ qbraid agents [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • register: Register an agent session.
  • deregister: Deregister an agent session.
  • list: List agent sessions.
  • discover: Discover new agent sessions.
  • status: Show detailed status for an agent session.
  • update: Update metadata fields on an agent session.
  • kill: Stop an agent by name, session ID, or PID.
  • launch: Launch an AI coding agent.
  • resume: Resume a previous agent session.
  • send: Send text to a running agent’s terminal.
  • read: Read recent terminal output from an agent.
  • approve: Approve a tool-use prompt.
  • watch: Stream agent transcript.
  • attach: Attach to an agent’s terminal.
  • clean: Clean up orphaned sessions.
  • hooks: Manage agent lifecycle hooks.

qbraid agents register

Register an agent session. Reads session data from stdin JSON (used by hooks). Usage:
$ qbraid agents register [OPTIONS]
Options:
  • --help: Show this message and exit.

qbraid agents deregister

Deregister an agent session. Reads session data from stdin JSON (used by hooks). Usage:
$ qbraid agents deregister [OPTIONS]
Options:
  • --help: Show this message and exit.

qbraid agents list

List agent sessions. Use —compute to list on a remote server. Usage:
$ qbraid agents list [OPTIONS]
Options:
  • -t, --tool TEXT: Filter by tool (claude, codeq, codex)
  • --status TEXT: Filter by status
  • --tag TEXT: Filter by tag (repeatable)
  • --since TEXT: Time window (e.g., ‘1h’, ‘30m’, ‘2d’)
  • -c, --compute TEXT: SSH alias for remote compute (runs list on remote)
  • -s, --search TEXT: Text search across name/cwd/tags
  • -a, --all: Include stopped sessions
  • -l, --limit INTEGER RANGE: Entries per page [default: 25; x>=1]
  • -p, --page INTEGER RANGE: Page number (non-interactive mode) [default: 1; x>=1]
  • --sort TEXT: Sort by: recent, oldest, name, tool, status, cwd, model [default: recent]
  • --no-interactive: Disable interactive pagination
  • --json: Output as JSON array (for programmatic use)
  • --help: Show this message and exit.

qbraid agents discover

Discover new agent sessions. Scans transcript files and registers new agent sessions. Usage:
$ qbraid agents discover [OPTIONS]
Options:
  • -f, --full: Full data enrichment for all sessions (slower)
  • -c, --compute TEXT: Sync sessions from remote compute server (SSH alias)
  • --help: Show this message and exit.

qbraid agents status

Show detailed status for an agent session. Usage:
$ qbraid agents status [OPTIONS] SESSION_ID
Arguments:
  • SESSION_ID: Session ID (full or prefix) [required]
Options:
  • --help: Show this message and exit.

qbraid agents update

Update metadata fields on an agent session. Usage:
$ qbraid agents update [OPTIONS] SESSION_ID
Arguments:
  • SESSION_ID: Session ID (full or prefix) [required]
Options:
  • --tag TEXT: Tag to add (can be repeated)
  • --name TEXT: Set terminal name for the session
  • --model TEXT: Set model name (e.g. claude-sonnet-4-20250514)
  • --cwd TEXT: Set working directory for the session
  • --status TEXT: Set session status (working, waiting, idle, error, stopped)
  • --help: Show this message and exit.

qbraid agents kill

Stop an agent by name, session ID, or PID. Usage:
$ qbraid agents kill [OPTIONS] TARGET
Arguments:
  • TARGET: Agent name, ID prefix, or PID [required]
Options:
  • -f, --force: Use SIGKILL instead of SIGTERM
  • --help: Show this message and exit.

qbraid agents launch

Launch an AI coding agent. Starts the agent in a managed tmux session. Usage:
$ qbraid agents launch [OPTIONS]
Options:
  • -t, --tool TEXT: Agent tool (claude, claude-auto, codeq, codex)
  • --cwd TEXT: Working directory
  • -n, --name TEXT: Agent name
  • -i, --instructions TEXT: Initial instructions
  • -r, --repo TEXT: GitHub repo URL, org/repo, or issue/PR URL
  • --type TEXT: Agent type: leader, worker, observer, reviewer
  • --parent TEXT: Parent session ID
  • --team TEXT: Team ID
  • --tag TEXT: Tags (repeatable)
  • -c, --compute TEXT: SSH alias for remote compute server
  • --help: Show this message and exit.

qbraid agents resume

Resume a previous agent session. Resumes in a managed tmux window. Usage:
$ qbraid agents resume [OPTIONS] [SESSION_ID]
Arguments:
  • [SESSION_ID]: Session ID, prefix, or name. Omit for interactive picker.
Options:
  • -n, --name TEXT: Agent name for the resumed session
  • --help: Show this message and exit.

qbraid agents send

Send text to a running agent’s terminal. Usage:
$ qbraid agents send [OPTIONS] SESSION_ID
Arguments:
  • SESSION_ID: Session ID (prefix match) [required]
Options:
  • -m, --text TEXT: Text to send [required]
  • -c, --compute TEXT: SSH alias for remote compute
  • --help: Show this message and exit.

qbraid agents read

Read recent terminal output from an agent. Usage:
$ qbraid agents read [OPTIONS] SESSION_ID
Arguments:
  • SESSION_ID: Session ID (prefix match) [required]
Options:
  • -n, --lines INTEGER: Number of lines to capture [default: 50]
  • -c, --compute TEXT: SSH alias for remote compute
  • --help: Show this message and exit.

qbraid agents approve

Approve a tool-use prompt. Sends ‘y’ + Enter to the agent’s terminal. Usage:
$ qbraid agents approve [OPTIONS] SESSION_ID
Arguments:
  • SESSION_ID: Session ID (prefix match) [required]
Options:
  • --help: Show this message and exit.

qbraid agents watch

Stream agent transcript. Streams live transcript from an agent session. Usage:
$ qbraid agents watch [OPTIONS] SESSION_ID
Arguments:
  • SESSION_ID: Session ID (prefix match) [required]
Options:
  • -n, --lines INTEGER: Initial history lines [default: 20]
  • --interactive / --no-interactive: Prompt for permission decisions [default: interactive]
  • --stream: Stream-only mode: emit JSON events, no interactive prompts (for frontends)
  • -c, --compute TEXT: SSH alias for remote compute
  • --help: Show this message and exit.

qbraid agents attach

Attach to an agent’s terminal. Opens an interactive tmux window for the agent session. Usage:
$ qbraid agents attach [OPTIONS] [SESSION_ID]
Arguments:
  • [SESSION_ID]: Session ID (prefix match). Omit for interactive picker.
Options:
  • -c, --compute TEXT: SSH alias for remote compute
  • --help: Show this message and exit.

qbraid agents clean

Clean up orphaned sessions. Removes orphaned tmux windows and stopped sessions. Usage:
$ qbraid agents clean [OPTIONS]
Options:
  • -y, --yes: Skip confirmation
  • --help: Show this message and exit.

qbraid agents hooks

Manage agent lifecycle hooks. Usage:
$ qbraid agents hooks [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • install: Install agent lifecycle hooks.
  • uninstall: Remove agent lifecycle hooks.

qbraid agents hooks install

Install agent lifecycle hooks. Installs hooks for AI coding tools. Usage:
$ qbraid agents hooks install [OPTIONS]
Options:
  • -t, --tool TEXT: Install hooks for a specific tool (claude, codeq, codex)
  • --help: Show this message and exit.

qbraid agents hooks uninstall

Remove agent lifecycle hooks. Removes hooks from all supported tools. Usage:
$ qbraid agents hooks uninstall [OPTIONS]
Options:
  • --help: Show this message and exit.