IF Commons GitHub

setup

verbmutate

Make the root, install the pinned tools and set what the host needs; --dry-run shows the plan and changes 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
kindaction
effectmutate
idempotenttrue
audienceboth
tierpublic
dryRuntrue
checkfalse
reachChannelslocal
reachReadOnlyfalse
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
--git-includeAdd one marked [include] of the generated git.auto.conf to your global Git configuration, after showing the change and, where a person can be asked, asking.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
--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
--dry-runShow what would change and change nothing.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false

Examples

ergonex setup --dry-run  # Show the plan and change nothing.
ergonex setup  # Carry the plan out.
ergonex setup --git-include  # Also add the generated Git configuration to yours, after showing the change.

Physical: what it is drawn as

ergonex setup

cli-command. Make the root, install the pinned tools and set what the host needs; --dry-run shows the plan and changes nothing.

PropertyValue
usageergonex setup
wordssetup
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.