Type to search pages and rules.

Browse pages

Generate Provisions

litespec provisions writes the provision index that resolves every identifier to its page.

Markdown

Name#

litespec provisions writes the provision index that resolves every identifier to its page.

Synopsis#

Shell
litespec provisions [--root <path>] [--check] [--help]

Description#

This command rebuilds docs/reference/provisions.md from the active standards, so a citation reaches its heading in one step. The page carries each provision with its verification mark and its evidence.

Run it after adding, renaming, or removing a provision. The next run overwrites a hand edit.

Arguments#

None. Everything passes through options.

Options#

OptionDefaultEffect
--root <path>the LiteSpec checkout the tool ships inSelects the LiteSpec repository to read.
--checkoffCompares the page with the active standards and writes nothing.
--helpoffPrints the synopsis, the options, and the exit codes, then exits zero.

Exit codes#

CodeMeaning
0The page was written, or --check found it current.
1--check found the page stale.
2The usage is invalid.

Examples#

Rebuild the page after a provision change:

Shell
litespec provisions

Compare without writing, which is what continuous integration runs:

Shell
litespec provisions --check

Underneath#

litespec validate reads the same builder and reports a stale page as PROVISIONS_STALE. Nothing beneath this command is separately runnable.