Skip to content

Reference

Complete reference documentation for the TrustSight CLI, the Python API, rules, configuration, report schema, evidence tiers, and exit codes.

  • CLI: review, inspect, history, config commands with flags, arguments, and exit codes.
  • Python API: trustsight.api, the supported programmatic interface. The same flows the CLI runs, returning dataclasses instead of printing.
  • Rules: R001-R140 (R-series, TOML-configurable and code-emitted), C001-C007 (code, structural) and D001-D004 (dependency) with severity, weight, target, and description for each. Organised by category, one page per category, with the engine's own mechanics in the system reference.
  • Configuration: Every config.toml, rules.toml, and trusted_domains.toml key with type, default, and effect. Environment variable reference.
  • IOC Federation: signed known-bad indicator baselines (domains, hashes, package names), the baseline format, matching, expiry, and attribution.
  • Report Schema: PackageFact JSON structure used by inspect and stored in the database.
  • Baseline Keys: the pinned ed25519 key that signed corpus baselines verify against, and the per-source keys for IOC federation.
  • Evidence Tiers: A (structural), B (priors/context), C (history/novelty), D (verification) taxonomy with maturity gating and cold-start behaviour.
  • Exit Codes: 0 (analysis completed), 2 (error), and why a flag is not an exit code.