Browse Docs pages
Rotkeeper Reference
This document serves as a straightforward reference for the Rotkeeper toolkit, detailing the scripts, configuration files, and standard operating procedures.
Default Pipeline
The standard lifecycle of managing content in Rotkeeper follows this sequence:
init: Initialize the workspace (reseeds, installs assets, renders, scans).render: Convert markdown files into HTML tombs and package a timestamped backup.assets: Generate the asset manifest and copy static files to output.pack: Archive the rendered HTML into a shareable versioned tarball.scan: Audit manifest integrity to ensure nothing is missing or orphaned.
Core Scripts (bones/scripts/)
| Script | Purpose | Inputs | Outputs |
|---|---|---|---|
rc-init.sh |
Initializes the environment. | Repo state | Reseeded files, initial render, logs |
rc-render.sh |
Converts markdown into HTML tombs. | home/content/*.md |
HTML in output/, backup tarball |
rc-pack.sh |
Archives output into a versioned tarball. | output/ HTML files |
bones/archive/tomb-*.tar.gz |
rc-scan.sh |
Verifies manifest entries. | bones/manifest.txt |
Scan reports, console warnings |
rc-assets.sh |
Generates asset manifest and copies assets. | home/assets/ |
output/assets/, bones/asset-manifest.yaml |
rc-book.sh |
Aggregates files into markdown binders. | Source/config/content files | bones/book-reports/*.md |
rc-bump.sh |
Logs micro-update and bumps version. | Commit message | CHANGELOG.md, roadmap entry, git commit |
The full inventory of the 20 rc-*.sh rituals and their per-script reference pages lives under docs/bones/scripts/index.html.
Configuration Files (bones/config/)
rotkeeper.yaml(bones/config/): Canonical configuration file defining the display name, authoring metadata, default template, and optionallayout_styleand serializedpathsblock. Schema: rotkeeper-schemas.asset-manifest.yaml(bones/, generated byassets): SHA-256 checksums for every static asset shipped from the source tree. Schema: rotkeeper-schemas.release-manifest.txt(bones/config/, inside each release archive): Bill of materials and ruleset for the framework distribution. The legacyrotkeeper-bom.yamlno longer exists — the release manifest replaced it during Phase 5.
Agent Mode & Diagnostics
Rotkeeper treats autonomous agents as first-class citizens. To facilitate AI handoffs and diagnostics:
| Command | Purpose |
|---|---|
rotkeeper.sh test |
Runs the integration test harness against the core commands to verify system integrity. |