@devflow-tools/memory-engine 0.3.2 → 0.5.0

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 (2) hide show
  1. package/README.md +41 -0
  2. package/package.json +4 -4
package/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # @devflow-tools/memory-engine
2
+
3
+ Memory engine for DevFlow — automatically extracts and manages project conventions, tech stack, and preferences.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @devflow-tools/memory-engine
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```typescript
14
+ import { MemoryEngine } from '@devflow-tools/memory-engine';
15
+
16
+ const engine = new MemoryEngine({ projectRoot: '/path/to/project' });
17
+
18
+ // Get project memory
19
+ const memory = await engine.get();
20
+
21
+ // Set a preference
22
+ await engine.set('preferred-test-framework', 'vitest');
23
+ ```
24
+
25
+ ## Features
26
+
27
+ - **Automatic extraction** — detect tech stack, conventions, and patterns
28
+ - **Layered storage** — project, user, and team memory layers
29
+ - **Candidate review** — approve/reject AI-suggested memory entries
30
+
31
+ ## API
32
+
33
+ - `MemoryEngine` — main class
34
+ - `.get()` — retrieve all memory for the project
35
+ - `.set(key, value)` — set a memory key
36
+ - `.candidates` — list pending memory candidates
37
+ - `extractCandidates(projectRoot)` — extract memory candidates from codebase
38
+
39
+ ## License
40
+
41
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devflow-tools/memory-engine",
3
- "version": "0.3.2",
3
+ "version": "0.5.0",
4
4
  "type": "module",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
@@ -17,15 +17,15 @@
17
17
  "clean": "rm -rf dist"
18
18
  },
19
19
  "dependencies": {
20
- "@devflow-tools/sdk": "^0.3.2"
20
+ "@devflow-tools/sdk": "^0.5.0"
21
21
  },
22
22
  "devDependencies": {
23
- "@devflow-tools/knowledge-engine": "^0.3.2",
23
+ "@devflow-tools/knowledge-engine": "^0.5.0",
24
24
  "typescript": "^5.5.0",
25
25
  "vitest": "^2.0.0"
26
26
  },
27
27
  "files": [
28
28
  "dist"
29
29
  ],
30
- "gitHead": "8bd4fe5d195782d3e5a5357fc9bff5998561c956"
30
+ "gitHead": "431c0f26e14d476c08d543ef5cd65367413dbc98"
31
31
  }