README
¶
nova-card
What it is
nova-card: writes a directory of pre-linted briefs from a ledger, a findings file or a tool's help
Why use it
Turn a ledger, a findings file or a tool's help into briefs the sprint admits. nova-card is pre-alpha: not ready for production use.
Install
go install github.com/mas-bandwidth/nova-tools/cmd/nova-card@latest
nova-card version
First run
The transcript below is executed line for line by the docs tests; the full record is in docs/TESTS.md.
Fixture: cmd/nova-card/testdata/findings.tsv, a reader's findings on two
files, typed as ./cmd/nova-card/testdata/findings.tsv from the root of a
checkout; ./cards is a directory the first line creates.
$ nova-card generate --from findings --file ./cmd/nova-card/testdata/findings.tsv --repo example/repo --base dev --sha 0123456789abcdef0123456789abcdef01234567 --out ./cards
CARDS OK dir=./cards cards=2 waves=1 tier=pro
$ nova-card lint --card ./cards/finding-internal-bus-send.md
LINT OK file=./cards/finding-internal-bus-send.md
$ nova-card lint --card ./cards/finding-cmd-nova-bus-main.md
LINT OK file=./cards/finding-cmd-nova-bus-main.md
Verbs
The nova-card section of the command reference documents every verb's flags, effect and exit codes.
generatelinttemplateversionhelp
Spec
The contract is docs/SPEC-CARD-CONTRACT.md.
Documentation
¶
Overview ¶
Command nova-card generates a directory of pre-linted briefs from a structured source, ready for one `nova-sprint add --brief-dir`. The planning is internal/cardgen (pure functions over text, docs/SPEC-CARD-CONTRACT.md, "generated cards"); this file is the transport: it reads the source from a checkout, resolves the base, runs the lint over every brief and writes the directory, or refuses to with the red line printed.
nova-card version: which build is running.
A refusal, a green or a line pasted into a note is evidence about a BUILD, so the binary says which one it is. The version is not a constant kept by hand, which is wrong at the commit after a release: it is read from the build by internal/buildinfo, which holds the resolution order and the shape of the line for every nova tool, so that each answers the question in one spelling.
Source Files