IF Commons GitHub

docs check

verbread

Build the documentation site into a temporary folder and say every finding, writing nothing in the repository.

Program repoctl-releaser. 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 docs check  # Build the site into a temporary folder and say every finding; nothing is written in the repository.

Physical: what it is drawn as

repoctl docs check

cli-command. Build the documentation site into a temporary folder and say every finding, writing nothing in the repository.

PropertyValue
usagerepoctl docs check
wordsdocs, check
tierpublic

repoctl_docs_check

mcp-tool. Build the documentation site into a temporary folder and say every finding, writing nothing in the repository. (report, effect read, safe to repeat.)

PropertyValue
titlerepoctl docs check
toolNamerepoctl_docs_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.