IF Commons GitHub

modules

verbread

List every module with its source and summary; --probe asks the modules on the PATH for their manifest.

Program ergonex-administrator. 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
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
--probeRun each module registered or found on the PATH, to ask it for --ergonex-manifest (it runs nothing else). A module on the PATH is run only after you say yes to it, or with --trust; it is not sandboxed.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--trustWith --probe, do not ask before running a module found on the PATH.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--probe-timeoutWith --probe, how long to wait for each module to answer (the default is 5); a module that does not answer in time is listed as opaque and is a warning, and the run goes on.type=value, required=false, standard=false, humanOnly=false, valueName=SECONDS
--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 modules  # Name every module and where it was found; run none.
ergonex modules --probe --trust  # Ask each module on the PATH for its manifest without asking first.

Physical: what it is drawn as

ergonex modules

cli-command. List every module with its source and summary; --probe asks the modules on the PATH for their manifest.

PropertyValue
usageergonex modules
wordsmodules
tierpublic

Not drawn

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

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