Skip to content
This repository was archived by the owner on Apr 2, 2026. It is now read-only.

Commit 36c5743

Browse files
greynewellclaude
andcommitted
docs: update README to reflect one-command setup and new env vars
- Quick Start is now a single command: npm install -g uncompact --foreground-scripts - auth login flow documented as handling both auth and hook installation - Added UNCOMPACT_API_URL and UNCOMPACT_DASHBOARD_URL to env vars table - Updated caching strategy to reflect fast-fail on connection errors - Removed now-redundant separate auth and install steps Co-Authored-By: Grey Newell <greyshipscode@gmail.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 6a1d707 commit 36c5743

1 file changed

Lines changed: 23 additions & 42 deletions

File tree

README.md

Lines changed: 23 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This installs both hooks automatically:
5050
- **`SessionStart`** — runs `scripts/setup.sh` which auto-installs the `uncompact` binary via `go install` if not already present.
5151
- **`Stop`** — runs `scripts/uncompact-hook.sh` which reinjects context after every compaction event.
5252

53-
> **Note:** After plugin installation, authenticate once with `uncompact auth login` to connect your Supermodel API key. That's it — no manual binary install or hook setup required.
53+
> **Note:** After plugin installation, run `uncompact auth login` once to authenticate. This also ensures hooks are installed — no separate `uncompact install` step needed.
5454
5555
### CI / GitHub Actions
5656

@@ -65,69 +65,48 @@ env:
6565
6666
## Quick Start
6767
68-
### 1. Install
69-
70-
**Via npm (recommended):**
71-
72-
```bash
73-
# Install CLI and automatically configure Claude Code hooks
74-
npm install -g uncompact
75-
```
76-
77-
*Note: npm might hide the configuration output. You can verify the installation with `uncompact verify-install`.*
78-
79-
**Or run/install without global installation:**
80-
81-
```bash
82-
# This will show full interactive output
83-
npx uncompact install
84-
```
85-
86-
### 🗑 Uninstall
87-
88-
To remove the Claude Code hooks only:
68+
### Via npm (recommended)
8969
9070
```bash
91-
uncompact uninstall
71+
npm install -g uncompact --foreground-scripts
9272
```
9373

94-
To **completely remove** Uncompact configuration and cached data:
95-
96-
```bash
97-
uncompact uninstall --total
98-
```
74+
That's it. The installer downloads the binary, opens your browser for GitHub authentication, and installs the Claude Code hooks — all in one step.
9975

100-
*Note: After running the above, you can remove the CLI itself with `npm uninstall -g uncompact`.*
76+
> `--foreground-scripts` is required so the interactive auth prompt is visible in your terminal.
10177
102-
**Via Go:**
78+
### Via Go or manual binary
10379

10480
```bash
10581
go install github.com/supermodeltools/uncompact@latest
82+
# then:
83+
uncompact auth login
10684
```
10785

108-
**Or download a binary** from [Releases](https://github.com/supermodeltools/Uncompact/releases).
86+
`auth login` opens your browser for GitHub OAuth, saves your API key, and installs the Claude Code hooks automatically.
10987

110-
### 2. Authenticate
88+
**Or download a binary** from [Releases](https://github.com/supermodeltools/Uncompact/releases) and run `uncompact auth login`.
89+
90+
### Verify
11191

11292
```bash
113-
uncompact auth login
93+
uncompact verify-install
94+
uncompact run --debug
11495
```
11596

116-
This opens [dashboard.supermodeltools.com/api-keys/](https://dashboard.supermodeltools.com/api-keys/) where you can subscribe and generate an API key.
97+
### 🗑 Uninstall
11798

118-
### 3. Install Claude Code Hooks
99+
To remove the Claude Code hooks only:
119100

120101
```bash
121-
uncompact install
102+
uncompact uninstall
122103
```
123104

124-
This auto-detects your Claude Code `settings.json`, shows a diff, and merges the hooks non-destructively.
125-
126-
### 4. Verify
105+
To **completely remove** Uncompact configuration and cached data:
127106

128107
```bash
129-
uncompact verify-install
130-
uncompact run --debug
108+
uncompact uninstall --total
109+
npm uninstall -g uncompact
131110
```
132111

133112
## CLI Reference
@@ -164,6 +143,8 @@ uncompact cache clear --project # Clear only the current project's cache
164143
| Variable | Description |
165144
|----------|-------------|
166145
| `SUPERMODEL_API_KEY` | Supermodel API key (overrides config file) |
146+
| `UNCOMPACT_API_URL` | Override the API base URL (e.g. for staging) |
147+
| `UNCOMPACT_DASHBOARD_URL` | Override the dashboard base URL (e.g. for staging) |
167148

168149
### Config File
169150

@@ -244,7 +225,7 @@ uncompact/
244225
|---------|--------|
245226
| Default TTL | 15 minutes |
246227
| Stale cache | Served with `⚠️ STALE` warning; fresh fetch attempted |
247-
| API unavailable | Serve most recent cache entry silently |
228+
| API unreachable | Fail fast on connection error; serve stale cache if available |
248229
| No cache + API down | Silent exit 0 (never blocks Claude Code) |
249230
| Storage growth | Auto-prune entries older than 30 days |
250231
| Force refresh | `--force-refresh` flag |

0 commit comments

Comments
 (0)