squish-memory 1.0.2 → 1.1.5

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 (341) hide show
  1. package/.env.example +130 -0
  2. package/CHANGELOG.md +55 -0
  3. package/README.md +150 -287
  4. package/config/hooks/claude-code-hooks.json +39 -0
  5. package/config/hooks/cursor-hooks.json +30 -0
  6. package/config/hooks/opencode-hooks.json +30 -0
  7. package/config/hooks/windsurf-hooks.json +30 -0
  8. package/config/mcp-mode-semantics.json +23 -21
  9. package/config/plugin-manifest.json +101 -152
  10. package/{plugin.json → config/plugin.json} +2 -2
  11. package/config/settings.json +52 -51
  12. package/{commands → core/commands}/init.md +39 -39
  13. package/dist/config.d.ts +28 -4
  14. package/dist/config.js +97 -29
  15. package/dist/core/adapters/config/claude-code.d.ts +45 -0
  16. package/dist/core/adapters/config/claude-code.js +113 -0
  17. package/dist/core/adapters/config/cursor.d.ts +26 -0
  18. package/dist/core/adapters/config/cursor.js +74 -0
  19. package/dist/core/adapters/config/opencode.d.ts +23 -0
  20. package/dist/core/adapters/config/opencode.js +73 -0
  21. package/dist/core/adapters/config/windsurf.d.ts +26 -0
  22. package/dist/core/adapters/config/windsurf.js +74 -0
  23. package/dist/core/adapters/index.d.ts +45 -0
  24. package/dist/core/adapters/index.js +84 -0
  25. package/dist/core/adapters/scripts/install-adapter.d.ts +19 -0
  26. package/dist/core/adapters/scripts/install-adapter.js +149 -0
  27. package/dist/core/adapters/timeline.d.ts +23 -0
  28. package/dist/core/adapters/timeline.js +88 -0
  29. package/dist/core/adapters/types.d.ts +157 -0
  30. package/dist/core/adapters/types.js +50 -0
  31. package/dist/{algorithms → core/algorithms}/analytics/token-estimator.d.ts +1 -1
  32. package/dist/{algorithms → core/algorithms}/analytics/token-estimator.js +3 -3
  33. package/dist/{algorithms → core/algorithms}/detection/semantic-ranker.d.ts +1 -1
  34. package/dist/{algorithms → core/algorithms}/detection/semantic-ranker.js +1 -1
  35. package/dist/{algorithms → core/algorithms}/detection/two-stage-detector.d.ts +1 -1
  36. package/dist/{algorithms → core/algorithms}/detection/two-stage-detector.js +7 -10
  37. package/dist/{algorithms → core/algorithms}/handlers/approve-merge.js +4 -4
  38. package/dist/{algorithms → core/algorithms}/handlers/detect-duplicates.js +3 -3
  39. package/dist/{algorithms → core/algorithms}/handlers/get-stats.js +3 -3
  40. package/dist/{algorithms → core/algorithms}/handlers/list-proposals.js +3 -3
  41. package/dist/{algorithms → core/algorithms}/handlers/preview-merge.js +3 -3
  42. package/dist/{algorithms → core/algorithms}/handlers/reject-merge.js +3 -3
  43. package/dist/{algorithms → core/algorithms}/handlers/reverse-merge.js +3 -3
  44. package/dist/core/algorithms/index.d.ts +21 -0
  45. package/dist/core/algorithms/index.js +26 -0
  46. package/dist/core/algorithms/operations/cache-maintenance.d.ts +12 -0
  47. package/dist/core/algorithms/operations/cache-maintenance.js +157 -0
  48. package/dist/{algorithms → core/algorithms}/safety/safety-checks.d.ts +1 -1
  49. package/dist/{algorithms → core/algorithms}/strategies/merge-strategies.d.ts +19 -1
  50. package/dist/{algorithms → core/algorithms}/strategies/merge-strategies.js +74 -123
  51. package/dist/core/algorithms/types.d.ts +133 -0
  52. package/dist/core/algorithms/types.js +5 -0
  53. package/dist/core/associations.d.ts +1 -2
  54. package/dist/core/associations.js +1 -2
  55. package/dist/core/autosave.d.ts +19 -0
  56. package/dist/core/autosave.js +16 -0
  57. package/dist/{commands → core/commands}/managed-sync.js +5 -5
  58. package/dist/core/commands/mcp-server.js +739 -0
  59. package/dist/core/context/agent-context.d.ts +106 -0
  60. package/dist/core/context/agent-context.js +274 -0
  61. package/dist/core/{context-paging.d.ts → context/context-paging.d.ts} +2 -12
  62. package/dist/core/{context-paging.js → context/context-paging.js} +19 -39
  63. package/dist/core/context/context-window.d.ts +40 -0
  64. package/dist/core/context/context-window.js +177 -0
  65. package/dist/core/context/context.js +22 -0
  66. package/dist/core/embeddings.d.ts +1 -1
  67. package/dist/core/embeddings.js +54 -2
  68. package/dist/core/error-handling.d.ts +63 -0
  69. package/dist/core/error-handling.js +173 -0
  70. package/dist/core/external-folder/index.d.ts +102 -0
  71. package/dist/core/external-folder/index.js +294 -0
  72. package/dist/core/hooks/agent-hooks.d.ts +74 -0
  73. package/dist/core/hooks/agent-hooks.js +244 -0
  74. package/dist/core/hooks/auto-tagger.d.ts +19 -0
  75. package/dist/core/hooks/auto-tagger.js +155 -0
  76. package/dist/core/hooks/capture-filter.d.ts +41 -0
  77. package/dist/core/hooks/capture-filter.js +128 -0
  78. package/dist/core/index.d.ts +6 -6
  79. package/dist/core/index.js +6 -6
  80. package/dist/core/{agent-memory.js → ingestion/agent-memory.js} +5 -7
  81. package/dist/core/{core-memory.js → ingestion/core-memory.js} +4 -4
  82. package/dist/core/ingestion/learnings.d.ts +57 -0
  83. package/dist/core/ingestion/learnings.js +202 -0
  84. package/dist/core/lib/db-client.d.ts +114 -0
  85. package/dist/core/lib/db-client.js +130 -0
  86. package/dist/core/lib/schemas.d.ts +129 -0
  87. package/dist/core/lib/schemas.js +87 -0
  88. package/dist/core/{utils.d.ts → lib/utils.d.ts} +1 -0
  89. package/dist/core/{utils.js → lib/utils.js} +31 -15
  90. package/dist/core/lib/validation.d.ts +38 -0
  91. package/dist/core/lib/validation.js +151 -0
  92. package/dist/core/lifecycle.d.ts +7 -0
  93. package/dist/core/lifecycle.js +140 -20
  94. package/dist/core/local-embeddings.d.ts +6 -1
  95. package/dist/core/local-embeddings.js +6 -15
  96. package/dist/core/logger.js +7 -1
  97. package/dist/core/mcp/tools.js +35 -3
  98. package/dist/core/memory/categorizer.js +1 -0
  99. package/dist/core/memory/conflict-detector.js +1 -1
  100. package/dist/core/memory/consolidation.d.ts +1 -10
  101. package/dist/core/memory/consolidation.js +2 -11
  102. package/dist/core/memory/context-collector.js +1 -1
  103. package/dist/core/memory/edit-workflow.js +1 -1
  104. package/dist/core/memory/entity-resolver.js +7 -7
  105. package/dist/core/memory/fact-extractor.js +12 -12
  106. package/dist/core/memory/feedback-tracker.js +1 -1
  107. package/dist/core/memory/hooks.d.ts +88 -0
  108. package/dist/core/memory/hooks.js +174 -0
  109. package/dist/core/memory/hybrid-retrieval.js +2 -2
  110. package/dist/core/memory/hybrid-search.d.ts +1 -6
  111. package/dist/core/memory/hybrid-search.js +70 -84
  112. package/dist/core/memory/importance.d.ts +8 -13
  113. package/dist/core/memory/importance.js +47 -74
  114. package/dist/core/memory/loader.d.ts +31 -0
  115. package/dist/core/memory/loader.js +141 -0
  116. package/dist/core/memory/markdown/markdown-storage.d.ts +72 -0
  117. package/dist/core/memory/markdown/markdown-storage.js +243 -0
  118. package/dist/core/memory/memories.d.ts +12 -4
  119. package/dist/core/memory/memories.js +192 -180
  120. package/dist/core/memory/memory-lifecycle.d.ts +8 -0
  121. package/dist/core/memory/memory-lifecycle.js +55 -0
  122. package/dist/core/memory/migrate.d.ts +21 -0
  123. package/dist/core/memory/migrate.js +134 -0
  124. package/dist/core/memory/normalization.d.ts +22 -0
  125. package/dist/core/memory/normalization.js +26 -0
  126. package/dist/core/memory/progressive-disclosure.js +1 -1
  127. package/dist/core/memory/query-rewriter.js +9 -9
  128. package/dist/core/memory/serialization.d.ts +4 -0
  129. package/dist/core/memory/serialization.js +49 -0
  130. package/dist/core/memory/stats.d.ts +5 -0
  131. package/dist/core/memory/stats.js +63 -12
  132. package/dist/core/memory/temporal-facts.js +21 -0
  133. package/dist/core/memory/write-gate.js +1 -1
  134. package/dist/core/obsidian-vault.d.ts +30 -0
  135. package/dist/core/obsidian-vault.js +94 -0
  136. package/dist/core/places/index.d.ts +14 -0
  137. package/dist/core/places/index.js +14 -0
  138. package/dist/core/places/memory-places.d.ts +68 -0
  139. package/dist/core/places/memory-places.js +261 -0
  140. package/dist/core/places/places.d.ts +88 -0
  141. package/dist/core/places/places.js +314 -0
  142. package/dist/core/places/rules.d.ts +74 -0
  143. package/dist/core/places/rules.js +240 -0
  144. package/dist/core/places/walking.d.ts +56 -0
  145. package/dist/core/places/walking.js +121 -0
  146. package/dist/core/projects.d.ts +5 -0
  147. package/dist/core/projects.js +39 -18
  148. package/dist/core/responses.d.ts +96 -0
  149. package/dist/core/responses.js +122 -0
  150. package/dist/core/scheduler/cron-scheduler.js +29 -7
  151. package/dist/core/scheduler/index.d.ts +1 -1
  152. package/dist/core/scheduler/index.js +1 -1
  153. package/dist/core/scheduler/job-runner.js +1 -1
  154. package/dist/core/search/conversations.js +40 -42
  155. package/dist/core/search/entities.js +6 -9
  156. package/dist/core/search/graph-boost.d.ts +7 -0
  157. package/dist/core/search/graph-boost.js +23 -0
  158. package/dist/core/search/qmd-search.js +4 -4
  159. package/dist/core/security/encrypt.d.ts +6 -0
  160. package/dist/core/security/encrypt.js +47 -0
  161. package/dist/core/{governance.d.ts → security/governance.d.ts} +6 -1
  162. package/dist/core/security/governance.js +79 -0
  163. package/dist/core/session/auto-load.js +6 -6
  164. package/dist/core/session/index.d.ts +1 -1
  165. package/dist/core/session/index.js +1 -1
  166. package/dist/core/session/self-iteration-job.d.ts +20 -0
  167. package/dist/core/session/self-iteration-job.js +282 -0
  168. package/dist/core/session/session-hooks.d.ts +18 -0
  169. package/dist/core/session/session-hooks.js +58 -0
  170. package/dist/core/session-hooks/self-iteration-job.js +35 -35
  171. package/dist/core/{cache.js → storage/cache.js} +2 -2
  172. package/dist/core/sync/qmd-sync.d.ts +1 -13
  173. package/dist/core/sync/qmd-sync.js +1 -13
  174. package/dist/core/toon.d.ts +43 -0
  175. package/dist/core/toon.js +160 -0
  176. package/dist/core/utils/memory-operations.js +1 -1
  177. package/dist/core/utils/vector-operations.d.ts +71 -0
  178. package/dist/core/utils/vector-operations.js +129 -0
  179. package/dist/db/adapter.d.ts +3 -3
  180. package/dist/db/adapter.js +99 -88
  181. package/dist/db/bootstrap.js +820 -522
  182. package/dist/{drizzle → db/drizzle}/schema-sqlite.d.ts +74 -25
  183. package/dist/{drizzle → db/drizzle}/schema-sqlite.js +91 -24
  184. package/dist/{drizzle → db/drizzle}/schema.d.ts +79 -32
  185. package/dist/{drizzle → db/drizzle}/schema.js +106 -35
  186. package/dist/db/drizzle.config.d.ts +3 -0
  187. package/dist/db/drizzle.config.js +12 -0
  188. package/dist/db/index.d.ts +1 -5
  189. package/dist/db/index.js +51 -8
  190. package/dist/db/neon.d.ts +8 -0
  191. package/dist/db/neon.js +20 -0
  192. package/dist/db/schema/index.d.ts +40 -0
  193. package/dist/db/schema/index.js +105 -0
  194. package/dist/db/schema/tables/context-sessions.d.ts +9 -0
  195. package/dist/db/schema/tables/context-sessions.js +37 -0
  196. package/dist/db/schema/tables/conversations.d.ts +9 -0
  197. package/dist/db/schema/tables/conversations.js +47 -0
  198. package/dist/db/schema/tables/core-memory.d.ts +9 -0
  199. package/dist/db/schema/tables/core-memory.js +41 -0
  200. package/dist/db/schema/tables/entities.d.ts +9 -0
  201. package/dist/db/schema/tables/entities.js +39 -0
  202. package/dist/db/schema/tables/entity-relations.d.ts +9 -0
  203. package/dist/db/schema/tables/entity-relations.js +31 -0
  204. package/dist/db/schema/tables/learnings.d.ts +9 -0
  205. package/dist/db/schema/tables/learnings.js +66 -0
  206. package/dist/db/schema/tables/memories.d.ts +9 -0
  207. package/dist/db/schema/tables/memories.js +161 -0
  208. package/dist/db/schema/tables/memory-associations.d.ts +9 -0
  209. package/dist/db/schema/tables/memory-associations.js +39 -0
  210. package/dist/db/schema/tables/memory-hash-cache.d.ts +9 -0
  211. package/dist/db/schema/tables/memory-hash-cache.js +29 -0
  212. package/dist/db/schema/tables/memory-merge-history.d.ts +9 -0
  213. package/dist/db/schema/tables/memory-merge-history.js +33 -0
  214. package/dist/db/schema/tables/memory-merge-proposals.d.ts +9 -0
  215. package/dist/db/schema/tables/memory-merge-proposals.js +39 -0
  216. package/dist/db/schema/tables/messages.d.ts +9 -0
  217. package/dist/db/schema/tables/messages.js +41 -0
  218. package/dist/db/schema/tables/namespaces.d.ts +9 -0
  219. package/dist/db/schema/tables/namespaces.js +37 -0
  220. package/dist/db/schema/tables/projects.d.ts +9 -0
  221. package/dist/db/schema/tables/projects.js +31 -0
  222. package/dist/db/schema/tables/users.d.ts +9 -0
  223. package/dist/db/schema/tables/users.js +27 -0
  224. package/dist/db/schema.d.ts +1 -1
  225. package/dist/db/schema.js +2 -2
  226. package/dist/db/supabase.d.ts +9 -0
  227. package/dist/db/supabase.js +24 -0
  228. package/dist/index.d.ts +2 -14
  229. package/dist/index.js +1320 -640
  230. package/dist/vendor/sql.js/sql-wasm.wasm +0 -0
  231. package/dist/webui/server.d.ts +5 -0
  232. package/dist/{api/web/web.js → webui/server.js} +511 -508
  233. package/generated/mcp/manifest.json +1 -1
  234. package/{.mcp.json → mcp.json.example} +1 -1
  235. package/package.json +159 -181
  236. package/scripts/README.md +60 -0
  237. package/scripts/copy-runtime-assets.mjs +26 -0
  238. package/scripts/generate-mcp.mjs +264 -264
  239. package/scripts/github-release.sh +4 -4
  240. package/scripts/install-claude-code.sh +85 -0
  241. package/scripts/install-cursor.sh +56 -0
  242. package/scripts/install-hooks.sh +73 -0
  243. package/scripts/install-interactive.mjs +357 -677
  244. package/scripts/install-opencode.sh +75 -0
  245. package/scripts/install-windsurf.sh +67 -0
  246. package/skills/squish-memory/SKILL.md +104 -114
  247. package/skills/squish-memory/{install.mjs → scripts/install.mjs} +2 -2
  248. package/skills/squish-memory/{install.sh → scripts/install.sh} +2 -2
  249. package/skills/squish-memory/write_skill.js +2 -0
  250. package/.claude-plugin/marketplace.json +0 -20
  251. package/.claude-plugin/plugin.json +0 -32
  252. package/.env.mcp.example +0 -60
  253. package/QUICK-START.md +0 -71
  254. package/bin/squish-add.mjs +0 -32
  255. package/bin/squish-rm.mjs +0 -21
  256. package/commands/observe.md +0 -5
  257. package/dist/api/web/index.d.ts +0 -3
  258. package/dist/api/web/index.js +0 -4
  259. package/dist/api/web/web-server.d.ts +0 -3
  260. package/dist/api/web/web-server.js +0 -6
  261. package/dist/api/web/web.d.ts +0 -4
  262. package/dist/commands/mcp-server.js +0 -393
  263. package/dist/core/context.js +0 -24
  264. package/dist/core/governance.js +0 -64
  265. package/dist/core/observations.d.ts +0 -26
  266. package/dist/core/observations.js +0 -110
  267. package/dist/core/requirements.d.ts +0 -20
  268. package/dist/core/requirements.js +0 -35
  269. package/hooks/hooks.json +0 -52
  270. package/hooks/post-tool-use.js +0 -26
  271. package/hooks/session-end.js +0 -28
  272. package/hooks/session-start.js +0 -33
  273. package/hooks/user-prompt-submit.js +0 -26
  274. package/hooks/utils.js +0 -153
  275. package/npx-installer.js +0 -208
  276. package/packages/plugin-claude-code/README.md +0 -73
  277. package/packages/plugin-claude-code/dist/plugin-wrapper.d.ts +0 -35
  278. package/packages/plugin-claude-code/dist/plugin-wrapper.js +0 -191
  279. package/packages/plugin-claude-code/package.json +0 -31
  280. package/packages/plugin-openclaw/README.md +0 -70
  281. package/packages/plugin-openclaw/dist/index.d.ts +0 -49
  282. package/packages/plugin-openclaw/dist/index.js +0 -262
  283. package/packages/plugin-openclaw/openclaw.plugin.json +0 -94
  284. package/packages/plugin-openclaw/package.json +0 -31
  285. package/packages/plugin-opencode/install.mjs +0 -217
  286. package/packages/plugin-opencode/package.json +0 -21
  287. package/scripts/db/check-db.mjs +0 -88
  288. package/scripts/db/fix-all-columns.mjs +0 -52
  289. package/scripts/db/fix-schema-all.mjs +0 -55
  290. package/scripts/db/fix-schema-full.mjs +0 -46
  291. package/scripts/db/fix-schema.mjs +0 -38
  292. package/scripts/db/init-db.mjs +0 -13
  293. package/scripts/db/recreate-db.mjs +0 -14
  294. package/scripts/install-mcp.mjs +0 -116
  295. package/scripts/install-web.sh +0 -120
  296. package/scripts/install.mjs +0 -340
  297. package/scripts/openclaw-bootstrap.mjs +0 -127
  298. package/scripts/package-release.sh +0 -71
  299. package/scripts/test/test-all-systems.mjs +0 -139
  300. package/scripts/test/test-memory-system.mjs +0 -139
  301. package/scripts/test/test-v0.5.0.mjs +0 -210
  302. package/skills/memory-guide/SKILL.md +0 -332
  303. package/skills/squish-cli/SKILL.md +0 -240
  304. package/skills/squish-mcp/SKILL.md +0 -355
  305. package/skills/squish-memory/claude-desktop.json +0 -12
  306. package/skills/squish-memory/openclaw.json +0 -13
  307. package/skills/squish-memory/opencode.json +0 -14
  308. package/skills/squish-memory/skill.json +0 -32
  309. /package/{commands → core/commands}/context-paging.md +0 -0
  310. /package/{commands → core/commands}/context-status.md +0 -0
  311. /package/{commands → core/commands}/context.md +0 -0
  312. /package/{commands → core/commands}/core-memory.md +0 -0
  313. /package/{commands → core/commands}/health.md +0 -0
  314. /package/{commands → core/commands}/merge.md +0 -0
  315. /package/{commands → core/commands}/recall.md +0 -0
  316. /package/{commands → core/commands}/remember.md +0 -0
  317. /package/{commands → core/commands}/search.md +0 -0
  318. /package/dist/{algorithms → core/algorithms}/detection/hash-filters.d.ts +0 -0
  319. /package/dist/{algorithms → core/algorithms}/detection/hash-filters.js +0 -0
  320. /package/dist/{algorithms → core/algorithms}/handlers/approve-merge.d.ts +0 -0
  321. /package/dist/{algorithms → core/algorithms}/handlers/detect-duplicates.d.ts +0 -0
  322. /package/dist/{algorithms → core/algorithms}/handlers/get-stats.d.ts +0 -0
  323. /package/dist/{algorithms → core/algorithms}/handlers/list-proposals.d.ts +0 -0
  324. /package/dist/{algorithms → core/algorithms}/handlers/preview-merge.d.ts +0 -0
  325. /package/dist/{algorithms → core/algorithms}/handlers/reject-merge.d.ts +0 -0
  326. /package/dist/{algorithms → core/algorithms}/handlers/reverse-merge.d.ts +0 -0
  327. /package/dist/{algorithms → core/algorithms}/safety/safety-checks.js +0 -0
  328. /package/dist/{algorithms → core/algorithms}/utils/response-builder.d.ts +0 -0
  329. /package/dist/{algorithms → core/algorithms}/utils/response-builder.js +0 -0
  330. /package/dist/{commands → core/commands}/managed-sync.d.ts +0 -0
  331. /package/dist/{commands → core/commands}/mcp-server.d.ts +0 -0
  332. /package/dist/core/{context.d.ts → context/context.d.ts} +0 -0
  333. /package/dist/core/{agent-memory.d.ts → ingestion/agent-memory.d.ts} +0 -0
  334. /package/dist/core/{core-memory.d.ts → ingestion/core-memory.d.ts} +0 -0
  335. /package/dist/core/{privacy.d.ts → security/privacy.d.ts} +0 -0
  336. /package/dist/core/{privacy.js → security/privacy.js} +0 -0
  337. /package/dist/core/{secret-detector.d.ts → security/secret-detector.d.ts} +0 -0
  338. /package/dist/core/{secret-detector.js → security/secret-detector.js} +0 -0
  339. /package/dist/core/{cache.d.ts → storage/cache.d.ts} +0 -0
  340. /package/dist/core/{database.d.ts → storage/database.d.ts} +0 -0
  341. /package/dist/core/{database.js → storage/database.js} +0 -0
