CLI telemetry

Optional, anonymous usage data from the Restormel Testing CLI — what is collected, what is not, and how to opt out.

The restormel-testing CLI can send anonymous usage events to help improve the product. Telemetry is opt-in by default; you can disable it at any time (see below).

First run

The first time you run a substantive command (for example validate, run, report, doctor, or telemetry), the CLI may print a short notice to stderr explaining this policy and how to opt out. No response is required.

What we collect (when enabled)

Each event includes only:

CLI command name: run, validate, report, or doctor
Node.js version and OS platform (e.g. darwin, linux, win32)
Suite count and goal count (integers only)
Verdict summary: counts of goals in each of passed, failed, and indeterminate
CLI package version (for compatibility diagnostics)

What we do not collect

No source code, repository paths, or file contents
No suite names, goal names, URLs, or model identifiers
No API keys, tokens, or other secrets
No personal data or stable per-user identifiers

Where events are sent

Events are sent via HTTPS POST to the URL in RESTORMEL_TELEMETRY_URL when set; otherwise the default is https://telemetry.restormel.dev/v1/event. The collector must accept the CLI’s JSON body shape (anonymous counters only). If the service is unavailable, the CLI fails silently and your command still completes normally.

Opt out

Environment: set RESTORMEL_TELEMETRY=0 (or false / off / no) for the shell or CI job. Set to 1 (or true / on / yes) to force enable; the environment variable overrides the file preference.
Preference file: run restormel-testing telemetry disable. This saves your choice under ~/.restormel/telemetry.json. Use restormel-testing telemetry enable to turn sending back on.
Check status: restormel-testing telemetry status shows whether sending is enabled and why.