How it works

What it is

litmus-cli is a single command-line tool for the Litmus product APIs. Every function of the Litmus SDK, more than 600 of them across Litmus Edge, Litmus Edge Manager and Litmus Unify, is one command away, with results printed as JSON.

Two ways to use it

• On your machine. One install command on macOS or Linux, or a single binary for Windows. Best for shell scripts, CI pipelines and AI agents.
• On Litmus Edge. Launch Litmus CLI Web from the Litmus Edge Marketplace and open it in a browser: a terminal with the CLI already installed, running next to the device it talks to. Nothing to install, and it reaches devices that are only visible on the plant network.

Both run the same CLI and accept the same commands.

What it does

• Sign in from the browser: litmus-cli login creates a dedicated API credential; your password is not stored
• Look around: devices, tags, drivers, apps, digital twins, flows and component versions, each as one short command
• Live tag values from the DataHub broker, and history from the time-series database, with one-command credential setup
• Call anything: list shows every function and its arguments, run calls it, --help prints a ready-to-fill example
• Many devices: named profiles, one per Edge, Edge Manager or Unify
• Self-updating: litmus-cli update installs the latest release in place

Built for AI agents

Coding agents such as Claude Code and Cursor can drive the CLI directly: it lists its own functions, describes their arguments, rejects misspelt ones with a suggestion, and returns JSON that pipes into jq. Writes are included, so keep a human on anything that changes a device.

Install

curl -fsSL https://raw.githubusercontent.com/litmusautomation/litmus-sdk-releases/main/install.sh | sh

Binaries for macOS arm64, Linux amd64/arm64 and Windows amd64, with a SHA256SUMS file, are on the releases page under cli-v* tags.

Documentation

• Litmus CLI Reference
• Agent guide
• Releases and changelogs