Skip to content

toolroom.index.build

Materialise every record into the index: a strongroom store and its pointer.

The index is a strongroom store served as static files, one tree per tool holding the tool axis, each version's deployment per host and its surface as one blob, and beside it pointer.json naming each tool's current tree. A build into a directory that already holds one reads its pointer and reuses every tool whose record did not move; --from-genesis ignores the pointer and rebuilds every tool, and two builds from genesis land the same objects and the same pointer.

Declared as a docs generator, so the site's build writes the index under docs/tools and the site's deploy serves it at tools/.

fm toolroom.index.build [--into=VALUE] [--from-genesis]
Parameter Type Default Description
--into=VALUE "" the index root; omitted = docs/tools in the workspace
--from-genesis flag false ignore the build already there and materialise every tool

Returns: Built {into, tools, rebuilt, reused, dropped}

Field Type
into text
tools a mapping of text
rebuilt a list of text
reused a list of text
dropped a list of text

Example

$ fm toolroom.index.build --from-genesis