Commands
everything wiki does, and how to ask for it
wiki is the one program the tool installs, and each job it does is a command typed after it.[1]
The settings files it reads are described on wiki.toml, Front matter
and PICTURES.toml.
Usage
Every command is typed the same way, as the program's help prints it.[1]
wiki [-h] [--version] [--root ROOT] [--wiki WIKI]
{build,check,sync,serve,publish,user,bless} ...
Commands
| Command | Job |
|---|---|
wiki build |
renders the pages into the site[2] |
wiki check |
lists every reason the wiki is not fit to read |
wiki serve |
builds the site and serves it on this machine |
wiki sync |
writes the skill into the project and records the release |
wiki bless |
records that a picture is still true, and why |
wiki publish |
builds the site with clean addresses, for a host |
wiki user |
builds only the pages marked for users, with everything internal removed |
Typing wiki with no command is the same as wiki serve.[3]
Shared options
| Option | Meaning | Default |
|---|---|---|
--root ROOT |
the project[4] | the working directory |
--wiki WIKI |
the folder the wiki lives in, relative to the working directory rather than to ROOT[5] |
docs/wiki inside ROOT |
-h, --help |
the command's own help, then exit[6] | off |
Both --root and --wiki may come before the command or after it, so a wrapper script can add them to
whatever it is handed.[4] wiki --version prints the release, and is given before any command.[7]
Exit codes
Every command exits with 0 when it did what it was asked, 1 when something is wrong with the wiki, and 2 when it was misused: an option it does not know, no wiki where it was pointed, an output folder the tool did not make, or a port already in use.[8] A problem is printed as one sentence.[8]
Every message names what to do.[?] Some name only what is wrong, such as wiki: no wiki at nowhere,
wiki: missing.png has no entry in PICTURES.toml and the parser's own
wiki: error: unrecognized arguments: --unknown.[9]