đź› Dependencies (macOS)
Rotkeeper is currently developed and tested on macOS. Linux and WSL support may be possible in the future—pending rituals, caffeine, and divine intervention.
🔧 Required Tools
You’ll need the following installed and available in your
$PATH:
| Tool | Purpose | Install Command (Homebrew) |
|---|---|---|
bash |
Script shell | Pre-installed on macOS |
pandoc |
Markdown → HTML renderer | brew install pandoc |
yq |
YAML processor | brew install yq |
jq |
JSON processor | brew install jq |
tar |
Archiver | Pre-installed on macOS |
git |
Version control + rev logs | brew install git |
Optional: - tree (for file structure previews) -
bat (for pretty log dumps) - grep,
sed, find (BSD variants are fine, but GNU
versions preferred if you’re chaotic)
🍎 macOS Setup
Install Homebrew (if missing): https://brew.sh
Run the full install stack:
brew install pandoc yq jq git tree bat- Clone the repo and run a render:
git clone https://github.com/youruser/rotkeeper.git
cd rotkeeper
./rotkeeper.sh renderđź’ Linux / WSL?
Not supported yet, but theoretically viable. If you try and succeed—or suffer greatly—please submit a ritual report or log your screams to the issue tracker.
“macOS is the temple. WSL is the haunted basement. Linux is the field where bones are scattered.”