Open source · Product & Operations

Operating Metric Catalog

Keep operating metric names, definitions, owners and decision uses together.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

TOOLID=operating-metric-catalog. Zero-dependency Node 22+ reporter for local, exported metric catalogs. It reads one JSON document and writes only a report to stdout. The package exports TOOLID, LIMITS, and validateCatalog(document) for direct use.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+.

Run the checked-in example

node bin/operating-metric-catalog.mjs --root examples --input passing.json
node bin/operating-metric-catalog.mjs --root examples --input failing.json
npm run check

Read the result

The examples exit 0 and 1, respectively. --help prints usage; --human adds a brief summary on stderr. Input must be a file inside the real --root; an escaping symlink is refused. The CLI never fetches a dashboard or writes to the input. Standard output is a deterministic version 1 JSON report; diagnostics and bad usage go to standard error.