mirror of https://github.com/JuliusBrussee/caveman.git synced 2026-08-11 13:21:09 +02:00

Files

T

Julius Brussee 1be0340955 Add plugin hooks and update docs

Register SessionStart and UserPromptSubmit hooks in .claude-plugin/plugin.json to auto-load caveman rules and track active mode (writes to ~/.claude/.caveman-active). Update README and hooks/README.md to reflect automatic activation when installed as a plugin, remove the one-line install snippet, clarify the optional statusline badge, and adjust uninstall instructions (replace PostToolUse with UserPromptSubmit and note disabling the plugin deactivates hooks).

2026-04-09 21:22:10 +02:00

2.5 KiB

Raw Permalink Blame History

Caveman Hooks

These hooks are bundled with the caveman plugin and activate automatically when the plugin is installed. No manual setup required.

If you installed caveman standalone (without the plugin), you can use bash hooks/install.sh to wire them into your settings.json manually.

What's Included

`caveman-activate.js` — SessionStart hook

Runs once when Claude Code starts
Writes full to ~/.claude/.caveman-active (flag file)
Emits caveman rules as hidden SessionStart context

`caveman-mode-tracker.js` — UserPromptSubmit hook

Fires on every user prompt, checks for /caveman commands
Writes the active mode to the flag file when a caveman command is detected
Supports: full, lite, ultra, wenyan, wenyan-lite, wenyan-ultra, commit, review, compress

Optional: Statusline Badge

The flag file bridges the gap between hooks (which Claude sees) and your statusline (which you see). Add this to your statusline script to show which mode is active:

caveman_text=""
caveman_flag="$HOME/.claude/.caveman-active"
if [ -f "$caveman_flag" ]; then
  caveman_mode=$(cat "$caveman_flag" 2>/dev/null)
  if [ "$caveman_mode" = "full" ] || [ -z "$caveman_mode" ]; then
    caveman_text="\033[38;5;172m[CAVEMAN]\033[0m"
  else
    caveman_suffix=$(echo "$caveman_mode" | tr '[:lower:]' '[:upper:]')
    caveman_text="\033[38;5;172m[CAVEMAN:${caveman_suffix}]\033[0m"
  fi
fi

Badge examples:

/caveman → [CAVEMAN]
/caveman ultra → [CAVEMAN:ULTRA]
/caveman wenyan → [CAVEMAN:WENYAN]
/caveman-commit → [CAVEMAN:COMMIT]
/caveman-review → [CAVEMAN:REVIEW]

How It Works

SessionStart hook ──writes "full"──▶ ~/.claude/.caveman-active ◀──writes mode── UserPromptSubmit hook
                                              │
                                           reads
                                              ▼
                                     Statusline script
                                    [CAVEMAN:ULTRA] │ ...

SessionStart stdout is injected as hidden system context — Claude sees it, users don't. The statusline runs as a separate process. The flag file is the bridge.

Uninstall

If installed via plugin: disable the plugin — hooks deactivate automatically.

If installed via install.sh:

Remove ~/.claude/hooks/caveman-activate.js and ~/.claude/hooks/caveman-mode-tracker.js
Remove the SessionStart and UserPromptSubmit entries from ~/.claude/settings.json
Delete ~/.claude/.caveman-active

2.5 KiB Raw Permalink Blame History