docs build
verbmutateBuild the documentation site of this repository with the documentation generator, into the folder its configuration names.
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.
| Property | Value |
|---|---|
kind | action |
effect | mutate |
idempotent | true |
audience | both |
tier | contributor |
dryRun | true |
check | false |
reachChannels | local, mcp |
reachReadOnly | false |
reachNeedsTty | false |
reachRunsAs | caller |
reachConfirmation | none |
Options
| Option | Meaning | Properties |
|---|---|---|
--out | The folder to build into (the configuration's docs.out by default). | type=value, required=false, standard=false, humanOnly=false, valueName=DIR |
--json | Write one JSON document and nothing else for a person. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--quiet | Show only how it ended. | type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--verbose | Show every step as it happens. | type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--color | Use colour where the terminal shows it (--no-color turns it off). | type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true |
--non-interactive | Never ask a question: where one is needed, fail and say so. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--dry-run | Show what would change and change nothing. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
Examples
repoctl docs build # Build the site into the folder the configuration names.
repoctl docs build --dry-run # Say what the generator would be asked, and build nothing.Physical: what it is drawn as
repoctl docs build
cli-command. Build the documentation site of this repository with the documentation generator, into the folder its configuration names.
| Property | Value |
|---|---|
usage | repoctl docs build |
words | docs, build |
tier | contributor |
repoctl_docs_build
mcp-tool. Build the documentation site of this repository with the documentation generator, into the folder its configuration names. (action, effect mutate, safe to repeat.)
| Property | Value |
|---|---|
title | repoctl docs build |
toolName | repoctl_docs_build |
readOnlyHint | false |
destructiveHint | false |
idempotentHint | true |
inputs | out, dryRun |
tier | contributor |
Not drawn
- rest: its reach policy does not name the rest channel