Browse Source

feat: context-warn extension — alert on context threshold

main
Matteo Benedetto 4 weeks ago
commit
b6e38abf5e
  1. 1
      .gitignore
  2. 79
      README.md
  3. BIN
      alert.wav
  4. 152
      index.ts

1
.gitignore vendored

@ -0,0 +1 @@
.git

79
README.md

@ -0,0 +1,79 @@
# Context Warn Extension
Emits a sound alert when the context window reaches or exceeds **100 000 tokens**. Also shows a UI notification and status bar update.
## Installation
### Option 1: Auto-discovered (recommended)
```bash
mkdir -p ~/.pi/agent/extensions/context-warn
cp -r /home/enne2/base/context-warn-extension/* ~/.pi/agent/extensions/context-warn/
```
Then reload pi with `/reload`.
### Option 2: One-off with --extension
```bash
pi -e /home/enne2/base/context-warn-extension/index.ts
```
## Features
- **Sound alert**: Plays a pre-bundled WAV alert sound via `aplay` (no runtime generation)
- **UI notification**: Shows a warning notification in the TUI
- **Status bar**: Shows current token count and context window size
- **Cooldown**: Only alerts once per threshold crossing, then waits 60 seconds before next alert
- **Auto-reset**: Clears alert state after compaction
## Commands
- `/context-warn-status` — Show current context usage and alert status
- `/context-warn-alert` — Manually trigger the alert sound (for testing)
## Configuration
Edit these values at the top of `index.ts`:
| Constant | Default | Description |
|----------|---------|-------------|
| `WARNING_TOKEN_THRESHOLD` | 100 000 | Tokens at which to trigger the alert |
| `CHECK_INTERVAL_MS` | 15 000 | How often to check context (ms) |
| `WARNING_COOLDOWN_MS` | 60 000 | Minimum seconds between alerts |
## Dependencies
- `aplay` (ALSA player) — for playing the WAV file
- `sox` — only needed to **generate** a new alert.wav (optional)
Both are available on Fedora by default. On Ubuntu/Debian:
```bash
sudo apt install alsa-utils sox libsox-fmt-all
```
## How It Works
1. Listens to `turn_end` events (fired after every LLM response)
2. Calls `ctx.getContextUsage()` to check current token count
3. When tokens ≥ threshold, plays `alert.wav` via aplay
4. Shows a TUI notification and updates the status bar
5. Resets alert state on `session_compact`
## Alert Sound
The bundled `alert.wav` is a **~0.85-second preallarme** — breve, chiaro, non fastidioso:
- **2 beep corti** a 580 Hz (0.15s ciascuno) → "avviso"
- **1 tono più lungo** a 880 Hz (0.55s) → "attenzione"
- Totale: ~1 secondo — sufficiente per accorgersene senza essere invasivo
### Regenerate con SoX
```bash
sox -n -t wav a.wav synth 0.15 sine 580 vol 0.55
sox -n -t wav b.wav synth 0.15 sine 580 vol 0.55
sox -n -t wav c.wav synth 0.55 sine 880 vol 0.65
sox a.wav b.wav c.wav alert.wav
```
Customize the tone by changing the frequency and volume parameters.

BIN
alert.wav

Binary file not shown.

152
index.ts

