IF Commons GitHub

doctor

verbread

Check the runtime and tools, the layout, the file system, the hooks and the generated files, and say what to do about each.

Program ergonex-public. Origin ergonex.

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
--homeThe root of the workspace for this run (else $ERGONEX_HOME, else $HOME/workspaces).type=value, required=false, standard=false, humanOnly=false, valueName=DIR
--fetchAsk GitHub whether the token for reading packages may read them (the one check that uses the network).type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--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

ergonex doctor  # Check the workspace and say what to fix.
ergonex doctor --fetch  # Also ask GitHub whether the token may read packages.

Physical: what it is drawn as

ergonex doctor

cli-command. Check the runtime and tools, the layout, the file system, the hooks and the generated files, and say what to do about each.

PropertyValue
usageergonex doctor
wordsdoctor
tierpublic

ergonex_doctor

mcp-tool. Check the runtime and tools, the layout, the file system, the hooks and the generated files, and say what to do about each. (report, effect read, safe to repeat.)

PropertyValue
titleergonex doctor
toolNameergonex_doctor
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputshome, fetch
tierpublic

Not drawn

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

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