IF Commons GitHub

docs serve

verbmutate

Build the documentation site and serve it on a loopback port of this computer until the run is stopped; nothing is uploaded.

Program repoctl-releaser. Origin repoctl.

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
tiercontributor
dryRuntrue
checkfalse
reachChannelslocal
reachReadOnlyfalse
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Options

OptionMeaningProperties
--portThe loopback port to serve on (0 lets the system choose).type=value, required=false, standard=false, humanOnly=false, valueName=PORT, default=4173
--forStop after this many seconds (else it serves until it is interrupted).type=value, required=false, standard=false, humanOnly=false, valueName=SECONDS
--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

repoctl docs serve  # Build the site and serve it on http://127.0.0.1:4173/ until Ctrl-C.
repoctl docs serve --port 0 --for 30  # Serve on a port the system chooses, and stop after 30 seconds.

Physical: what it is drawn as

repoctl docs serve

cli-command. Build the documentation site and serve it on a loopback port of this computer until the run is stopped; nothing is uploaded.

PropertyValue
usagerepoctl docs serve
wordsdocs, serve
tiercontributor

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.