# Cli

## Version

`cli.version(CliVersionParams**kwargs)  -> CliVersionResponse`

**get** `/compute/v1/cli/version`

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

### Parameters

- `current: Optional[str]`

- `platform: Optional[str]`

### Returns

- `class CliVersionResponse: …`

  - `install: Install`

    - `macos_linux: str`

    - `windows: str`

  - `latest: str`

  - `message: Optional[str]`

  - `minimum_supported: str`

  - `update_available: bool`

  - `update_required: bool`

### Example

```python
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)
```
