CLI version metadata

client.cli.version(?, ?): CliVersionResponse { install, latest, message, 3 more }

GET/compute/v1/cli/version

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

ParametersExpand Collapse

query: CliVersionParams { current, platform }

current?: string

platform?: string

ReturnsExpand Collapse

CliVersionResponse { install, latest, message, 3 more }

install: Install { macos_linux, windows }

macos_linux: string

windows: string

latest: string

message: string | null

minimum_supported: string

update_available: boolean

update_required: boolean

CLI version metadata

import Boltz from 'boltz-api';

const client = new Boltz({
  apiKey: process.env['BOLTZ_API_KEY'], // This is the default and can be omitted
});

const response = await client.cli.version();

console.log(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
}