Home

reportmate-cli

reportmateutil is the admin command-line interface for ReportMate: one cross-platform Rust binary that talks to the ReportMate API over HTTPS and prints a table or JSON. It is named reportmateutil so that reportmate stays the name of the ReportMate app, which bundles it.

It is an admin tool, not an agent. It collects nothing from the machine it runs on; the device agents are reportmate-client-mac and reportmate-client-win.

What it does

• Covers the whole /api/v1 surface: fleet and device reads, module reports, applications usage and distribution, certificates, fleet-wide log sweeps, events and ingest failures, dashboard, health and metrics, API keys, usage-history and installs maintenance, and org settings. raw reaches any path with any method.
• Configures itself. The endpoint and credential come from the environment, the ReportMate app's saved connection, the device runner's preferences, an Entra sign-in through az, or an AWS deployment's Secrets Manager, in that order. reportmateutil config shows what it found.
• Prints JSON for scripts and agents with --output json; errors go to stderr with a non-zero exit code.
• Stays in step with the API: a contract test fails when the API's OpenAPI document has an operation the CLI has no command for.

Latest release: v2026.09.11.1807, built from the head of main.

Pages

Page	What is on it
Getting Started	Zero to a first query
Installation	Release assets, the macOS package, building from source
Commands	Every command, subcommand and flag, with the request each sends
Configuration	How the endpoint and credential are resolved, and every environment variable
Authentication	Credential types, headers, and the scope each command needs
Output Formats	Table, JSON and text output, streams, exit codes
Development	Build, test, the contract tests, releases
Troubleshooting	Failure modes with their actual error text

Where it sits

Repo	What it is
reportmate-api	FastAPI ingest and query backend
reportmate-app-web	Next.js dashboard
reportmate-client-win	Windows agent
reportmate-client-mac	macOS agent
reportmate-cli	This admin CLI, reportmateutil
reportmate-mcp	MCP server exposing the fleet to AI agents
terraform-azurerm-reportmate	Azure deployment module
terraform-aws-reportmate	AWS deployment module
selfhosted-docker-reportmate	Docker Compose stack
reportmate-website	Marketing site, reportmate.app

License

AGPL-3.0-or-later. A commercial license is available; see COMMERCIAL-LICENSE.md in the repo.