mirror of
https://github.com/JuliusBrussee/caveman.git
synced 2026-08-11 13:21:09 +02:00
fix: align built-in compress wiring and docs
This commit is contained in:
@@ -150,14 +150,6 @@ claude plugin marketplace add JuliusBrussee/caveman
|
||||
claude plugin install caveman@caveman
|
||||
```
|
||||
|
||||
Codex:
|
||||
|
||||
1. Clone repo
|
||||
2. Open Codex in repo
|
||||
3. Run `/plugins`
|
||||
4. Search `Caveman`
|
||||
5. Install plugin
|
||||
|
||||
Install once. Use in all sessions after that.
|
||||
|
||||
One rock. That it.
|
||||
@@ -275,10 +267,13 @@ Code blocks, inline code, URLs, file paths, commands, headings, table structure,
|
||||
| Tool | What it cuts | Savings |
|
||||
|------|-------------|---------|
|
||||
| **caveman** | Output tokens (Claude's responses) | ~65% |
|
||||
| **caveman-compress** | Input tokens (memory files loaded per session) | ~45% |
|
||||
| **compress (/caveman:compress)** | Input tokens (memory files loaded per session) | ~45% |
|
||||
| **Both together** | The whole conversation | Output + input both shrunk |
|
||||
|
||||
Compress is now built-in with the caveman plugin — no separate install needed. Both `/caveman` and `/caveman:compress` work once you install caveman.
|
||||
Compress is built in with the caveman plugin — no separate install needed.
|
||||
|
||||
- Use `/caveman` for caveman mode
|
||||
- Use `/caveman:compress <filepath>` for memory-file compression
|
||||
|
||||
## Star This Repo
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ Claude read `CLAUDE.md` on every session start. If file big, cost big. Caveman m
|
||||
## What It Do
|
||||
|
||||
```
|
||||
/caveman-compress CLAUDE.md
|
||||
/caveman:compress CLAUDE.md
|
||||
```
|
||||
|
||||
```
|
||||
@@ -67,14 +67,12 @@ All validations passed ✅ — headings, code blocks, URLs, file paths preserved
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
cp -r ~/.claude/skills/caveman-compress <path-to-skill>
|
||||
```
|
||||
Compress is built in with the `caveman` plugin. Install `caveman` once, then use `/caveman:compress`.
|
||||
|
||||
Or if you have the caveman repo:
|
||||
If you need local files, the compress skill lives at:
|
||||
|
||||
```bash
|
||||
cp -r skills/caveman-compress ~/.claude/skills/caveman-compress
|
||||
caveman-compress/
|
||||
```
|
||||
|
||||
**Requires:** Python 3.10+
|
||||
@@ -82,14 +80,14 @@ cp -r skills/caveman-compress ~/.claude/skills/caveman-compress
|
||||
## Usage
|
||||
|
||||
```
|
||||
/caveman-compress <filepath>
|
||||
/caveman:compress <filepath>
|
||||
```
|
||||
|
||||
Examples:
|
||||
```
|
||||
/caveman-compress CLAUDE.md
|
||||
/caveman-compress docs/preferences.md
|
||||
/caveman-compress todos.md
|
||||
/caveman:compress CLAUDE.md
|
||||
/caveman:compress docs/preferences.md
|
||||
/caveman:compress todos.md
|
||||
```
|
||||
|
||||
### What files work
|
||||
@@ -104,7 +102,7 @@ Examples:
|
||||
## How It Work
|
||||
|
||||
```
|
||||
/caveman-compress CLAUDE.md
|
||||
/caveman:compress CLAUDE.md
|
||||
↓
|
||||
detect file type (no tokens)
|
||||
↓
|
||||
|
||||
@@ -19,19 +19,18 @@ Compress natural language files (CLAUDE.md, todos, preferences) into caveman-spe
|
||||
|
||||
## Process
|
||||
|
||||
1. This SKILL.md lives alongside `memory/` in the same directory. Find that directory.
|
||||
1. This SKILL.md lives alongside `scripts/` in the same directory. Find that directory.
|
||||
|
||||
2. Run:
|
||||
```
|
||||
cd <directory_containing_this_SKILL.md> && python3 -m scripts <absolute_filepath>
|
||||
```
|
||||
|
||||
cd <directory_containing_this_SKILL.md> && python3 -m scripts <absolute_filepath>
|
||||
|
||||
3. The CLI will:
|
||||
- detect file type (no tokens)
|
||||
- call Claude to compress
|
||||
- validate output (no tokens)
|
||||
- if errors: cherry-pick fix with Claude (targeted fixes only, no recompression)
|
||||
- retry up to 2 times
|
||||
- detect file type (no tokens)
|
||||
- call Claude to compress
|
||||
- validate output (no tokens)
|
||||
- if errors: cherry-pick fix with Claude (targeted fixes only, no recompression)
|
||||
- retry up to 2 times
|
||||
|
||||
4. Return result to user
|
||||
|
||||
|
||||
+1
-1
@@ -1 +1 @@
|
||||
../../caveman-compress/SKILL.md
|
||||
../caveman-compress/SKILL.md
|
||||
+1
-1
@@ -1 +1 @@
|
||||
../../caveman-compress/scripts
|
||||
../caveman-compress/scripts
|
||||
Symlink
+1
@@ -0,0 +1 @@
|
||||
../../caveman-compress/SKILL.md
|
||||
Symlink
+1
@@ -0,0 +1 @@
|
||||
../../caveman-compress/scripts
|
||||
Reference in New Issue
Block a user