@jarkkojs/goosedump 0.10.4 → 0.10.5

package/README.md

@@ -1,63 +1,91 @@
 # goosedump
 
-`goosedump` is a coding agent context data browser. It builds on top of the
-ideas of [`lllyasviel/VCC`](https://github.com/lllyasviel/VCC).
+`goosedump` browses, searches, converts, and compacts saved coding-agent
+conversations. It supports Claude Code, Codex, Crush, Gemini CLI, Goose,
+OpenCode, and Pi.
 
-Features:
+It builds on ideas from [`lllyasviel/VCC`](https://github.com/lllyasviel/VCC).
 
-* Structured JSON output on stdout, so you can render it however you like.
-* BM25 keyword ranking (with scores) for natural queries.
-* Glob matching for filtering messages.
-* Format conversion: re-render any context in another provider's native format.
-* Import contexts into another provider's store (with `delete`, a "move").
-* Persistent hybrid memory harvested when a context range is compacted.
+## Install
 
-## Memory
+Prebuilt binaries are available for Linux x64, macOS arm64, and Windows x64:
 
-Successful `compact` commands harvest the compacted range into
-`~/.local/state/goosedump/goosedump.db`. `recall` searches that memory with
-hybrid BM25 and vector ranking, `stats` reports its signals, and `forget`
-removes a content hash or a provider-qualified context. Explicit `delete`
-never harvests.
+```sh
+npm install --global @jarkkojs/goosedump
+```
 
-`mutate` runs one opt-in Stage-3 merge from the MAP-Elites archive with local
-Qwen3-0.6B Q4_K_M inference. It requires a reported Stage-2 plateau; use
-`mutate --force` only to test the mutation path before enough evidence exists.
+To build from source:
 
-Use `compact --no-learn` for one compaction or set `GOOSEDUMP_NO_LEARN=1` to
-disable harvesting. The initial implementation stores all searchable context
-text without secret filtering; use the opt-out when a range contains material
-that must not be retained.
+```sh
+cargo build --release
+```
 
-## Pi extension
+Source builds require CMake, Clang/libclang, and a C++ compiler for local model
+inference.
 
-The bundled [pi-goosedump extension](packages/pi-goosedump/README.md) provides
-GooseDump's session-history and compaction tools in Pi:
+## Quick start
 
 ```sh
-pi install npm:pi-goosedump
+goosedump list
+goosedump show pi:context-id
+goosedump grep pi:context-id '*database*'
+goosedump search pi:context-id 'migration failure'
+goosedump compact pi:context-id
 ```
 
-## Usage
+Use `goosedump --help` or the
+[manual page](https://github.com/jarkkojs/goosedump/blob/main/man/man1/goosedump.1)
+for all commands and options.
+
+## Features
+
+- Lists and filters contexts across all supported providers.
+- Renders provider-native output and converts conversations between provider
+  formats.
+- Searches session history with BM25 ranking and glob matching.
+- Imports contexts into another provider's store; pair with `delete` to move
+  them.
+- Recalls durable memory harvested from compacted context ranges.
+
+## Persistent memory
 
-The user guide is available at [`man/man1/goosedump.1`](man/man1/goosedump.1)
+Successful `compact` commands harvest the selected range into the platform
+state directory (`~/.local/state/goosedump/goosedump.db` on Linux). Use
+`recall` to search it, `stats` to inspect it, and `forget` to remove stored
+content or a context's sightings.
 
-## Build
+Memory keeps historical provenance. Deleting or moving a source context does
+not remove previously harvested content. Use `compact --no-learn` or set
+`GOOSEDUMP_NO_LEARN=1` when a range must not be retained. Stored text is not
+secret-filtered.
 
-    cargo build
-    cargo test
+`mutate` performs an optional local merge of two archived memories. It normally
+waits for sufficient usage evidence; `mutate --force` is intended for testing.
+Embedding and compaction models are downloaded on first use, or ahead of time
+with `goosedump pull`. The mutation model is downloaded when first needed.
 
-Local builds require CMake, Clang/libclang, and a C++ compiler because model
-inference uses `llama-cpp-2`. The published Linux x64 artifact is a static
-glibc PIE; the release workflow rejects a dynamic ELF interpreter and shared
-library dependencies.
+## Pi extension
+
+The bundled [pi-goosedump extension](packages/pi-goosedump/README.md) adds
+session-history tools, durable-memory recall, and goosedump compaction to Pi:
 
-## Licensing
+```sh
+pi install npm:pi-goosedump
+```
+
+## Development
+
+```sh
+cargo test --all-targets
+cargo clippy --all-targets -- -D warnings
+cargo fmt --check
+```
 
-`goosedump` is licensed under `LGPL-2.1-or-later`. The JavaScript npm wrapper
-is licensed under `Apache-2.0`.
+The published Linux x64 binary is a static glibc PIE.
 
-### Third-Party Software
+## License
 
-Prebuilt binaries include third-party open-source components. Their copyright
-and license information is collected in [`THIRD_PARTY_NOTICES.txt`](THIRD_PARTY_NOTICES.txt).
+The Rust program is licensed under `LGPL-2.1-or-later`. The npm distribution
+also contains Apache-2.0-licensed components. See
+[`THIRD_PARTY_NOTICES.txt`](THIRD_PARTY_NOTICES.txt) for bundled third-party
+software notices.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jarkkojs/goosedump",
-  "version": "0.10.4",
+  "version": "0.10.5",
   "description": "Coding agent context data browser",
   "license": "Apache-2.0 AND LGPL-2.1-or-later",
   "homepage": "https://github.com/jarkkojs/goosedump#readme",
@@ -22,9 +22,9 @@
     "THIRD_PARTY_NOTICES.txt"
   ],
   "optionalDependencies": {
-    "@jarkkojs/goosedump-darwin-arm64": "0.10.4",
-    "@jarkkojs/goosedump-linux-x64": "0.10.4",
-    "@jarkkojs/goosedump-win32-x64": "0.10.4"
+    "@jarkkojs/goosedump-darwin-arm64": "0.10.5",
+    "@jarkkojs/goosedump-linux-x64": "0.10.5",
+    "@jarkkojs/goosedump-win32-x64": "0.10.5"
   },
   "publishConfig": {
     "access": "public"