IF Commons GitHub

tools

verbread

List the tool catalog and what is installed, verify the installed tools, or export the catalog (oscal, spdx, cyclonedx); installs nothing.

Program ergonex-operator. 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

Operands

OperandMeaning
COMMANDlist (the default), verify or export.
FORMATFor export: oscal, spdx or cyclonedx.

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
--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 tools  # List the catalog and what is installed.
ergonex tools verify  # Verify the installed tools against their install records.
ergonex tools export spdx  # Write the inventory as SPDX.

Physical: what it is drawn as

ergonex tools

cli-command. List the tool catalog and what is installed, verify the installed tools, or export the catalog (oscal, spdx, cyclonedx); installs nothing.

PropertyValue
usageergonex tools
wordstools
tierpublic

ergonex_tools

mcp-tool. List the tool catalog and what is installed, verify the installed tools, or export the catalog (oscal, spdx, cyclonedx); installs nothing. (report, effect read, safe to repeat.)

PropertyValue
titleergonex tools
toolNameergonex_tools
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputshome, COMMAND, FORMAT
tierpublic

Not drawn

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

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