Getting Started

Getting Started

The shortest path from nothing to a fleet listing.

1. Get the binary

On a machine that runs the ReportMate app, reportmateutil is already installed. Otherwise download the package or tarball for your platform from the Releases page and put the binary on your PATH. See Installation.

2. See what it found

The CLI finds its endpoint and credential on its own: from the environment, the ReportMate app's saved connection, an Entra sign-in through az, the device runner's preferences, or an AWS deployment's Secrets Manager. Check what it resolved:

reportmateutil config

If it reports no endpoint or no credential, set them explicitly:

export REPORTMATE_API_URL=https://reportmate.example.com

export REPORTMATE_API_KEY=rm_example_notarealsecret

For an Entra-protected API, sign in with az login instead of setting a key; the CLI reads the audience from the API and asks az for a token. See Configuration for the full order.

3. Check the connection

reportmateutil health

Add --ready to include the API's database probe.

reportmateutil health --ready

4. List the fleet

reportmateutil devices --limit 20

You get a table of serial, device name, platform and last seen, with the server's total underneath when it sends one.

+-----------+-----------+----------+----------------------+
| Serial    | Name      | Platform | Last Seen            |
+=========================================================+
| SERIAL123 | design-01 | Windows  | 2026-09-03T14:02:11Z |
|-----------+-----------+----------+----------------------|
| SERIAL456 | design-02 | macOS    | 2026-09-03T13:55:40Z |
+-----------+-----------+----------+----------------------+
total: 2

5. Look at one device

Device detail is deeply nested, so it always prints JSON.

reportmateutil device SERIAL123

Narrow it to one module, or to a quick summary:

reportmateutil device SERIAL123 module installs

reportmateutil device SERIAL123 info

6. Use it from a script

--output json is global. Every command prints JSON with it; most print JSON without it.

reportmateutil devices --output json | jq -r '.devices[].serialNumber'

Next: Commands for the full surface, Authentication for which credential each command needs.