@henryqw/pi-memory 1.1.0 → 1.1.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.
- package/README.md +7 -26
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -29,20 +29,15 @@ To inspect live state, read `<directory>/MEMORY.md`.
|
|
|
29
29
|
|
|
30
30
|
## Config
|
|
31
31
|
|
|
32
|
-
`~/.pi/agent/config/pi-memory/config.json
|
|
33
|
-
|
|
34
|
-
```json
|
|
35
|
-
{
|
|
36
|
-
"directory": "/absolute/path/to/memory",
|
|
37
|
-
"memoryCharLimit": 8800,
|
|
38
|
-
"userCharLimit": 5500
|
|
39
|
-
}
|
|
40
|
-
```
|
|
32
|
+
Optional JSON file at the exact package-owned path `~/.pi/agent/config/pi-memory/config.json`. All fields are optional; a missing file uses defaults.
|
|
41
33
|
|
|
42
|
-
|
|
43
|
-
|
|
34
|
+
| Field | Required | Possible values | Default |
|
|
35
|
+
| --- | --- | --- | --- |
|
|
36
|
+
| `directory` | No | Non-empty absolute path without control characters, e.g. an iCloud- or Obsidian-synced folder | `~/.pi/agent/config/pi-memory/memory` |
|
|
37
|
+
| `memoryCharLimit` | No | Safe integer 1–100000 | `8800` |
|
|
38
|
+
| `userCharLimit` | No | Safe integer 1–100000 | `5500` |
|
|
44
39
|
|
|
45
|
-
|
|
40
|
+
Any other invalid configuration fails fast: malformed JSON, invalid UTF-8, files over 64 KiB, non-object roots, unknown keys, or out-of-range values throw an error naming the problem; the file is never rewritten.
|
|
46
41
|
|
|
47
42
|
## Storage & sync
|
|
48
43
|
|
|
@@ -53,17 +48,3 @@ Backups and the lock file live outside `directory`, under `~/.pi/agent/config/pi
|
|
|
53
48
|
## Threat model
|
|
54
49
|
|
|
55
50
|
Because the directory can be a globally synced location readable outside Pi, review [`ADR 006 — pi-memory global store threat model`](https://github.com/HenryQW/pi-packages/blob/main/docs/adr/006-pi-memory-global-store-threat-model.md) before pointing it at a shared or cloud-synced path.
|
|
56
|
-
|
|
57
|
-
## Remove
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
pi remove npm:@henryqw/pi-memory
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Development
|
|
64
|
-
|
|
65
|
-
```bash
|
|
66
|
-
npm test --workspace @henryqw/pi-memory
|
|
67
|
-
npm run typecheck --workspace @henryqw/pi-memory
|
|
68
|
-
npm run pack:check --workspace @henryqw/pi-memory
|
|
69
|
-
```
|