IF Commons GitHub

apply

verbmutate

Carry out the plan: clone, fast-forward, configure and write generated files; never delete work, never change the host.

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
dryRunfalse
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
--fetchFetch each repository's remote first, so that ahead and behind are against the remote as it is now (the only use of the network).type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--allow-destructiveCarry out a destructive action (removing a generated file that is no longer generated); without it the action is reported as skipped.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--forceReplace a generated file that was edited by hand.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--waitWait for another run of ergonex on this workspace instead of refusing.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

Examples

ergonex apply  # Clone what is missing, fast-forward what is behind, and write the generated files.
ergonex apply --allow-destructive  # Also remove a generated file that is no longer generated.

Physical: what it is drawn as

ergonex apply

cli-command. Carry out the plan: clone, fast-forward, configure and write generated files; never delete work, never change the host.

PropertyValue
usageergonex apply
wordsapply
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.