CLI version metadata

cli.version() -> CliVersionResponse

GET/compute/v1/cli/version

Returns public boltz-api CLI version metadata for lightweight update checks.

ParametersExpand Collapse

current: Optional[str]

platform: Optional[str]

ReturnsExpand Collapse

class CliVersionResponse: …

install: Install

macos_linux: str

windows: str

latest: str

message: Optional[str]

minimum_supported: str

update_available: bool

update_required: bool

CLI version metadata

import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
response = client.cli.version()
print(response.install)

{
  "install": {
    "macos_linux": "curl -fsSL https://raw.githubusercontent.com/boltz-bio/boltz-api-cli/main/scripts/install.sh | sh",
    "windows": "irm https://raw.githubusercontent.com/boltz-bio/boltz-api-cli/main/scripts/install.ps1 | iex"
  },
  "latest": "1.2.3",
  "message": "A newer boltz-api CLI is available.",
  "minimum_supported": "1.0.0",
  "update_available": true,
  "update_required": false
}

Returns Examples

{
  "install": {
    "macos_linux": "curl -fsSL https://raw.githubusercontent.com/boltz-bio/boltz-api-cli/main/scripts/install.sh | sh",
    "windows": "irm https://raw.githubusercontent.com/boltz-bio/boltz-api-cli/main/scripts/install.ps1 | iex"
  },
  "latest": "1.2.3",
  "message": "A newer boltz-api CLI is available.",
  "minimum_supported": "1.0.0",
  "update_available": true,
  "update_required": false
}