@ -0,0 +1,152 @@
/**
* Context Warning Extension
*
* Emits a generated sound alert when the context window reaches or exceeds
* 100 000 tokens. Also shows a UI notification.
*
* Usage:
* pi -e ./context-warn-extension/index.ts
*
* Or place in ~/.pi/agent/extensions/context-warn/ for auto-discovery.
*/
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
import { execFileSync } from "node:child_process";
import { existsSync } from "node:fs";
import { join, dirname } from "node:path";
import { fileURLToPath } from "node:url";
// ---------------------------------------------------------------------------
// Configuration
// ---------------------------------------------------------------------------
const WARNING_TOKEN_THRESHOLD = 100_000; // alert at 100k tokens
const CHECK_INTERVAL_MS = 15_000; // re-check every 15 s
const WARNING_COOLDOWN_MS = 60_000; // min seconds between alerts
// Resolve the directory where this extension lives so we can find alert.wav
const EXT_DIR = dirname(fileURLToPath(import.meta.url));
const ALERT_WAV = join(EXT_DIR, "alert.wav");
/**
* Play the bundled alert.wav sound via aplay.
* No runtime generation needed the WAV is committed alongside this file.
*/
function playAlert(): void {
if (!existsSync(ALERT_WAV)) {
console.error(`[context-warn] alert.wav not found at ${ALERT_WAV}`);
return;
}
try {
execFileSync("aplay", ["-q", ALERT_WAV], { stdio: "ignore" });
} catch (err) {
console.error(`[context-warn] Audio play failed: ${err instanceof Error ? err.message : String(err)}`);
}
}
// ---------------------------------------------------------------------------
// Extension
// ---------------------------------------------------------------------------
export default function (pi: ExtensionAPI) {
let lastAlertTimestamp: number | null = null;
let alertedAtThreshold: boolean = false;
/** Check context usage and alert if threshold reached. */
const checkContext = (_event: unknown, ctx: ReturnType<ExtensionAPI["on"]> extends (ev: string, h: (e: any, c: infer C) => any) ? C : never) => {
const usage = ctx.getContextUsage();
if (!usage || usage.tokens === null || usage.tokens === undefined) {
return;
}
const currentTokens = usage.tokens;
// Check if we crossed the threshold (went from below to >= threshold)
const crossedThreshold = !alertedAtThreshold && currentTokens >= WARNING_TOKEN_THRESHOLD;
alertedAtThreshold = alertedAtThreshold || crossedThreshold;
if (crossedThreshold) {
// Check cooldown
const now = Date.now();
if (lastAlertTimestamp && (now - lastAlertTimestamp) < WARNING_COOLDOWN_MS) {
return; // still in cooldown
}
lastAlertTimestamp = now;
// Show UI notification
if (ctx.hasUI) {
ctx.ui.notify(
"⚠ Context Warning",
`Context reached ${currentTokens.toLocaleString()} tokens (>${WARNING_TOKEN_THRESHOLD.toLocaleString()}). Consider compacting.`,
"warning"
);
ctx.ui.setStatus("context-warn", `${(currentTokens / 1000).toFixed(0)}k / ${usage.contextWindow ? `${usage.contextWindow / 1000}k` : "?"}`);
}
// Play alert sound
playAlert();
console.log(`[context-warn] Context: ${currentTokens.toLocaleString()} tokens (threshold: ${WARNING_TOKEN_THRESHOLD.toLocaleString()})`);
}
};
// Listen to turn_end — fired after every LLM response, which is when
// we know the new context size.
pi.on("turn_end", (_event, ctx) => {
checkContext(_event, ctx);
});
// Also listen to agent_end in case compaction or other events happen
pi.on("agent_end", (_event, ctx) => {
checkContext(_event, ctx);
});
// Listen to session_start to reset state
pi.on("session_start", (_event, ctx) => {
alertedAtThreshold = false;
lastAlertTimestamp = null;
if (ctx.hasUI) {
ctx.ui.notify("🔊 Context monitor active", `Alerts at ≥ ${WARNING_TOKEN_THRESHOLD.toLocaleString()} tokens`, "info");
ctx.ui.setStatus("context-warn", "monitoring…");
}
});
// Listen to session_compact to reset alert state
pi.on("session_compact", (_event, ctx) => {
alertedAtThreshold = false;
lastAlertTimestamp = Date.now();
if (ctx.hasUI) {
ctx.ui.setStatus("context-warn", "compact ✓");
}
});
// Register /context-warn-status command
pi.registerCommand("context-warn-status", {
description: "Show current context token usage and warning status",
handler: async (_args, ctx) => {
const usage = ctx.getContextUsage();
if (!usage || usage.tokens === null || usage.tokens === undefined) {
ctx.ui.notify("Context", "No usage data available yet.", "info");
return;
}
const pct = usage.percent !== null && usage.percent !== undefined
? `${usage.percent.toFixed(1)}%`
: "?";
ctx.ui.notify(
"Context Status",
`${usage.tokens.toLocaleString()} tokens / ${usage.contextWindow?.toLocaleString()} (${pct})\nThreshold: ${WARNING_TOKEN_THRESHOLD.toLocaleString()}\nAlerted: ${alertedAtThreshold ? "yes" : "no"}`,
"info"
);
},
});
// Register /context-warn-alert command — manual test
pi.registerCommand("context-warn-alert", {
description: "Play the alert sound immediately (test)",
handler: async (_args, ctx) => {
playAlert();
ctx.ui.notify("🔔 Alert", "Sound played.", "info");
},
});
}
Loading…
Cancel
Save