@owrede/vault-memory 0.8.2 → 0.8.3
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 +37 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -96,43 +96,65 @@ brew install ollama && brew services start ollama
|
|
|
96
96
|
# 4) Embedding model (~1.1 GB)
|
|
97
97
|
ollama pull bge-m3
|
|
98
98
|
|
|
99
|
-
# 5)
|
|
100
|
-
|
|
101
|
-
gh repo clone owrede/vault-memory
|
|
102
|
-
cd vault-memory
|
|
103
|
-
npm install && npm run build && npm link # creates the global `vault-memory` binary
|
|
99
|
+
# 5) Install vault-memory from npm (public registry, no auth)
|
|
100
|
+
npm install -g @owrede/vault-memory
|
|
104
101
|
|
|
105
102
|
# 6) Register your first vault (creates config + .mcp.json + initial index)
|
|
106
103
|
vault-memory add-vault "/Users/you/Documents/Obsidian Vaults/My Vault"
|
|
107
104
|
```
|
|
108
105
|
|
|
109
|
-
The MCP-host config (`.mcp.json` in the consuming vault) calls the `vault-memory` binary, so any shell with it on `$PATH` will work.
|
|
106
|
+
The MCP-host config (`.mcp.json` in the consuming vault) calls the `vault-memory` binary, so any shell with it on `$PATH` will work. Future upgrades: `npm install -g @owrede/vault-memory@latest`.
|
|
110
107
|
|
|
111
108
|
For a guided install from inside Claude Code, see the `skills/` directory in this repo — they bundle the install, vault registration, and end-to-end smoketest behind a single command.
|
|
112
109
|
|
|
110
|
+
### Install from source (developer mode)
|
|
111
|
+
|
|
112
|
+
Only needed if you want to modify vault-memory itself. Otherwise use the npm install above.
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
cd ~/Documents/GitHub
|
|
116
|
+
gh repo clone owrede/vault-memory
|
|
117
|
+
cd vault-memory
|
|
118
|
+
npm install && npm run build && npm link # creates the global `vault-memory` binary
|
|
119
|
+
```
|
|
120
|
+
|
|
113
121
|
## Skills (Claude Code integration)
|
|
114
122
|
|
|
115
|
-
The `skills/` directory contains
|
|
123
|
+
The `skills/` directory contains two Claude Code skills you can drop into any vault's `.claude/skills/` folder. They are the user-facing way to install and operate vault-memory without remembering CLI flags.
|
|
116
124
|
|
|
117
125
|
| Skill | What it does | When to invoke |
|
|
118
126
|
|---|---|---|
|
|
119
|
-
| **`memory/`** |
|
|
120
|
-
| **`
|
|
121
|
-
| **`add-vault/`** | Wraps `vault-memory add-vault` with a confirmation flow — appends to `config.toml`, writes `.mcp.json`, builds the initial index. Atomic and idempotent. | Adding an additional vault after the system is installed. `/add-vault` |
|
|
127
|
+
| **`install-vault-memory/`** | The complete installer — 8 idempotent checkpoints from Homebrew through MCP smoketest. Defaults to autonomous mode with a `why:` line on every install prompt. Re-running on a working setup verifies state in under 5 seconds and exits. | First-time setup of a vault, or repairing a broken state. `/install-vault-memory` |
|
|
128
|
+
| **`add-vault/`** | Wraps `vault-memory add-vault` CLI with a confirmation flow — appends to `config.toml`, writes `.mcp.json`, builds the initial index. Atomic and idempotent. | Adding a *second or third* vault after vault-memory is already installed. `/add-vault` |
|
|
122
129
|
|
|
123
130
|
### Installing the skills in a vault
|
|
124
131
|
|
|
132
|
+
One-liner — works from anywhere, installs into the specified vault:
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
curl -fsSL https://raw.githubusercontent.com/owrede/vault-memory/main/scripts/install-skills.sh \
|
|
136
|
+
| bash -s -- "/path/to/your/obsidian/vault"
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Or, from inside the vault's root directory:
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
curl -fsSL https://raw.githubusercontent.com/owrede/vault-memory/main/scripts/install-skills.sh | bash
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
The script is idempotent — re-running it fetches the latest skill versions from `main` and overwrites the local copies. Use it to update your skills whenever vault-memory ships a new release.
|
|
146
|
+
|
|
147
|
+
If you cloned the source repo, you can also copy directly:
|
|
148
|
+
|
|
125
149
|
```bash
|
|
126
|
-
|
|
127
|
-
mkdir -p .claude/skills
|
|
128
|
-
cp -R ~/Documents/GitHub/vault-memory/skills/{memory,setup-memory-system,add-vault} .claude/skills/
|
|
150
|
+
cp -R ~/Documents/GitHub/vault-memory/skills/{install-vault-memory,add-vault} .claude/skills/
|
|
129
151
|
```
|
|
130
152
|
|
|
131
|
-
After Claude Code restarts, `/
|
|
153
|
+
After Claude Code restarts, `/install-vault-memory` and `/add-vault` are available as slash commands in that vault.
|
|
132
154
|
|
|
133
155
|
### Autonomous mode
|
|
134
156
|
|
|
135
|
-
`VAULT_MEMORY_AUTO=1` switches `
|
|
157
|
+
`VAULT_MEMORY_AUTO=1` switches `install-vault-memory/setup.sh` to non-interactive mode: every non-destructive `confirm()` prompt auto-answers yes, with a `why:` line explaining what is being installed and why vault-memory needs it. Destructive operations (overwriting an existing multi-vault `config.toml`, rebuilding a clone with uncommitted changes) still prompt. This is the default when the skill is invoked via `/install-vault-memory`; direct invocation of `setup.sh` defaults to fully-interactive mode.
|
|
136
158
|
|
|
137
159
|
## Configuration
|
|
138
160
|
|