Skip to content
NOQTIS

noqtis-report(1)

noqtis-report — check a capsule and write a report of it

noqtis report [-p | --pub key.pub] [-f | --format md | txt] [-o | --out file] [-j | --json] [--github] dir

noqtis report checks the capsule in dir as noqtis-check(1) does and its data record as noqtis data check does, once, and writes a report of both (nqdrpt(3)): whether every check passed and how many failed, each check of the capsule, then what the record says of the data (sources, schemas, drift summaries, environment, steps, recorded checks, commitments, citation) and each check of the record, named ‘data.check’. A folder that is not sealed fails: its report says so in place of the capsule's checks.

In Markdown, a value from the record never breaks its line or its table cell: a line break in it is a space, and each character Markdown could read as markup (‘\ ` * _ [ ] < > | # ~ & !’) gets one backslash before it. In plain text a line break is a space too, and nothing else changes.

, --pub key.pub
the key the seal must carry, as for noqtis-check(1); without it, the key inside the seal is trusted
, --format md |
Markdown (the default) or plain text
, --out file
write the report to file instead of standard output
, --json
print, instead of the report (which -o still writes), one line of JSON: 
{"capsule":"<dir>","ok":<bool>,"status":"passed"|"failed",
 "sealed":<bool>,"total":<n>,"failed":<n>,"verified":<n>,
 "changed":<n>,"checks":[{"check":"<name>","ok":<bool>,
 "detail":"<text>"},...]}

verified counts the sealed files that match, and changed those changed or missing and the files added since the seal.

first print, for each failed check, a GitHub Actions workflow command

::error title=noqtis <check>::<dir>: <detail>

with ‘%’, carriage return and line feed (and in the title ‘:’ and ‘,’) written as ‘%25’, ‘%0D’, ‘%0A’, ‘%3A’ and ‘%2C’

0
every check passed
1
a check failed, or the folder is not sealed
2
a usage or file error, or a folder with neither a seal nor a data record

$ noqtis report -p release.pub -o report.md results
$ noqtis report -f txt results | head -3
noqtis report: results
Passed: 0 of 27 checks failed

noqtis-check(1), noqtis-data(1), nqdrpt(3), noqtis-data(5)