diff --git a/README.md b/README.md index fc22c92..c924b1d 100644 --- a/README.md +++ b/README.md @@ -161,6 +161,9 @@ Install once. Use in all sessions after that. One rock. That it. +> [!NOTE] +> **Windows users:** This repo uses symlinks. On Windows, enable `git config core.symlinks true` before cloning (requires developer mode or admin). The plugin installer resolves symlinks to real files at install time, so symlinks work transparently after installation. + ## Usage Trigger with: @@ -232,7 +235,7 @@ Caveman makes Claude *speak* with fewer tokens. **Caveman Compress** makes Claud Your `CLAUDE.md` loads on **every session start**. A 1000-token project memory file costs you tokens every single time you open a project. Caveman Compress rewrites those files into caveman-speak so Claude reads less — without you losing the human-readable original. ``` -/caveman-compress CLAUDE.md +/caveman:compress CLAUDE.md ``` ``` @@ -275,7 +278,7 @@ Code blocks, inline code, URLs, file paths, commands, headings, table structure, | **caveman-compress** | Input tokens (memory files loaded per session) | ~45% | | **Both together** | The whole conversation | Output + input both shrunk | -See the full [caveman-compress README](caveman-compress/README.md) for install, usage, and validation details. +Compress is now built-in with the caveman plugin — no separate install needed. Both `/caveman` and `/caveman:compress` work once you install caveman. ## Star This Repo diff --git a/caveman-compress/SKILL.md b/caveman-compress/SKILL.md index 7b95dcf..d19c703 100644 --- a/caveman-compress/SKILL.md +++ b/caveman-compress/SKILL.md @@ -1,10 +1,10 @@ --- -name: caveman-compress +name: compress description: > Compress natural language memory files (CLAUDE.md, todos, preferences) into caveman format to save input tokens. Preserves all technical substance, code, URLs, and structure. Compressed version overwrites the original file. Human-readable backup saved as FILE.original.md. - Trigger: /caveman-compress or "compress memory file" + Trigger: /caveman:compress or "compress memory file" --- # Caveman Compress @@ -15,7 +15,7 @@ Compress natural language files (CLAUDE.md, todos, preferences) into caveman-spe ## Trigger -`/caveman-compress ` or when user asks to compress a memory file. +`/caveman:compress ` or when user asks to compress a memory file. ## Process diff --git a/compress/SKILL.md b/compress/SKILL.md new file mode 120000 index 0000000..0005d47 --- /dev/null +++ b/compress/SKILL.md @@ -0,0 +1 @@ +../../caveman-compress/SKILL.md \ No newline at end of file diff --git a/compress/scripts b/compress/scripts new file mode 120000 index 0000000..16f69b7 --- /dev/null +++ b/compress/scripts @@ -0,0 +1 @@ +../../caveman-compress/scripts \ No newline at end of file diff --git a/plugins/caveman/skills/compress/SKILL.md b/plugins/caveman/skills/compress/SKILL.md new file mode 120000 index 0000000..d0a6469 --- /dev/null +++ b/plugins/caveman/skills/compress/SKILL.md @@ -0,0 +1 @@ +../../../../caveman-compress/SKILL.md \ No newline at end of file diff --git a/plugins/caveman/skills/compress/scripts b/plugins/caveman/skills/compress/scripts new file mode 120000 index 0000000..ed7cd9a --- /dev/null +++ b/plugins/caveman/skills/compress/scripts @@ -0,0 +1 @@ +../../../../caveman-compress/scripts \ No newline at end of file