@jarkkojs/goosedump 0.11.3 → 0.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +64 -53
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -25,68 +25,72 @@ Source builds require a C compiler for the bundled SQLite library.
25
25
  ## Quick start
26
26
 
27
27
  ```sh
28
- goosedump list
29
- goosedump show pi:context-id
30
- goosedump grep pi:context-id '*database*'
31
- goosedump search pi:context-id 'migration failure'
32
- goosedump compact pi:context-id
28
+ goosedump session list --query '.provider == "pi"'
29
+ goosedump session show pi:context-id
30
+ goosedump session find pi:context-id '*database*'
31
+ goosedump session search pi:context-id 'database failure'
32
+ goosedump session compact pi:context-id
33
33
  ```
34
34
 
35
- Use `goosedump --help` or the
35
+ Every command that operates on a saved session takes an explicit
36
+ `provider:session-id` target. Use `goosedump --help` or the
36
37
  [manual page](https://github.com/jarkkojs/goosedump/blob/main/man/man1/goosedump.1)
37
- for all commands and options.
38
+ for complete usage.
38
39
 
39
- ## Features
40
+ ## Commands
40
41
 
41
- - Lists and filters contexts across all supported providers.
42
- - Renders provider-native output and converts conversations between provider
43
- formats.
44
- - Searches session history with BM25 ranking and glob matching.
45
- - Imports contexts into another provider's store; pair with `delete` to move
46
- them.
47
- - Recalls durable memory harvested from compacted context ranges.
42
+ The command tree mirrors the things it manages:
43
+
44
+ ```text
45
+ session list [--query QUERY] [--json]
46
+ session show PROVIDER:ID [--entry ID] [--all] [--from ID] [--before ID] [--as PROVIDER]
47
+ session find PROVIDER:ID GLOB [range options] [--as PROVIDER]
48
+ session search PROVIDER:ID QUERY [range options] [--page NUMBER] [--as PROVIDER]
49
+ session compact PROVIDER:ID [range options] [--previous-summary SUMMARY] [--plain] [--remember] [--as PROVIDER]
50
+ session copy PROVIDER:ID --to PROVIDER [--yes]
51
+ session remove PROVIDER:ID [--yes]
52
+
53
+ memory search QUERY [--provider PROVIDER] [--path PATH] [--type TYPE] [--limit NUMBER]
54
+ memory status
55
+ memory forget HASH|PROVIDER:ID
56
+
57
+ model pull
58
+ ```
59
+
60
+ `session copy` and `session remove` print their plan by default. Pass `--yes`
61
+ to carry out the change. This makes destructive and cross-provider operations
62
+ safe to inspect without a separate dry-run mode.
48
63
 
49
64
  ## Persistent memory
50
65
 
51
- `compact` emits a summary without retaining the selected range by default. Pass
52
- `--train` to harvest it into the platform state directory
53
- (`~/.local/state/goosedump/goosedump.db` on Linux). Stored entries are classified
54
- as decisions, facts, preferences, procedures, or episodes and include trust,
55
- confidence, validity, scope, derivation, and concrete source provenance. Admission
56
- screening quarantines instruction-like, generated, and malformed content before
57
- retrieval. Indexing uses a durable pending/indexed/failed ledger, recovers interrupted
58
- work, and stops automatic retries after three attempts. Use `recall --type TYPE` to
59
- restrict a search, `stats` to inspect type, governance, and ingestion counts,
60
- `govern review` to inspect quarantined entries, and `ingest review` to inspect
61
- indexing failures.
62
-
63
- Memory keeps historical provenance. Deleting or moving a source context does
64
- not remove previously harvested content. `forget HASH` and `forget PROVIDER:ID`
65
- remove memory and create durable tombstones that prevent re-ingestion. Use
66
- `govern approve`, `quarantine`, `supersede`, `contradict`, and `expire` for explicit
67
- lifecycle control. Pass `compact --train` only when the selected range may be
68
- retained; screening is defensive and is not a substitute for secret filtering.
69
- Reset one terminal failure for another bounded retry cycle with
70
- `ingest retry HASH`.
71
-
72
- `mutate` performs an optional local merge of two archived memories. It normally
73
- waits for sufficient usage evidence; `mutate --force` is intended for testing.
74
- The fixed `GPT-OSS-20B MXFP4` text model is downloaded on first use, or ahead of
75
- time with `goosedump pull`.
66
+ `session compact` emits a summary without retaining the selected range. Add
67
+ `--remember` only when the selected content may become durable memory.
68
+
69
+ Use `memory search` to retrieve learned decisions, facts, preferences,
70
+ procedures, and episodes; `memory status` to inspect the store; and
71
+ `memory forget` with a hash printed by `memory search` or a `provider:session-id`
72
+ to remove it. Forgetting creates durable tombstones so the same content is not
73
+ learned again accidentally.
74
+
75
+ Persistent formats are versioned and never migrated. An incompatible cache is
76
+ rebuilt, while an incompatible memory database is rejected and must be
77
+ reinitialized explicitly. A prior schema is never transformed in place.
76
78
 
77
79
  ## Inference performance
78
80
 
79
- The custom GPT-OSS-20B CPU engine defaults to the physical CPU core count, capped by
80
- the CPUs available to the process. Override the compute thread count:
81
+ The custom GPT-OSS-20B CPU engine uses physical CPU cores, capped by the CPUs
82
+ available to the process, by default. Override the compute thread count:
81
83
 
82
84
  ```sh
83
85
  GOOSEDUMP_INFERENCE_THREADS=6 \
84
- goosedump compact pi:context-id
86
+ goosedump session compact pi:context-id
85
87
  ```
86
88
 
87
- GPT-OSS-20B text generation uses the custom CPU engine. Measure a representative
88
- context before changing the defaults. The `bench` feature builds a standalone harness
89
- that shells out to `goosedump compact` with `GOOSEDUMP_PROFILE_COMPACT=1` and reports
89
+ GPT-OSS-20B text generation continues to use goosedump's custom CPU engine.
90
+ Download its weights ahead of time with `goosedump model pull`.
91
+
92
+ The `bench` feature builds a standalone harness that shells out to
93
+ `goosedump session compact` with `GOOSEDUMP_PROFILE_COMPACT=1` and reports
90
94
  end-to-end and per-stage timings:
91
95
 
92
96
  ```sh
@@ -94,14 +98,15 @@ end-to-end and per-stage timings:
94
98
  cargo bench --features bench
95
99
  ```
96
100
 
97
- Each case emits JSON with per-run timing (including model loading), median and p95
98
- latency, and per-stage medians and p95s. Keep the machine, context range, and model
99
- cache unchanged when comparing configurations.
101
+ Each case emits JSON with per-run timing (including model loading), median and
102
+ p95 latency, and per-stage medians and p95s. Keep the machine, context range,
103
+ and model cache unchanged when comparing configurations.
100
104
 
101
105
  ## Pi extension
102
106
 
103
107
  The bundled [pi-goosedump extension](packages/pi-goosedump/README.md) adds
104
- session-history tools, durable-memory recall, and goosedump compaction to Pi:
108
+ session-history search, entry expansion, durable-memory recall, CWD-scoped session management,
109
+ memory forget/status maintenance, and turn-driven goosedump compaction to Pi:
105
110
 
106
111
  ```sh
107
112
  pi install npm:pi-goosedump
@@ -117,7 +122,13 @@ cargo fmt --check
117
122
 
118
123
  The published Linux x64 and arm64 binaries are static glibc PIEs.
119
124
 
120
- ## License
125
+ ## Licensing
126
+
127
+ 1. `pi-goosedump`: Apache 2.0
128
+ 2. `goosedump`: LGPL 2.1+
129
+
130
+ ### Third Party Attribution
121
131
 
122
- The Rust program is licensed under `LGPL-2.1-or-later`. The npm distribution
123
- also contains Apache-2.0-licensed components.
132
+ 1. GPT-OSS-20B: Apache 2.0
133
+ - Downloaded on first use at run-time. The model is not distributed together
134
+ with goosedump.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jarkkojs/goosedump",
3
- "version": "0.11.3",
3
+ "version": "0.12.1",
4
4
  "description": "Coding agent context data browser",
5
5
  "license": "Apache-2.0 AND LGPL-2.1-or-later",
6
6
  "homepage": "https://github.com/jarkkojs/goosedump#readme",
@@ -21,10 +21,10 @@
21
21
  "LICENSE-LGPL-2.1"
22
22
  ],
23
23
  "optionalDependencies": {
24
- "@jarkkojs/goosedump-darwin-arm64": "0.11.3",
25
- "@jarkkojs/goosedump-linux-arm64": "0.11.3",
26
- "@jarkkojs/goosedump-linux-x64": "0.11.3",
27
- "@jarkkojs/goosedump-win32-x64": "0.11.3"
24
+ "@jarkkojs/goosedump-darwin-arm64": "0.12.1",
25
+ "@jarkkojs/goosedump-linux-arm64": "0.12.1",
26
+ "@jarkkojs/goosedump-linux-x64": "0.12.1",
27
+ "@jarkkojs/goosedump-win32-x64": "0.12.1"
28
28
  },
29
29
  "publishConfig": {
30
30
  "access": "public"