README
¶
nova-check
What it is
nova-check: checks over markdown records and repositories, each finding named by file and line
Why use it
Catch broken links and other problems in your records.
Install
go install github.com/mas-bandwidth/nova-tools/cmd/nova-check@latest
nova-check version
First run
The transcript below is copied from the first run in docs/TESTS.md, which cmd/nova-check/firstrun_test.go executes line for line; a docs test holds this copy to that record.
Fixture: cmd/nova-check/testdata/example-self.
$ nova-check quickstart --dir ./self
QUICKSTART RUN dir=./self checks=2: links, then nocode
LINKS OK dir=./self files=4 links=3 excluded=0 broken=0
NOCODE OK dir=./self files=5 deny-list=floor-list findings=0
QUICKSTART OK done=2 worst-exit=0 next=kernel,attest,floors,corpus (kernel wants a size budget, attest a manifest of what a full boot reads, floors a derived copy and its source, corpus a ledger of protected lines: nova-check help)
$ nova-check kernel --file ./self/docs/SEED-CORE.md --max-bytes 4000
KERNEL OK file=./self/docs/SEED-CORE.md bytes=771 budget=4000 findings=0
Verbs
The nova-check section of the command reference documents every verb's flags, effect and exit codes.
versionquickstartattestlinkskernelnocodefloorscorpushygienedogfoodconvergencespelling
Spec
The contract is docs/SPEC-CHECK.md.
quickstart --json returns one result object. Its facts.checks array contains
links and nocode results with their own statuses, counts, findings and truncation
metadata. Overall total, passed, failed, refused and findings counts are
independent of --max; the process exits with the worse check's exit code.
dogfood gate --json returns the same gate verdict in facts.verdict, alongside
verified_receipts (validated receipt files, including each path),
uncovered_verbs, missing_authors, findings, summary and ledger rows.
Each JSON listing respects --max; more retains its shown/total counts.
Missing authors are reported independently; they do not add a new gate rule.
Uncovered verbs fail the gate when --require-all is set. Diagnostics remain in
the JSON object; malformed input and missing arguments preserve failure/refusal
status and exit codes. Without --json, both commands retain their typed lines.
Documentation
¶
Overview ¶
nova-check runs checks over markdown records and repositories (SPEC-CHECK.md): quickstart (links, then nocode), boot attestation, link integrity, the kernel size budget, the self/machinery separation (nocode, and nocode --staged over the git index), the floor-set parity of a derived door and its source, the protected corpus, branch hygiene, the dogfood ledger (record, ledger, gate), convergence and spelling. Exit 0 pass, 1 check failed, 2 could not run.
Every path and every budget comes from a flag. There are no defaults: a missing flag is a refusal, never a guess. Three verbs write, each only when asked and each with --dry-run: dogfood record appends a receipt, spelling --write edits files, convergence --state stores its streak.
nova-check version: which build is running. A refusal, a green or a pasted line is evidence about a build, so the binary says which one it is. The version is read from the build itself by pkg/buildinfo, which holds the resolution order and the shape of the line for every tool in this repository, so each answers in one spelling; it is never a constant maintained by hand, which would be wrong at the first commit after a release.
Source Files