IF Commons GitHub

shell print

verbread

Print the snippet for a shell (bash, zsh, fish, pwsh, nu) on standard output; it writes nothing.

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

Operands

OperandMeaning
SHELLOne of bash, zsh, fish, pwsh, nu.

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 shell print bash  # Print the snippet for bash.

Physical: what it is drawn as

ergonex shell print

cli-command. Print the snippet for a shell (bash, zsh, fish, pwsh, nu) on standard output; it writes nothing.

PropertyValue
usageergonex shell print
wordsshell, print
tierpublic

ergonex_shell_print

mcp-tool. Print the snippet for a shell (bash, zsh, fish, pwsh, nu) on standard output; it writes nothing. (report, effect read, safe to repeat.)

PropertyValue
titleergonex shell print
toolNameergonex_shell_print
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputshome, SHELL
requiredSHELL
tierpublic

Not drawn

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

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