pi-goosedump 0.10.3 → 0.10.5

package/README.md

@@ -1,69 +1,62 @@
 # pi-goosedump
 
-`pi-goosedump` is a pi extension for goosedump-backed session-history search,
-entry expansion, and compaction. It exposes goosedump tools under the `goose_`
-prefix and replaces Pi's default LLM compaction with goosedump-generated
-summaries.
+`pi-goosedump` adds goosedump-backed session-history search, durable-memory
+recall, entry expansion, and compaction to Pi. Its tools use the `goose_`
+prefix.
 
-## Installation
+## Install
 
-```bash
+```sh
 pi install npm:pi-goosedump
 ```
 
-This installs `pi-goosedump` and its main dependency `@jarkkojs/goosedump`,
-which includes platform-specific native binaries for Linux x64, macOS arm64,
-and Windows x64.
-If the goosedump binary cannot be resolved, the extension disables itself.
+The package installs `@jarkkojs/goosedump`, including native binaries for Linux
+x64, macOS arm64, and Windows x64. If no compatible binary is available, the
+extension keeps Pi's normal compaction behavior and its goosedump features
+report that they are unavailable.
 
 ## Tools
 
-- **goose_search:** ranks messages by query relevance; returns compact entry
-  overviews with IDs.
-- **goose_recall:** searches durable memory harvested from earlier compactions,
-  scoped to the current working directory by default.
-- **goose_get:** expands specific entry IDs to their full content.
-- **goose_grep:** filters messages by glob pattern; returns compact entries
-  with IDs.
-- **goose_compact:** triggers a goosedump compaction now, optionally keeping
-  the last N user turns verbatim while summarizing everything before.
-
-The read tools (`goose_search`, `goose_get`, `goose_grep`) each accept an
-optional `provider` (default `pi`; also `claude`, `codex`, `crush`, `gemini`,
-`goose`, `opencode`) and `session` id. `session` defaults to the current Pi
-session for `pi` and is required otherwise. `scope` is `lineage` (default,
-current branch) or `all`. Targets are always provider-qualified
-(`provider:id`); a bare id is never sent to goosedump.
+- **`goose_search`** ranks session messages and returns compact overviews with
+  entry IDs.
+- **`goose_get`** expands entry IDs returned by `goose_search` or `goose_grep`.
+- **`goose_grep`** filters session messages with a glob pattern.
+- **`goose_recall`** searches memory harvested by earlier compactions. It
+  searches the current working directory by default and returns full entries
+  with provenance.
+- **`goose_compact`** starts asynchronous compaction of the current Pi session.
+  Set `keep` to preserve the last N user turns verbatim.
 
-```
+The session-history tools accept an optional `provider` (`pi` by default),
+`session`, and `scope` (`lineage` by default or `all`). The current Pi session
+is used when both provider and session are omitted. Non-Pi providers require an
+explicit session ID. Targets sent to goosedump are always provider-qualified.
+
+Examples:
+
+```text
 goose_search({ query: "bug fix" })
-goose_recall({ query: "prior architecture decision" })
 goose_search({ query: "auth", scope: "all", page: 2 })
 goose_get({ ids: ["entry-a", "entry-b"] })
-goose_get({ ids: ["entry-a"], provider: "claude", session: "1f6b1eba-…" })
-goose_grep({ pattern: "*rand*" })
+goose_grep({ pattern: "*timeout*" })
+goose_recall({ query: "prior architecture decision" })
 goose_compact({ keep: 2 })
 ```
 
 ## Commands
 
-- **`/goose-search [query]`:** search the current session history; accepts a
-  query argument or prompts inline when bare. Shows ranked results in a
-  scrollable panel; press enter to expand an entry to its full content.
-- **`/goose-compact [keep:N]`:** compact now with goosedump. With `keep:N`
-  (N ≥ 1) the last N user turns stay verbatim and everything before is
-  summarized; with no argument goosedump summarizes up to Pi's token-based cut.
-- **`/goose-settings`:** edit the global and project compaction settings.
+- **`/goose-search [query]`** searches the current session. A bare command opens
+  an inline prompt; selecting a result expands it.
+- **`/goose-compact [keep:N]`** compacts now. With `keep:N`, the last N user
+  turns remain verbatim; without it, Pi chooses the cut point.
+- **`/goose-settings`** edits global and project compaction settings.
 
 ## Settings
 
-`pi-goosedump` reads optional JSON settings from:
+Optional settings live under `goosedump` in:
 
-- `~/.pi/agent/settings.json` — Global
-- `.pi/settings.json` — Project
-
-Project settings override global settings. All settings live in a `goosedump`
-section and are optional (defaults shown):
+- `~/.pi/agent/settings.json` for global settings.
+- `.pi/settings.json` for project overrides.
 
 ```json
 {
@@ -73,37 +66,24 @@ section and are optional (defaults shown):
 }
 ```
 
