Skip to content
Rubin Bhandari edited this page Sep 23, 2026 · 3 revisions

Shelf wiki

Everything beyond the README. Verbose command reference first, then recipes, then FAQ and troubleshooting.

Pages

Page Contents
Usage Commands at a glance, global flags, environment variables, shell startup, the stdout/stderr contract, and exit codes.
Command reference Every command with its flags, the update mode matrix, current update behavior, and examples.
Configuration Sources, every plugin field, file selection, a config with every field, and profiles.
Templates Built-in templates, template syntax, functions, filters, and the values available to them.
Lock files The runtime lock versus the revision manifest, and what belongs in version control.
How shelf works The render pipeline, directory layout, staleness rules, load order, and locking.
Recipes Worked configs for common setups, from fresh bootstrap to uninstall.
FAQ Short answers to the failures people actually hit.
Troubleshooting doctor, status, verbose output, and an error message table.

Clone this wiki locally