Skip to content

Commit e430327

Browse files
Abiola BakareAbiola Bakare
authored andcommitted
docs: remove unpublished npm paths and align binary/docs with git install
1 parent e480f1e commit e430327

5 files changed

Lines changed: 38 additions & 63 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22

33
## 2.1.1
44

5-
- packaged Pi-memory v2 for public install (npm/bun/pi package)
5+
- packaged Pi-Memory v2 for public git install via Pi (`pi install git:...`)
66
- added setup/doctor/smoke scripts
77
- bundled extension, skill, and prompts
88
- documented install, architecture, extension lifecycle, and agent usage
9+
- clarified three-layer memory model and JSONL-vs-memory positioning
10+
- added manual compaction controls documentation (`/compact-threshold`, `/compact`)
11+
- aligned binary version output with package version (`2.1.1`)
912
- improved packaged extension binary resolution order:
1013
1) `PI_MEMORY_BIN`
1114
2) `~/.pi/memory/pi-memory`

README.md

Lines changed: 14 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -74,57 +74,39 @@ This installs all Pi components declared in `package.json`:
7474
curl -fsSL https://raw.githubusercontent.com/SiliconState/Pi-Memory/main/scripts/install.sh | bash
7575
```
7676

77-
### npm package (after publish)
78-
79-
```bash
80-
pi install npm:@siliconstate/pi-memory
81-
```
82-
8377
Then verify:
8478

8579
```bash
8680
~/.pi/memory/pi-memory --version
8781
```
8882

89-
### npm global (after npm publish)
90-
91-
```bash
92-
npm i -g @siliconstate/pi-memory
93-
pi-memory-setup
94-
pi-memory-doctor
95-
```
96-
97-
### bun global (after npm publish)
98-
99-
```bash
100-
bun add -g @siliconstate/pi-memory
101-
pi-memory-setup
102-
pi-memory-doctor
103-
```
104-
105-
> If native compile is skipped during install, run `pi-memory-setup` manually.
83+
> If native compile is skipped during install, rerun the curl installer or follow manual compile troubleshooting in `docs/INSTALL.md`.
84+
>
85+
> npm/bun publish is planned but not currently live. For now, use the git install (or curl wrapper) above.
10686
10787
---
10888

10989
## Quick Start
11090

11191
```bash
92+
BIN="${PI_MEMORY_BIN:-$HOME/.pi/memory/pi-memory}"
93+
11294
# initialize MEMORY.md markers
113-
pi-memory init
95+
"$BIN" init
11496

11597
# log memory records
116-
pi-memory log decision "Use SQLite for memory" --choice "Single local DB" --rationale "Simple + durable"
117-
pi-memory log finding "Extension hooks run at session_shutdown" --category architecture --confidence verified
118-
pi-memory log lesson "Forgot to sync MEMORY.md" --fix "Run sync before compaction"
119-
pi-memory log entity "SessionManager" --type concept --description "Pi session tree manager"
98+
"$BIN" log decision "Use SQLite for memory" --choice "Single local DB" --rationale "Simple + durable"
99+
"$BIN" log finding "Extension hooks run at session_shutdown" --category architecture --confidence verified
100+
"$BIN" log lesson "Forgot to sync MEMORY.md" --fix "Run sync before compaction"
101+
"$BIN" log entity "SessionManager" --type concept --description "Pi session tree manager"
120102

121103
# inspect
122-
pi-memory query --limit 20
123-
pi-memory search "compaction"
124-
pi-memory state <project>
104+
"$BIN" query --limit 20
105+
"$BIN" search "compaction"
106+
"$BIN" state <project>
125107

126108
# sync docs
127-
pi-memory sync MEMORY.md --limit 15
109+
"$BIN" sync MEMORY.md --limit 15
128110
```
129111

130112
---

docs/AGENT-USAGE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This guide is for agent authors/operators using Pi-Memory in Pi workflows.
44

5+
If `pi-memory` is not on PATH in your environment, call it explicitly as `~/.pi/memory/pi-memory`.
6+
57
## Core operating rules
68

79
1. Log decisions when choices are made, not after the session ends.

docs/INSTALL.md

Lines changed: 17 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -28,27 +28,11 @@ curl -fsSL https://raw.githubusercontent.com/SiliconState/Pi-Memory/main/scripts
2828

2929
The installer script runs `pi install ...` and falls back to direct compile if needed.
3030

31-
## Option C: Pi CLI install from npm (after publish)
31+
## npm/bun status
3232

33-
```bash
34-
pi install npm:@siliconstate/pi-memory
35-
```
36-
37-
## Option D: npm global install (after npm publish)
38-
39-
```bash
40-
npm i -g @siliconstate/pi-memory
41-
pi-memory-setup
42-
pi-memory-doctor
43-
```
33+
npm/bun publish is planned but not currently live.
4434

45-
## Option E: bun global install (after npm publish)
46-
47-
```bash
48-
bun add -g @siliconstate/pi-memory
49-
pi-memory-setup
50-
pi-memory-doctor
51-
```
35+
Use Option A (`pi install git:...`) or Option B (curl installer) for now.
5236

5337
## Native build output
5438

@@ -74,10 +58,21 @@ export PI_MEMORY_BIN=/custom/path/pi-memory
7458

7559
### `Failed to compile pi-memory`
7660

77-
Install build prerequisites and rerun:
61+
Install build prerequisites and rerun the installer:
7862

7963
```bash
80-
pi-memory-setup
64+
pi install git:github.com/SiliconState/Pi-Memory
65+
```
66+
67+
If needed, compile manually:
68+
69+
```bash
70+
CC_BIN="${CC:-cc}"
71+
SRC="$HOME/.pi/agent/git/github.com/SiliconState/Pi-Memory/native/pi-memory.c"
72+
[ -f "$SRC" ] || SRC="$HOME/.pi/git/github.com/SiliconState/Pi-Memory/native/pi-memory.c"
73+
mkdir -p "$HOME/.pi/memory"
74+
"$CC_BIN" -Wall -Wextra -Wpedantic -O2 -std=c11 -o "$HOME/.pi/memory/pi-memory" "$SRC" -lsqlite3
75+
chmod +x "$HOME/.pi/memory/pi-memory"
8176
```
8277

8378
### Extension can’t find binary
@@ -90,14 +85,7 @@ export PI_MEMORY_BIN="$HOME/.pi/memory/pi-memory"
9085

9186
### Check health quickly
9287

93-
Always works:
94-
9588
```bash
9689
~/.pi/memory/pi-memory --version
97-
```
98-
99-
If installed via npm/bun global, you can also run:
100-
101-
```bash
102-
pi-memory-doctor
90+
~/.pi/memory/pi-memory help
10391
```

native/pi-memory.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
#include <sys/types.h>
5151
#include <unistd.h>
5252

53-
#define VERSION "2.1.0"
53+
#define VERSION "2.1.1"
5454
#define MAX_PATH 1024
5555
#define MAX_BUF 8192
5656
#define MAX_JSON_VAL 65536

0 commit comments

Comments
 (0)