π§± rc-init β Ritual Bootstrap
The rc-init.sh script creates the skeletal folder
structure and placeholder files required for a new Rotkeeper
deployment.
This script is typically run once, or when reanimating a collapsed tomb structure. It can be safely run multiple times (idempotent).
π What It Creates
bones/,bones/logs/,bones/archive/,bones/reports/,bones/templates/home/,home/assets/,home/content/rotkeeper/output/
It also ensures the following exist: -
bones/manifest.txt - render-flags.yaml
π Behavior
- Can be run repeatedly without error
- Logs are saved to
bones/logs/rc-init.log. All stdout and stderr are captured. - Errors from
rc-expand.shorrc-render.shwill cause a non-zero exit and be captured in the log. - Exits
0on success,1if required tools or permissions are missing
π Flags
- `--help`: print usage text and exit
- `--verbose`: print log entries to terminal
- `--dry-run`: simulate setup without creating filesπ Related Rituals
rc-expand.shβ generates content stubsrc-render.shβ renders output after structure is seeded
πͺ¦ Limericks
π§ͺ Usage Examples
Run from the root of your Rotkeeper repo:
bash bones/scripts/rc-init.shOr invoke through the main dispatcher:
./rotkeeper initAll output is logged to bones/logs/rc-init.log.
Use this at the beginning of any new tomb cycle or prior to reseeding from archive.
ποΈ Folder Layout Preview
rotkeeper/
βββ bones/
β βββ archive/
β βββ logs/
β βββ reports/
β βββ templates/
βββ home/
β βββ assets/
β βββ content/
β βββ rotkeeper/
βββ output/
βββ render-flags.yaml
βββ bones/manifest.txt
β οΈ Notes & Caveats
- If
bones/manifest.txtalready exists, it will not be overwritten - Does not clone or fetch any default templates β only prepares the structure
- Wonβt run
expandorrenderunless explicitly chained - Errors are trapped and logged via
trap_err. Reviewrc-init.logfor troubleshooting.