π Rotkeeper CLI & Subroutine Reference
This document outlines how to use the rotkeeper CLI
and its alphabetized rc-* subroutines to scaffold,
render, and archive tombs.
π§° Core CLI Usage
The rotkeeper script is the master ritual coordinator.
It wraps core subroutines (rc-*) and handles full
lifecycle execution.
π§ General Syntax
./rotkeeper <command> [flags]βοΈ Available Commands
| Command | Description |
|---|---|
init |
Set up the project structure |
assets |
Copy static files from declared asset directories |
render |
Convert Markdown content to HTML |
pack |
Bundle tomb contents into a .tar.gz archive |
all |
Run init, assets, render,
and pack in order |
help |
Display available commands and usage tips |
π΄ββ οΈ Common Flags
| Flag | Description |
|---|---|
--dry-run |
Preview operations without writing to disk |
--skip-inject |
Avoid injection logic (e.g.Β inject.d/) |
--verbose |
Enable detailed logs |
--version |
Print current rotkeeper version |
--ritualize |
Output the script used to create this tomb (planned) |
π§© Subroutine Scripts
(rc-*)
Each subroutine lives in scripts/ and may be invoked
directly.
| Script | Purpose |
|---|---|
rc-init.sh |
Creates folders, seed files, and templates |
rc-assets.sh |
Copies assets from assets/, themes/,
etc. |
rc-render.sh |
Converts content/ Markdown to output/
HTML |
rc-pack.sh |
Builds .tar.gz from manifest.txt |
rc-scan.sh |
Checks for missing files, version drift (planned) |
rc-bless.sh |
Writes a changelog and blesses the current version |
rc-inject.sh |
Optional script to copy contents from inject.d/ |
rc-limerick.sh |
Emits random limericks to yougood.brah (planned) |
rc-record.sh |
Generates a shell script to recreate the tomb (planned) |
π§ Environment Variables
| Variable | Use |
|---|---|
TOMB_VERSION |
Sets version string in logs, meta |
RK_CONFIG |
Alternate path to init-config.yaml |
RK_DRY |
Global dry-run override |
RK_VERBOSE |
Global verbose logging override |
π Example Workflows
Minimal render and pack:
./rotkeeper init
./rotkeeper render
./rotkeeper packFull lifecycle:
./rotkeeper all --verboseDirect invocation:
./scripts/rc-render.shBack to Documentation Index