@shahmilsaari/memory-core 0.2.3 → 0.2.4

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 (3) hide show
  1. package/README.md +31 -25
  2. package/dist/cli.js +7 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -18,11 +18,10 @@ Without memory-core, every AI agent starts fresh. It doesn't know you're using C
18
18
 
19
19
  With memory-core:
20
20
 
21
- 1. You run `init` once and answer a few questions about your project
22
- 2. memory-core generates config files for every AI agent you use
23
- 3. Those agents read the files and follow your rules automatically
24
- 4. When you commit code, a hook catches violations before they land in the repo
25
- 5. Watch mode catches violations as you type, not just at commit time
21
+ 1. You run `init` once it verifies your PostgreSQL and Ollama connections, picks your model, and generates config files for every AI agent
22
+ 2. Those agents read the files and follow your rules automatically
23
+ 3. Watch mode catches violations as you type, not just at commit time
24
+ 4. When you commit, Claude Code automatically checks your code before the commit goes through
26
25
 
27
26
  ---
28
27
 
@@ -106,10 +105,10 @@ ollama serve &
106
105
 
107
106
  **Windows** — [download from ollama.com](https://ollama.com/download)
108
107
 
109
- Then pull the two models:
108
+ Pull the embedding model. The code-checking model is chosen during `init`:
110
109
  ```bash
111
- ollama pull nomic-embed-text # used for search
112
- ollama pull llama3.2 # used to check your code
110
+ ollama pull nomic-embed-text # required for search
111
+ ollama pull llama3.2 # or whichever model you plan to use
113
112
  ```
114
113
 
115
114
  ---
@@ -153,14 +152,11 @@ CREATE INDEX IF NOT EXISTS memories_scope_idx ON memories (scope);
153
152
  # 1. Go to your project
154
153
  cd my-api
155
154
 
156
- # 2. Initialize — answers a few questions, generates all config files
155
+ # 2. Initialize — verifies connections, picks your model, generates all config files
157
156
  npx @shahmilsaari/memory-core init
158
157
 
159
158
  # 3. Load 281 predefined best-practice rules
160
159
  npx @shahmilsaari/memory-core seed
161
-
162
- # 4. Install the pre-commit hook (optional but recommended)
163
- npx @shahmilsaari/memory-core hook install
164
160
  ```
165
161
 
166
162
  That's it. Every AI agent in your project now has your rules.
@@ -175,15 +171,18 @@ That's it. Every AI agent in your project now has your rules.
175
171
  npx @shahmilsaari/memory-core init
176
172
  ```
177
173
 
178
- Asks you:
179
- - Project name
180
- - Project type (Backend / Frontend / Fullstack)
181
- - Architecture (Clean Architecture, MVC, React, Vue, etc.)
182
- - Language
174
+ Walks you through:
175
+ - PostgreSQL connection URL — **tested live, retries until connected**
176
+ - Ollama URL **tested live, retries until reachable**
177
+ - Code-checking model **verified to be installed in your Ollama**
178
+ - Project name, type, architecture, language
179
+ - Whether to enable the pre-commit hook (asked during setup — no separate step needed)
183
180
  - Whether to enable caveman mode (optional token saver)
184
181
 
185
182
  Generates config files for every supported AI agent and saves your choices to `.memory-core.json`.
186
183
 
184
+ At the end, the banner shows live ✓/✗ status for PostgreSQL and Ollama so you know everything is working.
185
+
187
186
  ---
188
187
 
189
188
  ### `remember` — Save a decision
@@ -253,7 +252,9 @@ npx @shahmilsaari/memory-core seed --force # re-seed existin
253
252
  npx @shahmilsaari/memory-core hook install
254
253
  ```
255
254
 
256
- Installs a git pre-commit hook. Every time you run `git commit`, your staged files are checked against your architecture rules before the commit goes through.
255
+ Installs a git pre-commit hook in the current project. Every time you run `git commit`, your code is checked against your architecture rules before the commit goes through.
256
+
257
+ > **Note:** If you use Claude Code, the hook is offered automatically during `init` — no separate step needed.
257
258
 
258
259
  When a violation is found, the commit is blocked and you see exactly what's wrong and how to fix it:
259
260
 
@@ -396,7 +397,7 @@ Pick the one that matches how your project is structured.
396
397
  | React | Functional components, hooks, React Query, Zustand |
397
398
  | Vue 3 | Composition API, Pinia, composables |
398
399
  | Angular | Standalone components, signals, OnPush strategy |
399
- | Svelte | Svelte 5 runes, SvelteKit load functions |
400
+ | Svelte | Svelte 5 runes, SvelteKit load functions, snippets |
400
401
  | Nuxt 3 | Fullstack Vue with SSR |
401
402
  | React Native | Mobile apps |
402
403
 
@@ -421,9 +422,8 @@ Cuts AI response length by 65–75% by removing filler words. Opt in during `ini
421
422
  ```bash
422
423
  # Starting a new project
423
424
  cd my-api
424
- npx @shahmilsaari/memory-core init
425
- npx @shahmilsaari/memory-core seed
426
- npx @shahmilsaari/memory-core hook install
425
+ npx @shahmilsaari/memory-core init # verifies connections, picks model, installs hook
426
+ npx @shahmilsaari/memory-core seed # load 281 best-practice rules
427
427
 
428
428
  # Made an architectural decision? Save it.
429
429
  npx @shahmilsaari/memory-core remember "All auth goes through middleware, never in controllers" \
@@ -435,7 +435,7 @@ npx @shahmilsaari/memory-core sync
435
435
  # Not sure how something was decided? Search.
436
436
  npx @shahmilsaari/memory-core search "caching strategy"
437
437
 
438
- # Commit code → hook checks it automatically
438
+ # Commit code → Claude Code checks it automatically before committing
439
439
  git commit -m "add user endpoint"
440
440
  ```
441
441
 
@@ -449,8 +449,8 @@ memory-core creates `.memory-core.env` automatically during `init`. You can also
449
449
  |---|---|---|---|
450
450
  | `DATABASE_URL` | Yes | — | PostgreSQL connection string |
451
451
  | `OLLAMA_URL` | No | `http://localhost:11434` | Where Ollama is running |
452
- | `OLLAMA_MODEL` | No | `nomic-embed-text` | Model used for search |
453
- | `OLLAMA_CHAT_MODEL` | No | `llama3.2` | Model used for code checking |
452
+ | `OLLAMA_MODEL` | No | `nomic-embed-text` | Model used for search (embeddings) |
453
+ | `OLLAMA_CHAT_MODEL` | No | `llama3.2` | Model used for code checking — chosen during `init` |
454
454
 
455
455
  ---
456
456
 
@@ -483,6 +483,10 @@ It won't — the hook only checks source code files: `.ts .tsx .js .jsx .py .php
483
483
  | | Feature |
484
484
  |---|---|
485
485
  | ✓ | Watch mode — real-time violation alerts on save |
486
+ | ✓ | Model picker — choose your Ollama model during init |
487
+ | ✓ | Connection validation — PostgreSQL and Ollama verified during setup |
488
+ | ✓ | Svelte 5 / SvelteKit profile and 37 rules |
489
+ | ✓ | NestJS profile and 39 rules |
486
490
  | | CI/CD — fail PRs that violate your rules |
487
491
  | | Violation memory — auto-save what went wrong as a new rule |
488
492
  | | Rule analytics — see which rules get broken most |
@@ -494,3 +498,5 @@ It won't — the hook only checks source code files: `.ts .tsx .js .jsx .py .php
494
498
  ## License
495
499
 
496
500
  MIT
501
+
502
+ *Built by [Shahmil Saari](https://github.com/shahmilsaari)*
package/dist/cli.js CHANGED
@@ -1400,6 +1400,10 @@ program.command("init").description("Initialize memory-core in the current proje
1400
1400
  ]
1401
1401
  });
1402
1402
  }
1403
+ const enableHook = await confirm({
1404
+ message: "Enable pre-commit hook? (blocks commits that violate your rules)",
1405
+ default: true
1406
+ });
1403
1407
  const config2 = {
1404
1408
  projectName,
1405
1409
  projectType,
@@ -1438,6 +1442,9 @@ program.command("init").description("Initialize memory-core in the current proje
1438
1442
  );
1439
1443
  writeProjectConfig(config2);
1440
1444
  spinner.succeed(`Generated ${written.length} files`);
1445
+ if (enableHook) {
1446
+ installHook();
1447
+ }
1441
1448
  const status = await checkConnections(
1442
1449
  process.env.DATABASE_URL ?? "",
1443
1450
  process.env.OLLAMA_URL ?? "http://localhost:11434",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shahmilsaari/memory-core",
3
- "version": "0.2.3",
3
+ "version": "0.2.4",
4
4
  "description": "Universal AI memory core — generate AI context files from architecture profiles with RAG support",
5
5
  "type": "module",
6
6
  "bin": {