# Jabra CLI

## Introduction

**Jabra CLI** is a cross-platform command-line tool designed for power users and administrators to manage JABRA personal and meeting room devices. It runs on both Windows and macOS and provides a unified interface for interacting with supported Jabra devices.

Key functionalities include: 

- Firmware

Jabra CLI streamlines device fleet management and supports automation in both enterprise and technical support environments.

## Configuration

Below is an example configuration for upgrading the firmware of a **PanaCast 50**:

```json
{
  "Name": "PanaCast 50 Sample",
  "DeviceModels": [
    {
      /* PanaCast 50 */
      "PID": 12305,
      "Firmware": {
        "LocalPath": "./Jabra_PanaCast_50_9.0.5.zip"
      }
    }
  ]
}
```    

## Supported Commands

Jabra CLI commands are categorized into these main groups:

### Configuration

Commands for managing device configurations.

- `show` — Displays the current configuration state of the connected device.
- `prepare` — Downloads missing firmware files referenced by firmware versions in the configuration file.
- `apply` — Applies a local configuration to the connected device.

All configuration commands support `--config <path>` to use a configuration file other than `config.json` in the current directory.

### Firmware

Commands for managing firmware on supported devices.

- `firmware list` — Lists available firmware versions for supported devices.
- `firmware download` — Downloads specific firmware for offline use.
- `update` — Updates the firmware on the connected device to the latest supported version.

### Property

Commands for viewing or setting individual device properties.

- `read` — Read the value of properties.
- `write` — Write property value of properties.
- `watch` — Listens for changes in device properties (e.g., number of people or camera status).
- `run` - Executes a property action on an attached device.

### Device

- `list` - List attached Jabra devices.
- `watch` - Listens for device-related events in real time (e.g., when a device is connected or disconnected)

## Global Options

Options that apply to all commands.

- `--output-format` — Defines the output format. Supported values are `text` and `json`.  
  Use `json` for system integration, and `text` for human readability.

## Installation

We provide installers for both macOS (`*.pkg`) and Windows (`*.msi`).

The current version officially supports the following operating systems (it may work on others, but they are not guaranteed):

- **Windows 11** (x64 and ARM64)
- **Windows 10** (x64)
- **macOS 15** (Apple Silicon and Intel)
- **macOS 14** (Apple Silicon and Intel)

### Manual Installation

To manually install Jabra CLI, copy the JabraCLI executable file along with the Firmware Updater (FWU) to the target machine. Note that the FWU has the following dependencies that must be present: 

- **Visual C++ 2022 Redistributable (x86)**
- **Visual C++ 2010 Redistributable (x86)**

If these are not installed, the tool will fail to launch. These redistributables can be downloaded from Microsoft's official site.

## Diagnostics

You can enable enhanced diagnostic output by setting the following environment variable:

```
JABRA_CLI_ENABLE_DIAGNOSTICS=true
```
When diagnostics are enabled, the CLI will produce additional logging to help with troubleshooting.

Log files are written to the user’s local application data folder under /Jabra/JabraCli/Logs

## Telemetry

Jabra CLI collects anonymous usage data and error reports to help the Jabra team understand tool usage patterns and identify issues, facilitating product improvement over time. 

No personally identifiable information (PII) is collected, and all data is anonymized before transmission.

## Further Information

For more details, visit:  
[developer.jabra.com/sdks-and-tools/jabracli](https://developer.jabra.com/sdks-and-tools/jabracli)

If you do not have the necessary firmware file, please contact your Jabra representative or visit:  
[developer.jabra.com/sdks-and-tools/jabracli](https://developer.jabra.com/sdks-and-tools/jabracli)

For license information, please visit:  
[developer.jabra.com/legal/license-agreement](https://developer.jabra.com/legal/license-agreement)