Reference¶
Authoritative, lookup-oriented descriptions of Lore's commands, file formats, and protocols.
What this folder is¶
Reference is the technical description of the machinery and how to operate it. Austere, neutral, factual. No instruction or explanation embedded; if you want to learn, the tutorials folder is the place, and if you want the why, see explanation.
Reference pages¶
- Lore CLI command reference — every
lorecommand, subcommand, argument, and flag, generated fromlore --markdown-help. - Lore CLI configuration reference — every field in the per-repository
config.tomland user-levelcli.toml, with each field's type, default, and on-disk location. - Lore Server configuration reference — every
loreserverCLI flag, config-file layer, and settings field, including the AWS, DynamoDB, Consul, and hook plugin backends.
Suggested starting points¶
- Writing a new Reference page? Start at the doc-standards walkthrough.
- Reference template. Copy this when starting a new Reference.
See docs/README.md for the full docs structure.