# Cli

## Version

`client.cli.version(CliVersionParamsquery?, RequestOptionsoptions?): CliVersionResponse`

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

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

### Parameters

- `query: CliVersionParams`

  - `current?: string`

  - `platform?: string`

### Returns

- `CliVersionResponse`

  - `install: Install`

    - `macos_linux: string`

    - `windows: string`

  - `latest: string`

  - `message: string | null`

  - `minimum_supported: string`

  - `update_available: boolean`

  - `update_required: boolean`

### Example

```typescript
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);
```