Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blaxel.ai/llms.txt

Use this file to discover all available pages before exploring further.

bl get

List or retrieve Blaxel resources in your workspace

Synopsis

Retrieve information about Blaxel resources in your workspace. A “resource” in Blaxel refers to any deployable or manageable entity:
  • agents: AI agent applications
  • functions/mcp: Model Context Protocol servers (tool providers)
  • jobs: Batch processing tasks
  • sandboxes: Isolated execution environments
  • models: AI model configurations
  • policies: Access control policies
  • volumes: Persistent storage
  • integrationconnections: External service integrations
Hub Discovery (pre-built resources available in the Blaxel Hub):
  • sandbox-hub: Pre-built sandbox images with pre-installed tools and runtimes
  • mcp-hub: Pre-built MCP servers for tool integrations (GitHub, Slack, etc.)
  • templates: Project scaffolding templates for bl new
Output Formats: Use -o flag to control output format:
  • pretty: Human-readable colored output (default)
  • json: Machine-readable JSON (for scripting)
  • yaml: YAML format
  • table: Tabular format with columns
Watch Mode: Use —watch to continuously monitor a resource and see updates in real-time. Useful for tracking deployment status or watching for changes. The command can list all resources of a type or get details for a specific one.

Examples

  # List all agents
  bl get agents

  # Get specific agent details
  bl get agent my-agent

  # Get in JSON format (useful for scripting)
  bl get agent my-agent -o json

  # Watch agent status in real-time
  bl get agent my-agent --watch

  # List all resources with table output
  bl get agents -o table

  # Get MCP servers (also called functions)
  bl get functions
  bl get mcp

  # List jobs
  bl get jobs

  # Get specific job
  bl get job my-job

  # List executions for a job (nested resource)
  bl get job my-job executions

  # Get specific execution for a job
  bl get job my-job execution EXECUTION_ID

  # List pre-built sandbox images from the Hub
  bl get sandbox-hub
  bl get sandbox-hub -o json

  # List pre-built MCP servers from the Hub
  bl get mcp-hub
  bl get mcp-hub -o json

  # Monitor sandbox status
  bl get sandbox my-sandbox --watch

  # List processes in a sandbox
  bl get sandbox my-sandbox process
  bl get sbx my-sandbox ps

  # Get specific process in a sandbox
  bl get sandbox my-sandbox process my-process

  # List previews for a sandbox
  bl get sandbox my-sandbox previews

  # Get a specific preview
  bl get sandbox my-sandbox preview my-preview

  # List tokens for a sandbox preview
  bl get sandbox my-sandbox preview my-preview tokens

  # Get a specific token
  bl get sandbox my-sandbox preview my-preview token my-token

  # --- Filtering with jq ---

  # Get names of all jobs with status DELETING
  bl get jobs -o json | jq -r '.[] | select(.status == "DELETING") | .metadata.name'

  # Get names of all deployed sandboxes
  bl get sandboxes -o json | jq -r '.[] | select(.status == "DEPLOYED") | .metadata.name'

  # Get all agents with name containing "test"
  bl get agents -o json | jq -r '.[] | select(.metadata.name | contains("test")) | .metadata.name'

  # Get sandboxes with specific label (e.g., environment=dev)
  bl get sandboxes -o json | jq -r '.[] | select(.metadata.labels.environment == "dev") | .metadata.name'

  # Get all job names
  bl get jobs -o json | jq -r '.[] | .metadata.name'

  # Count resources by status
  bl get agents -o json | jq 'group_by(.status) | map({status: .[0].status, count: length})'

Options

  -h, --help    help for get
      --watch   After listing/getting the requested object, watch for changes.

Options inherited from parent commands

  -o, --output string          Output format. One of: pretty,yaml,json,table
      --skip-version-warning   Skip version warning
  -u, --utc                    Enable UTC timezone
  -v, --verbose                Enable verbose output
  -w, --workspace string       Specify the workspace name

SEE ALSO

Last modified on May 21, 2026