Skip to content

CLI reference

tsdive run

Walk one plan over several archives into one evidence ledger.

A refused or failed step is a row of the ledger and does not change the exit status: 0 when the ledger holds at least one profile or finding, 2 when the plan cannot be read or no step produced a result. With --strict the rows decide it: 2 when errors is not empty, else 3 when refusals is not empty, else 0.

The usage walkthrough has a section on it.

Usage

usage: tsdive run [-h] [-o DIR] [--strict] [--no-color] plan

Options

Argument Value Default Description
plan required TOML plan naming archives, windows and steps
-o, --out DIR directory for ledger.json, ledger.txt and report.html; omitted, tsdive-run/ beside the plan
--strict exit 2 when a step filed an error and 3 when a step was refused, as the single commands do
--no-color plain text, no ANSI colour (NO_COLOR does the same)

Example

$ tsdive run examples/plans/demo.toml
run demo.toml   2 archives   6 steps   profiles 2   findings 7   refusals 1

REFUSAL  mspc   demo:FIC101.PV, demo:TIC101.PV
  [MspcAlignmentError] aligned coverage 0.867 below required 0.95; refusing to
  interpolate across tags

wrote     examples/plans/tsdive-run/ledger.json
          examples/plans/tsdive-run/ledger.txt
          examples/plans/tsdive-run/report.html