wiki build

render the pages into the site

Contents
  1. 1Usage
  2. 2Output
  3. 3Exit codes
  4. 4References

wiki build renders every page into site inside the wiki folder, docs/wiki/site by default, and records the day each changed page last changed.[1] What the site holds is described on Site.

Usage

It takes only the options every command shares.[2]

wiki build [-h] [--root ROOT] [--wiki WIKI]
wiki build

Output

It prints each page's word count and citations, then the totals, the words in the collected goals, and how many pages it wrote and where.[3] It also names any draft waiting on the owner, and warns while the reading budgets are uncalibrated.[3] On a wiki of three pages, with the folder on the last line being wherever the wiki sits:[3]

wiki: goals                              25 words    0 cited    0 missing
wiki: index                               8 words    0 cited    0 missing
wiki: refunds                            22 words    1 cited    1 missing
wiki: 1 source cited, 1 claim marked as having no source
wiki: the collected goals read in 17 words
wiki: these budgets are PROVISIONAL -- 500 words a page, 3500 for the collected goals. What this project's readers actually read has not been measured; until it is, the numbers are a guess that happens to be enforced. Set budget.calibrated in wiki.toml once it is.
wiki: 3 pages written to /path/to/notes/docs/wiki/site

It refuses to write into a folder that is not empty and was not made by an earlier build.[4]

Exit codes

Code Condition Message
0 the site is written[5] wiki: 3 pages written to /path/to/notes/docs/wiki/site
1 a problem stops the build[6] the problem, such as wiki: there is no goals.md; the collected goals need a page to be collected onto
2 there is no wiki where it was pointed[5] wiki: no wiki at nowhere
2 the site folder holds files the tool did not write[5] wiki: /path/to/notes/docs/wiki/site is not empty and was not written by this tool; remove it yourself if you meant to replace it
2 an option it does not know[5] wiki: error: unrecognized arguments: --unknown
Last updated 14 September 2026Last audited never247 wordsabout 1 minute to read6 sources cited0 claims with no source