CLI

Last updated: Sep 26, 2026View as Markdown

The Trooth command-line interface (CLI) reads a company's public record from your terminal and prints it as text, or as JSON, a machine-readable format, when you pass --json.

GET/directory/api/vendorsPublic, no key

Read any company's public record from your terminal. No key, no account, and nothing about you is sent: it is a read of a record that is already published. A company with no record exits 1; a Trooth that could not be reached exits 3, so a pipeline never mistakes an outage for a company with no record.

Install

bash

# Published to npm as `trooth`. Zero dependencies, Node 18+.

npm install -g trooth

# `trooth --version` prints the version you installed.

Commands

# No install, no key, no account. Reads a published public record.
npx trooth check stripe.com

What your own infrastructure declares

trooth lint is the local half: it reads what the infrastructure in a directory declares and prints those declarations as facts, with a canonical digest over them. It issues no verdict and checks nothing against any named standard, and nothing leaves the machine. The CLI's global flags are --json, --help and --version, and TROOTH_API sets the base URL that trooth check reads. Exit codes and the full reference are on the CLI page.