IF Commons GitHub

check

verbread

Run every check of the repository (generated files, specifications, rules, versions) and say what is wrong in one report.

Program repoctl-contributor. Origin repoctl.

Governance: the action

What the verb is and may do, as governance says it. Each annotation is expressed by the surfaces or says why it is not.

PropertyValue
kindreport
effectread
idempotenttrue
audienceboth
tierpublic
dryRunfalse
checkfalse
reachChannelslocal, mcp
reachReadOnlytrue
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Options

OptionMeaningProperties
--jsonWrite one JSON document and nothing else for a person.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--sarifWrite the findings as SARIF 2.1.0 and nothing else.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--quietShow only how it ended.type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false
--verboseShow every step as it happens.type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false
--colorUse colour where the terminal shows it (--no-color turns it off).type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true
--non-interactiveNever ask a question: where one is needed, fail and say so.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false

Examples

repoctl check  # Run every check: the generated files, the specification kits, the rules of Mizan, the versions and the constants that say a version.
repoctl check --json  # The same, as one JSON document: each section with its findings, their codes and their fixes.

Physical: what it is drawn as

repoctl check

cli-command. Run every check of the repository (generated files, specifications, rules, versions) and say what is wrong in one report.

PropertyValue
usagerepoctl check
wordscheck
tierpublic

repoctl_check

mcp-tool. Run every check of the repository (generated files, specifications, rules, versions) and say what is wrong in one report. (report, effect read, safe to repeat.)

PropertyValue
titlerepoctl check
toolNamerepoctl_check
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
tierpublic

Not drawn

  • rest: its reach policy does not name the rest channel

Titles, headings, exports, tables, columns and requirements. Esc closes.