Complete Guide to OpenLogi Command-Line Interface Commands

OpenLogi ships a native openlogi binary that exposes seven primary sub-commands—list, backlight, snapshot, camera, assets, diag, and light—for enumerating, configuring, and diagnosing Logitech HID++ peripherals from the terminal.

The AprilNEA/OpenLogi repository provides an open-source Rust toolkit for interacting with Logitech devices. Understanding the OpenLogi command-line interface commands allows you to script device management, automate webcam captures, and run hardware diagnostics without graphical interfaces.

Core Architecture and Entry Points

The CLI binary is a thin wrapper that initializes logging and dispatches user input through clap, Rust’s popular argument parsing library. When you invoke the openlogi command, execution flows through run() in crates/openlogi-cli/src/lib.rs, which parses the top-level Cli struct and routes to the appropriate handler.

The available sub-commands are declared in the Command enum located in crates/openlogi-cli/src/cmd/mod.rs. If you execute the binary without specifying a sub-command, the tool defaults to the list operation, ensuring immediate visibility of connected hardware.

Available OpenLogi CLI Commands

Device Enumeration (list)

The list command enumerates all connected Logitech HID++ devices and webcams. Implemented in crates/openlogi-cli/src/cmd/list.rs, this command first attempts to query the background agent for device states. When the agent is unreachable, it falls back to direct hardware enumeration to prevent blocking operations.

openlogi list

Keyboard Backlight Control (backlight)

Use the backlight command to read or set keyboard illumination via HID++ protocol 0x1982. The implementation in crates/openlogi-cli/src/cmd/backlight.rs supports status queries, binary states (on/off), gradual adjustments (dim/bright), toggling, and device-specific filtering.

openlogi backlight status --device "MX KEYS S"
openlogi backlight dim --lumens 75 --device "MX KEYS S"

Webcam Snapshot (snapshot)

The snapshot command captures a single frame from a Logitech webcam and writes it as a PNG file. This functionality resides in crates/openlogi-cli/src/cmd/snapshot.rs, providing headless image acquisition for automation workflows.

openlogi snapshot --output frame.png

UVC Camera Controls (camera)

For fine-grained webcam adjustment, the camera command reads and writes UVC image controls such as exposure and gain. The logic in crates/openlogi-cli/src/cmd/camera.rs exposes these low-level parameters through a type-safe CLI interface.

openlogi camera set --control exposure --value 30

Asset Bundle Operations (assets)

The assets command performs bulk operations against OpenLogi’s device asset mirrors. Currently, it provides a sync sub-command (implemented in crates/openlogi-cli/src/cmd/assets/mod.rs) that downloads every device’s bundle files from the fastest available mirror.

openlogi assets sync

Hardware Diagnostics (diag)

The diag command aggregates diagnostic tests and low-level write-path checks in crates/openlogi-cli/src/cmd/diag/. This namespace includes six specialized sub-commands:

• smartshift – Test SmartShift behavior (conflict-protected flags enforced via diag/smartshift.rs)
• lighting – Query or flash RGB lighting patterns
• wheel – Probe wheel resolution settings (diag/wheel.rs)
• dpi – Query DPI ranges for gaming mice
• controls – Read/write generic UVC controls
• battery – Display battery status

openlogi diag smartshift --leave-flipped
openlogi diag dpi --device "MX Master 3"

Standalone Lighting (light)

For Logitech’s Litra line and compatible standalone lights, the light command provides on/off toggles, brightness adjustment, and status queries. The implementation in crates/openlogi-cli/src/cmd/light.rs handles these devices separately from keyboard backlights.

openlogi light on --lumens 50

Practical Usage Examples

Combine these commands to build complete device management scripts:

1. Query specific device backlight status:

   openlogi backlight status --device "MX KEYS S"

2. Capture diagnostics for a mouse:

   openlogi diag wheel --device "MX Master 3"
   openlogi diag battery

3. Full system audit:

   openlogi list
   openlogi assets sync
   openlogi diag controls

Summary

• Seven primary commands cover enumeration (list), backlight control (backlight), webcam operations (snapshot, camera), asset management (assets), hardware diagnostics (diag), and standalone lighting (light).
• Default behavior routes bare openlogi invocations to the list command via run() in lib.rs.
• Modular architecture separates concerns across crates/openlogi-cli/src/cmd/, with each top-level command residing in its own implementation file.
• Diagnostic extensibility allows targeted testing of SmartShift, DPI, RGB lighting, and UVC controls through the diag namespace.

Frequently Asked Questions

What is the default OpenLogi CLI command?

If you execute the openlogi binary without specifying a sub-command, the tool automatically runs the list operation. This default dispatch logic is implemented in the run() function within crates/openlogi-cli/src/lib.rs, ensuring users immediately see connected devices.

How does the list command behave when the background agent is unavailable?

The implementation in crates/openlogi-cli/src/cmd/list.rs employs a fallback mechanism. When the background agent is unreachable, the CLI executes direct hardware enumeration instead of failing, maintaining functionality for standalone scripting environments.

Which diagnostic tests are available under the diag command?

The diag namespace provides six sub-commands located in crates/openlogi-cli/src/cmd/diag/: smartshift (tests adaptive scroll behavior), lighting (RGB pattern validation), wheel (resolution probing), dpi (range queries), controls (generic UVC manipulation), and battery (power status reporting).

Where is the top-level command structure defined?

The Command enum that registers all primary sub-commands resides in crates/openlogi-cli/src/cmd/mod.rs. This central registry maps user input to specific implementation files such as backlight.rs, snapshot.rs, and the diag/ subdirectory, creating a maintainable routing layer for the CLI.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}