IF Commons GitHub

doctor

verbread

Say what is wrong with this checkout (dependencies, links, Node, Bun, stale generated files) and what to do about it.

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 doctor  # What is wrong with this checkout, in the order to fix it, and the command for each.

Physical: what it is drawn as

repoctl doctor

cli-command. Say what is wrong with this checkout (dependencies, links, Node, Bun, stale generated files) and what to do about it.

PropertyValue
usagerepoctl doctor
wordsdoctor
tierpublic

repoctl_doctor

mcp-tool. Say what is wrong with this checkout (dependencies, links, Node, Bun, stale generated files) and what to do about it. (report, effect read, safe to repeat.)

PropertyValue
titlerepoctl doctor
toolNamerepoctl_doctor
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.