@@ -1,332 +0,0 @@
1
- ---
2
- name: memory-guide
3
- description: Expert guide for using Squish memory system v1.0.2. Use when managing persistent memory, storing context, recalling information, or optimizing memory usage across MCP clients.
4
- version: 1.0.2
5
- author: michielhdoteth
6
- tags: [memory, persistence, squish, guide, mcp, ai-assistant]
7
- emoji: book
8
- ---
9
-
10
- # Squish Memory System Guide v1.0.2
11
-
12
- You are an expert at using the Squish persistent memory system for AI coding assistants.
13
-
14
- ## When to Use Squish Memory
15
-
16
- Use Squish memory tools proactively for:
17
-
18
- ### 1. Storing Important Information
19
- - User preferences, project context, decisions made
20
- - Technical specifications, API patterns, architecture notes
21
- - Ongoing work, TODOs, blockers encountered
22
-
23
- ### 2. Recalling Past Context
24
- - Previous conversations and decisions
25
- - Code patterns used in this project
26
- - User's coding style preferences
27
-
28
- ### 3. Managing Session Context
29
- - Load relevant memories before starting complex tasks
30
- - Inject project-specific context
31
- - Maintain working memory across sessions
32
-
33
- ## MCP Tools Reference
34
-
35
- ### Storing Memories
36
-
37
- **Tool:** `squish_remember`
38
-
39
- Store new memories with automatic embedding.
40
-
41
- ```typescript
42
- // Store a preference
43
- squish_remember({
44
- content: "User prefers functional components with hooks over class components",
45
- type: "preference",
46
- tags: ["react", "preferences"]
47
- })
48
-
49
- // Store a fact
50
- squish_remember({
51
- content: "API uses JWT tokens with 1-hour expiration",
52
- type: "fact",
53
- tags: ["auth", "api"]
54
- })
55
-
56
- // Store a decision
57
- squish_remember({
58
- content: "Chose PostgreSQL over MongoDB for better relational data",
59
- type: "decision",
60
- tags: ["database", "architecture"]
61
- })
62
- ```
63
-
64
- ### Searching Memories
65
-
66
- **Tool:** `squish_search`
67
-
68
- Hybrid search across all memory types.
69
-
70
- ```typescript
71
- // Basic search
72
- squish_search({ query: "authentication patterns", limit: 5 })
73
-
74
- // Search with project filter
75
- squish_search({ query: "database schema", project: "/path/to/project", limit: 10 })
76
-
77
- // Search specific memory type
78
- squish_search({ query: "user preferences", type: "preference" })
79
- ```
80
-
81
- ### Retrieving Memories
82
-
83
- **Tool:** `squish_recall`
84
-
85
- Retrieve a specific memory by ID.
86
-
87
- ```typescript
88
- squish_recall({ memoryId: "uuid-here" })
89
- ```
90
-
91
- ### Deleting Memories
92
-
93
- **Tool:** `squish_forget`
94
-
95
- Delete a memory by ID.
96
-
97
- ```typescript
98
- squish_forget({ memoryId: "uuid-here" })
99
- ```
100
-
101
- ### Updating Memories
102
-
103
- **Tool:** `squish_update`
104
-
105
- Update existing memory content, tags, or type.
106
-
107
- ```typescript
108
- squish_update({
109
- memoryId: "uuid-here",
110
- content: "Updated content",
111
- tags: ["new", "tags"],
112
- type: "fact"
113
- })
114
- ```
115
-
116
- ### Graph Associations
117
-
118
- **Tool:** `squish_associate`
119
-
120
- Link related memories together.
121
-
122
- ```typescript
123
- squish_associate({
124
- fromMemoryId: "uuid-1",
125
- toMemoryId: "uuid-2",
126
- type: "relates_to",
127
- weight: 0.8
128
- })
129
- ```
130
-
131
- **Tool:** `squish_related`
132
-
133
- Find related memories via graph traversal.
134
-
135
- ```typescript
136
- squish_related({
137
- memoryId: "uuid-here",
138
- depth: 2,
139
- minWeight: 0.3
140
- })
141
- ```
142
-
143
- ### Context & Observations
144
-
145
- **Tool:** `squish_context`
146
-
147
- Get project context with relevant memories.
148
-
149
- ```typescript
150
- squish_context({ project: "/path/to/project", limit: 10 })
151
- ```
152
-
153
- **Tool:** `squish_observe`
154
-
155
- Record observations about your work.
156
-
157
- ```typescript
158
- squish_observe({
159
- type: "tool_use",
160
- action: "Created new API endpoint",
161
- summary: "Implemented POST /users endpoint",
162
- target: "api/users.ts"
163
- })
164
-
165
- squish_observe({
166
- type: "error",
167
- action: "Database connection failed",
168
- summary: "PostgreSQL timeout after 30s",
169
- target: "db/index.ts"
170
- })
171
- ```
172
-
173
- ### QMD Search
174
-
175
- **Tool:** `squish_qmd_search`
176
-
177
- Search local markdown files using QMD.
178
-
179
- ```typescript
180
- squish_qmd_search({ query: "authentication", limit: 10 })
181
- squish_qmd_search({ query: "react hooks", collection: "docs" })
182
- ```
183
-
184
- ### Utilities
185
-
186
- **Tool:** `squish_embed`
187
-
188
- Generate embeddings for text.
189
-
190
- ```typescript
191
- squish_embed({ text: "Text to embed" })
192
- ```
193
-
194
- **Tool:** `squish_health`
195
-
196
- Check system health.
197
-
198
- ```typescript
199
- squish_health({})
200
- ```
201
-
202
- **Tool:** `squish_stats`
203
-
204
- Get memory statistics.
205
-
206
- ```typescript
207
- squish_stats({ project: "/path/to/project" })
208
- ```
209
-
210
- **Tool:** `squish_projects`
211
-
212
- List all projects.
213
-
214
- ```typescript
215
- squish_projects({})
216
- ```
217
-
218
- ## CLI Reference
219
-
220
- ### Interactive Mode (Default)
221
-
222
- ```bash
223
- squish
224
- ```
225
-
226
- Shows menu:
227
- ```
228
- [1] Start MCP Server (for Claude Code, etc.)
229
- [2] Start Web UI Only
230
- [3] Check Health Status
231
- [4] View Memory Stats
232
- [5] Open Installer Wizard
233
- [6] Show Help
234
- [0] Exit
235
- ```
236
-
237
- ### Server Commands
238
-
239
- ```bash
240
- # Start MCP server (also starts Web UI)
241
- squish run mcp
242
-
243
- # Start Web UI only
244
- squish run web
245
- ```
246
-
247
- ### CLI Commands (for agents and scripting)
248
-
249
- ```bash
250
- # Store a memory
251
- squish remember "User prefers TypeScript" --type preference
252
-
253
- # Search memories
254
- squish search "database schema" --limit 10
255
-
256
- # Get a memory by ID
257
- squish recall <uuid>
258
-
259
- # Check health
260
- squish health
261
-
262
- # View statistics
263
- squish stats
264
-
265
- # Manage core memory
266
- squish core_memory view
267
- squish core_memory edit persona --content "I am a helpful coding assistant"
268
-
269
- # Set importance
270
- squish set-importance <memory-id> --importance 80
271
-
272
- # Pin/unpin memory
273
- squish pin <memory-id>
274
- squish unpin <memory-id>
275
-
276
- # Consolidate old memories
277
- squish consolidate
278
- ```
279
-
280
- ## Best Practices
281
-
282
- 1. **Store proactively**: Don't wait until end of session
283
- 2. **Be specific**: Include context, timestamps, rationale
284
- 3. **Use appropriate types**: Choose correct memory type and sector
285
- 4. **Use associations**: Link related memories for better retrieval
286
- 5. **Record observations**: Use `squish_observe` for tool usage patterns
287
- 6. **Set importance**: Mark critical memories with high importance
288
- 7. **Use namespaces**: Organize memories hierarchically for large projects
289
-
290
- ## Memory Types
291
-
292
- - **observation**: Facts observed, patterns noticed, tool usage
293
- - **fact**: Technical facts, specifications
294
- - **decision**: Decisions made with rationale
295
- - **context**: Project/domain context
296
- - **preference**: User preferences
297
-
298
- ## When to Use Each Tool
299
-
300
- | Task | Use |
301
- |------|-----|
302
- | Remember something important | `squish_remember` |
303
- | Find relevant past info | `squish_search` |
304
- | Get specific memory | `squish_recall` |
305
- | Delete incorrect memory | `squish_forget` |
306
- | Update stored info | `squish_update` |
307
- | Link related memories | `squish_associate` |
308
- | Find connected info | `squish_related` |
309
- | Get project overview | `squish_context` |
310
- | Record work observations | `squish_observe` |
311
- | Search local docs | `squish_qmd_search` |
312
- | Check system status | `squish_health` |
313
- | View memory stats | `squish_stats` |
314
- | Manage core memory | `squish core_memory` |
315
- | Set importance | `squish set-importance` |
316
- | Pin/unpin memory | `squish pin/unpin` |
317
- | Consolidate old memories | `squish consolidate` |
318
-
319
- ## v1.0.1 Features
320
-
321
- **New in v1.0.1:**
322
- - Interactive wizard/menu as default (`squish`)
323
- - `squish run mcp` - Start MCP server
324
- - `squish run web` - Start Web UI only
325
- - Namespace support for hierarchical memory organization
326
- - Maintenance job scheduling system
327
- - Improved migration system for zero-downtime upgrades
328
- - Token estimation for memory content
329
-
330
- **All tools use consistent input schema patterns.**
331
-
332
- Remember: Squish is your persistent memory. Use it actively to maintain continuity across sessions and provide better assistance.
@@ -1,240 +0,0 @@
1
- ---
2
- name: squish-cli
3
- description: Squish CLI commands for OpenClaw and other CLI-based agents. Use for bash execution, scripting, and automation.
4
- version: 1.0.2
5
- author: michielhdoteth
6
- tags: [cli, memory, persistence, command-line, openclaw, bash, automation]
7
- emoji: terminal
8
- ---
9
-
10
- # Squish CLI Commands
11
-
12
- Use these CLI commands when MCP is not available or when working with OpenClaw, CLI-based agents, or bash scripting.
13
-
14
- ## Install
15
-
16
- ```bash
17
- npm install -g squish-memory
18
- # or
19
- bun add -g squish-memory
20
- ```
21
-
22
- ## Overview
23
-
24
- Squish v1.0.1 introduces a new interaction model:
25
- - **Default (`squish`)**: Interactive wizard/menu
26
- - **Server modes**: `squish run mcp` and `squish run web`
27
- - **CLI commands**: For agents and scripting (unchanged)
28
-
29
- ## Commands
30
-
31
- ### squish remember
32
-
33
- Store a memory.
34
-
35
- ```bash
36
- squish remember "User prefers TypeScript" --type preference
37
- squish remember "API uses JWT tokens" --type fact --tags auth,api
38
- squish remember "Chose PostgreSQL" --type decision --project /path/to/project
39
- ```
40
-
41
- Options:
42
- - `-t, --type <type>` - Memory type: observation, fact, decision, context, preference (default: observation)
43
- - `-T, --tags <tags>` - Comma-separated tags
44
- - `-p, --project <project>` - Project path (default: current directory)
45
-
46
- ### squish search
47
-
48
- Search memories.
49
-
50
- ```bash
51
- squish search "authentication patterns"
52
- squish search "database schema" --limit 10
53
- squish search "user preferences" --type preference
54
- squish search "" --project /path/to/project # List recent
55
- ```
56
-
57
- Options:
58
- - `-t, --type <type>` - Filter by memory type
59
- - `-l, --limit <number>` - Max results (default: 10)
60
- - `-p, --project <project>` - Project path
61
-
62
- ### squish recall
63
-
64
- Retrieve a memory by ID.
65
-
66
- ```bash
67
- squish recall <memory-uuid>
68
- ```
69
-
70
- ### squish core_memory
71
-
72
- Manage core memory (always-visible context).
73
-
74
- ```bash
75
- # View all sections
76
- squish core_memory view
77
-
78
- # Edit a section
79
- squish core_memory edit persona --content "I am a helpful coding assistant"
80
- squish core_memory edit user_info --content "User likes TypeScript"
81
- squish core_memory edit project_context --content "Stack: React, Node.js, PostgreSQL"
82
- squish core_memory edit working_notes --content "TODO: Implement auth"
83
-
84
- # Append to a section
85
- squish core_memory append user_info --text "Also prefers dark mode"
86
- ```
87
-
88
- Options:
89
- - `-s, --section <section>` - Section: persona, user_info, project_context, working_notes
90
- - `-c, --content <content>` - New content (for edit)
91
- - `-t, --text <text>` - Text to append (for append)
92
- - `-p, --project <project>` - Project path
93
-
94
- ### squish set-importance
95
-
96
- Set importance score (0-100).
97
-
98
- ```bash
99
- squish set-importance <memory-id> --importance 80
100
- ```
101
-
102
- ### squish pin / squish unpin
103
-
104
- Pin/unpin memory to prevent pruning.
105
-
106
- ```bash
107
- squish pin <memory-id>
108
- squish unpin <memory-id>
109
- ```
110
-
111
- ### squish consolidate
112
-
113
- Trigger manual memory consolidation.
114
-
115
- ```bash
116
- squish consolidate
117
- squish consolidate --project-id <project-id>
118
- squish consolidate --min-age 30 --threshold 0.8
119
- ```
120
-
121
- Options:
122
- - `-p, --project-id <id>` - Project ID (default: current directory)
123
- - `-a, --min-age <number>` - Minimum age in days (default: 90)
124
- - `-i, --max-importance <number>` - Max importance to consolidate (default: 30)
125
- - `-t, --threshold <number>` - Similarity threshold 0-1 (default: 0.7)
126
- - `-l, --limit <number>` - Max memories to process (default: 100)
127
-
128
- ### squish consolidation-stats
129
-
130
- Get consolidation statistics.
131
-
132
- ```bash
133
- squish consolidation-stats
134
- squish consolidation-stats --project-id <project-id>
135
- ```
136
-
137
- ### squish health
138
-
139
- Check service health.
140
-
141
- ```bash
142
- squish health
143
- squish health --json
144
- ```
145
-
146
- ### squish stats
147
-
148
- Get memory statistics.
149
-
150
- ```bash
151
- squish stats
152
- squish stats --project /path/to/project
153
- ```
154
-
155
- ### squish
156
-
157
- Interactive wizard/menu (default when no args provided).
158
-
159
- ```bash
160
- squish
161
- ```
162
-
163
- Shows interactive menu:
164
- ```
165
- [1] Start MCP Server (for Claude Code, etc.)
166
- [2] Start Web UI Only
167
- [3] Check Health Status
168
- [4] View Memory Stats
169
- [5] Open Installer Wizard
170
- [6] Show Help
171
- [0] Exit
172
- ```
173
-
174
- ### squish run mcp
175
-
176
- Start MCP server (also starts Web UI):
177
-
178
- ```bash
179
- squish run mcp
180
- ```
181
-
182
- ### squish run web
183
-
184
- Start Web UI only:
185
-
186
- ```bash
187
- squish run web
188
- ```
189
-
190
- ## Quick Reference
191
-
192
- | Command | Purpose | Example |
193
- |---------|---------|---------|
194
- | `squish` | Interactive wizard/menu | `squish` |
195
- | `squish run mcp` | Start MCP server | `squish run mcp` |
196
- | `squish run web` | Start Web UI only | `squish run web` |
197
- | `squish remember` | Store memory | `squish remember "text"` |
198
- | `squish search` | Find memories | `squish search "query"` |
199
- | `squish recall` | Get by ID | `squish recall <id>` |
200
- | `squish core_memory` | Manage context | `squish core_memory view` |
201
- | `squish set-importance` | Set score | `squish set-importance <id> 80` |
202
- | `squish pin/unpin` | Prevent pruning | `squish pin <id>` |
203
- | `squish consolidate` | Summarize old | `squish consolidate` |
204
- | `squish health` | Check status | `squish health` |
205
- | `squish stats` | View stats | `squish stats` |
206
-
207
- ## Output Format
208
-
209
- All commands output JSON by default:
210
-
211
- ```json
212
- {
213
- "ok": true,
214
- "id": "memory-uuid",
215
- "content": "...",
216
- "type": "observation"
217
- }
218
- ```
219
-
220
- Use `--json` flag where available for JSON output.
221
-
222
- ## Environment
223
-
224
- ```bash
225
- export SQUISH_MODE=local # or team
226
- export SQUISH_DATA_DIR=~/.squish
227
- export SQUISH_EMBEDDINGS_PROVIDER=local # or openai
228
- ```
229
-
230
- ## Migration from v0.9.x
231
-
232
- **Breaking Changes:**
233
- - `squish install` removed (replaced by interactive wizard option 5)
234
- - `squish` now shows interactive menu (was MCP server + Web UI)
235
- - Added `squish run mcp` and `squish run web` subcommands
236
-
237
- **What stays the same:**
238
- - All CLI command syntax and options
239
- - Environment variables
240
- - Configuration files