IF Commons GitHub

init

verbmutate

Make the root and the workspace's own area, write a starter manifest where there is none, and put ergonex on your path.

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
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
--no-installMake the root only: do not put ergonex on the path.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--no-pathOn Windows, do not add the folder of the command files to your path.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 init  # Make the workspace at $ERGONEX_HOME (else $HOME/workspaces) and put ergonex on your path.
ergonex init --no-install  # Make the workspace and leave your path as it is.

Physical: what it is drawn as

ergonex init

cli-command. Make the root and the workspace's own area, write a starter manifest where there is none, and put ergonex on your path.

PropertyValue
usageergonex init
wordsinit
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.