-`turnsBeforeCompact` sets how many LLM turns elapse before goosedump triggers
-compaction, as an integer 0–255. `0` disables the counter. The settings editor
-can clear the project value to inherit Global again, and writes updates atomically.
-The countdown is reconstructed from the active session after Pi restarts or
-resumes, rather than restarting at the configured value. When enabled, the footer
-shows `GD: XX` counting down in hex (e.g. `GD: 0A`); `GD: 00` is armed and waiting
-to compact, while `GD: --` means disabled.
-
-### Compaction flow
-
-pi-goosedump hooks Pi's `session_before_compact` event — fired by manual
-`/compact`, the turn counter above, and Pi's own auto-compaction — and
-substitutes a goosedump summary for Pi's LLM summary. It resolves the current
-session to its goosedump context by reading the `id` field from the session
-header line, then runs `goosedump compact` over the replacement range:
-
-- `--from` is the entry following the most recent prior compaction (so the
-  summary starts where the previous one left off); omitted on the first
-  compaction.
-- `--until` is the first entry Pi is keeping (`firstKeptEntryId`).
-
-goosedump composes the structured summary itself and emits a native Pi
-compaction entry, from which the extension extracts the `summary` field. The
-extension prepends Pi's previous compaction summary when present, so prior goals,
-progress, and context survive incremental compactions. A `keep:N` override (via
-`/goose-compact` or the `goose_compact` tool) replaces Pi's token-based cut with
-a turn-based one: summarize everything before the Nth-from-last user entry in the
-active, uncompacted history and keep the tail verbatim. Fewer than N active user
-turns cancels with a notice. On completion Pi notifies the token reduction.
+`turnsBeforeCompact` is an integer from 0 to 255. `0` disables scheduled
+compaction. The countdown is restored when a session resumes and appears in the
+footer as hexadecimal: `GD: 0A` means ten turns remain, `GD: 00` is ready to
+compact, and `GD: --` is disabled. Clearing the project value restores the
+global setting.
+
+## Compaction behavior
+
+The extension replaces Pi's normal summary during manual, scheduled, and
+automatic compaction. It preserves the previous compaction summary and asks
+goosedump to summarize only the newly compacted range. A `keep:N` request
+instead keeps the last N active user turns; it is cancelled when no earlier
+history is available to summarize.
+
+Compactions with custom instructions continue to use Pi's normal compactor. If
+goosedump fails, the extension reports the error and falls back to Pi. Successful
+compactions report memory-learning warnings without discarding the summary.
 
 ## License
 
-`pi-goosedump` is licensed under `Apache-2.0`. See [LICENSE](LICENSE) for more
-information.
+`pi-goosedump` is licensed under `Apache-2.0`. See [LICENSE](LICENSE).

package/index.ts

@@ -58,6 +58,11 @@ interface GoosedumpMessage {
   content: string;
 }
 
+interface GoosedumpCommandOutput {
+  stdout: string;
+  stderr: string;
+}
+
 interface GoosedumpMemoryHit {
   hash: string;
   kind: string;
@@ -67,6 +72,7 @@ interface GoosedumpMemoryHit {
   context_id: string;
   entry_id: string;
   path: string;
+  source_path: string;
 }
 
 // A `content` part of a pi-native message line.
@@ -324,7 +330,8 @@ function parseMemoryHits(output: string): GoosedumpMemoryHit[] {
       typeof item.provider === 'string' &&
       typeof item.context_id === 'string' &&
       typeof item.entry_id === 'string' &&
-      typeof item.path === 'string',
+      typeof item.path === 'string' &&
+      typeof item.source_path === 'string',
   );
 }
 
@@ -332,7 +339,7 @@ function formatMemoryHits(hits: GoosedumpMemoryHit[]): string {
   return hits
     .map(
       (hit) =>
-        `[${hit.hash}] ${hit.kind} (${hit.provider}:${hit.context_id}/${hit.entry_id})\n${hit.text}`,
+        `[${hit.hash}] ${hit.kind} (${hit.provider}:${hit.context_id}/${hit.entry_id})\nWorking directory: ${hit.path}\nSource: ${hit.source_path}\n${hit.text}`,
     )
     .join('\n\n---\n\n');
 }
