IF Commons GitHub

render

verbmutate

Write the generated files from the manifest; --dry-run shows each difference as a diff, --check ends with findings where a file would change.

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
checktrue
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
--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
--dry-runShow what would change and change nothing.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--checkChange nothing; end with findings where something would change.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false

Examples

ergonex render  # Write the generated files.
ergonex render --dry-run  # Show each difference as a unified diff and write nothing.
ergonex render --check  # Write nothing; end with findings if a file would change.

Physical: what it is drawn as

ergonex render

cli-command. Write the generated files from the manifest; --dry-run shows each difference as a diff, --check ends with findings where a file would change.

PropertyValue
usageergonex render
wordsrender
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.