@rtidx/cli

rtidx

Scan a repository for supply-chain and secrets risk from the terminal — the CLI companion to RTIdx.

Install

npm install -g @rtidx/cli

Requires Node.js >= 20.

Usage

rtidx login                                    # sign in via your browser
rtidx logout                                   # sign out on this machine
rtidx whoami                                   # show who's signed in
rtidx check <repo-url> --context <context>     # scan a repository
rtidx config set api-url <url>                 # persist a default API URL
rtidx --version                                # print the installed version

<repo-url> must be a public GitHub or Bitbucket repository URL.

--context is required and must be one of: recruiter, client, unsolicited, dependency, self.

check options

Flag	Default	Description
--context <value>	(required)	Why you're scanning this repo
--json	false	Print machine-readable JSON instead of a human-readable report. Failures also write a second, schema-versioned JSON line to stderr ({schemaVersion, status: "error", code, message}) alongside the usual human-readable one, so a script has something to parse either way.
--fail-on <band>	high_risk	Minimum risk band that causes a non-zero exit code (low_risk, suspicious, high_risk, malicious)
--wait <minutes>	10	How long to wait for the scan to finish before timing out
--quiet, -q	false	Suppress progress lines ("Still scanning...") on stderr — useful for CI logs. Errors and the final result are never suppressed.

rtidx config

Persists settings under ~/.rtidx/config.json (%APPDATA%\rtidx\config.json on Windows, or $XDG_CONFIG_HOME/rtidx/config.json if set — same directory as the token file). Currently supports one key:

rtidx config set api-url https://rtidx.example.internal
rtidx config get api-url
rtidx config unset api-url

Precedence: the RTIDX_API_URL environment variable always wins over a persisted setting, which wins over the default (https://www.rtidx.com).

Exit codes

Code	Meaning
0	Scan completed, risk band below --fail-on
1	Scan completed, risk band at or above --fail-on
2	Usage error (bad arguments, not signed in)
3	Authentication error — run rtidx login
4	Rate limited
5	Network error, or timed out waiting for the scan

License

MIT