@@ -394,7 +401,7 @@ function runGoosedump(args: string[]): string {
 // Non-blocking variant for the compact path: goosedump compact runs an ML
 // model and can take many seconds, so execFileSync would freeze Pi's event
 // loop (and its compaction spinner). execFile keeps the loop free to render.
-function runGoosedumpAsync(args: string[], signal?: AbortSignal): Promise<string> {
+function runGoosedumpAsync(args: string[], signal?: AbortSignal): Promise<GoosedumpCommandOutput> {
   return new Promise((resolve, reject) => {
     execFile(
       process.execPath,
@@ -409,7 +416,7 @@ function runGoosedumpAsync(args: string[], signal?: AbortSignal): Promise<string
           const message = stderr.trim() || err.message;
           reject(new Error(message));
         } else {
-          resolve(stdout);
+          resolve({ stdout, stderr });
         }
       },
     );
@@ -475,12 +482,12 @@ async function goosedumpRecall(
   query: string,
   options: { provider?: string; path?: string; limit?: number } = {},
   signal?: AbortSignal,
-): Promise<GoosedumpMemoryHit[]> {
+): Promise<{ hits: GoosedumpMemoryHit[]; warning: string }> {
   const args = ['recall', query, '--limit', String(options.limit ?? 5)];
   if (options.provider) args.push('--provider', options.provider);
   if (options.path) args.push('--path', options.path);
   const output = await runGoosedumpAsync(args, signal);
-  return parseMemoryHits(output);
+  return { hits: parseMemoryHits(output.stdout), warning: output.stderr.trim() };
 }
 
 // Resolve a goosedump 0.9 `provider:id` target. An explicit contextId is the
@@ -537,23 +544,25 @@ async function goosedumpCompact(
   target: string,
   options: { scope?: string; from?: string; until: string },
   signal?: AbortSignal,
-): Promise<string> {
+): Promise<{ summary: string; warning: string }> {
   const scope = options.scope ?? 'lineage';
   const args = ['compact', target, '--scope', scope];
   if (options.from) args.push('--from', options.from);
   args.push('--until', options.until);
 
   const output = await runGoosedumpAsync(args, signal);
-  for (const line of output.split('\n')) {
+  for (const line of output.stdout.split('\n')) {
     if (!line) continue;
     try {
       const entry = JSON.parse(line) as PiEntryJson;
-      if (entry.type === 'compaction' && typeof entry.summary === 'string') return entry.summary;
+      if (entry.type === 'compaction' && typeof entry.summary === 'string') {
+        return { summary: entry.summary, warning: output.stderr.trim() };
+      }
     } catch {
       continue;
     }
   }
-  return output.trim();
+  return { summary: output.stdout.trim(), warning: output.stderr.trim() };
 }
 
 export interface GoosedumpIntegrationOptions {
@@ -574,6 +583,7 @@ interface GoosedumpCompactionDetails {
   from?: string;
   until: string;
   fileOps: unknown;
+  warning?: string;
 }
 
 export interface GoosedumpIntegration {
@@ -789,9 +799,9 @@ async function buildGoosedumpCompaction(
   const range = buildCompactRange(branchEntries, firstKeptEntryId);
   if (!range) return undefined;
 
-  const generatedSummary = await goosedumpCompact(target, range, signal);
-  if (!generatedSummary) return undefined;
-  const summary = mergeCompactionSummary(preparation.previousSummary, generatedSummary);
+  const generated = await goosedumpCompact(target, range, signal);
+  if (!generated.summary) return undefined;
+  const summary = mergeCompactionSummary(preparation.previousSummary, generated.summary);
 
   return {
     summary,
@@ -804,6 +814,7 @@ async function buildGoosedumpCompaction(
       from: range.from,
       until: range.until,
       fileOps: preparation.fileOps,
+      warning: generated.warning || undefined,
     },
   };
 }
@@ -1390,7 +1401,7 @@ export function createGoosedumpIntegration(
           async execute(_id, params, signal, _onUpdate, ctx): Promise<AgentToolResult<void>> {
             if (!goosedumpAvailable) return goosedumpUnavailableResult();
             try {
-              const hits = await goosedumpRecall(
+              const { hits, warning } = await goosedumpRecall(
                 params.query,
                 {
                   provider: params.provider,
@@ -1399,6 +1410,7 @@ export function createGoosedumpIntegration(
                 },
                 signal,
               );
+              if (warning && ctx.hasUI) ctx.ui.notify(warning, 'warning');
               if (hits.length === 0) return textResult(`No durable memory for "${params.query}"`);
               return textResult(formatMemoryHits(hits));
             } catch (err) {
@@ -1680,6 +1692,10 @@ export function createGoosedumpIntegration(
           if (ctx.hasUI) ctx.ui.notify(compaction.reason, 'info');
           return { cancel: true };
         }
+        const warning = compaction?.details?.warning;
+        if (warning && ctx.hasUI) {
+          ctx.ui.notify(warning, 'warning');
+        }
         return compaction ? { compaction } : undefined;
       } catch (err) {
         if (event.signal.aborted) return { cancel: true };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-goosedump",
-  "version": "0.10.3",
+  "version": "0.10.5",
   "description": "Pi extension for goosedump-backed session-history search, entry expansion, and compaction",
   "keywords": [
     "compaction",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@earendil-works/pi-tui": "^0.78.0",
-    "@jarkkojs/goosedump": "^0.9.8",
+    "@jarkkojs/goosedump": "^0.10.5",
     "@sinclair/typebox": "^0.34.49"
   },
   "devDependencies": {