API Reference

Cli

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

CLI version metadata

client.Cli.Version(ctx, query) (*CliVersionResponse, error)

GET/compute/v1/cli/version

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

ParametersExpand Collapse

query CliVersionParams

Current param.Field[string]optional

Platform param.Field[string]optional

ReturnsExpand Collapse

type CliVersionResponse struct{…}

Install CliVersionResponseInstall

MacosLinux string

Windows string

Latest string

Message string

MinimumSupported string

UpdateAvailable bool

UpdateRequired bool

CLI version metadata

Go

HTTP

TypeScript

Python

Go

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/boltz-bio/boltz-api-go"
  "github.com/boltz-bio/boltz-api-go/option"
)

func main() {
  client := boltzapi.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Cli.Version(context.TODO(), boltzapi.CliVersionParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Install)
}

200 example

{
  "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

200 example

{
  "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
}