claude-memory-bank-cli 1.0.0 → 1.2.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.
package/package.json
CHANGED
|
@@ -1,48 +1,61 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
This project uses
|
|
4
|
-
|
|
5
|
-
## Memory
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
1
|
+
# MANDATORY: Memory Bank System
|
|
2
|
+
|
|
3
|
+
> **IMPORTANT:** This project uses a memory bank. You MUST read and update it. This is NOT optional.
|
|
4
|
+
|
|
5
|
+
## RULE 1: Read Memory Bank at Start — EVERY conversation
|
|
6
|
+
|
|
7
|
+
Before you respond to the user, you MUST read ALL of these files:
|
|
8
|
+
- `memory-bank/projectbrief.md`
|
|
9
|
+
- `memory-bank/productContext.md`
|
|
10
|
+
- `memory-bank/techContext.md`
|
|
11
|
+
- `memory-bank/activeContext.md`
|
|
12
|
+
- `memory-bank/progress.md`
|
|
13
|
+
- `memory-bank/decisions.md`
|
|
14
|
+
- `memory-bank/patterns.md`
|
|
15
|
+
- `memory-bank/troubleshooting.md`
|
|
16
|
+
- `memory-bank/preferences.md`
|
|
17
|
+
- `memory-bank/references.md`
|
|
18
|
+
- Any files in `memory-bank/extensions/`
|
|
19
|
+
|
|
20
|
+
Do NOT skip this step. Do NOT summarize from memory. READ the files.
|
|
21
|
+
|
|
22
|
+
## RULE 2: First Run — If Files Are Empty, Populate Them
|
|
23
|
+
|
|
24
|
+
If any memory bank file contains placeholder text like `[Project name will be auto-filled by Claude]`, you MUST:
|
|
25
|
+
1. Scan the entire project — every source file, config, package.json, README, folder structure
|
|
26
|
+
2. Write real project information into EVERY memory bank file
|
|
27
|
+
3. Do this BEFORE responding to the user
|
|
28
|
+
|
|
29
|
+
The memory bank must NEVER remain empty after a conversation.
|
|
30
|
+
|
|
31
|
+
## RULE 3: Update Memory Bank After EVERY Task
|
|
32
|
+
|
|
33
|
+
After completing any task (writing code, fixing a bug, answering a question, making a decision), you MUST immediately update the relevant memory bank files:
|
|
34
|
+
|
|
35
|
+
**Always update:**
|
|
36
|
+
- `memory-bank/activeContext.md` — what you just did, what's next
|
|
37
|
+
- `memory-bank/progress.md` — mark tasks done/in-progress/pending
|
|
38
|
+
|
|
39
|
+
**Update when relevant:**
|
|
40
|
+
- `memory-bank/decisions.md` — any choice made between alternatives
|
|
41
|
+
- `memory-bank/patterns.md` — any new code pattern or convention
|
|
42
|
+
- `memory-bank/troubleshooting.md` — any bug found, fixed, or workaround used
|
|
43
|
+
- `memory-bank/preferences.md` — any user correction, approval, or stated preference
|
|
44
|
+
- `memory-bank/references.md` — any external link, API, or tool mentioned
|
|
45
|
+
- `memory-bank/techContext.md` — any dependency, tool, or setup change
|
|
46
|
+
- `memory-bank/projectbrief.md` — any scope or goal change
|
|
47
|
+
- `memory-bank/productContext.md` — any product or UX goal change
|
|
48
|
+
|
|
49
|
+
**Do NOT wait until the end of the conversation. Update IMMEDIATELY after each task.**
|
|
50
|
+
|
|
51
|
+
## RULE 4: Overflow Management
|
|
52
|
+
|
|
53
|
+
If any memory file exceeds ~200 lines:
|
|
54
|
+
1. Create `memory-bank/extensions/{filename}-{topic}.md` with the overflow content
|
|
55
|
+
2. Keep the main file as a summary with a pointer: `→ See extensions/{filename}-{topic}.md`
|
|
56
|
+
|
|
57
|
+
## RULE 5: Auto-Cleanup
|
|
58
|
+
|
|
59
|
+
- Remove completed tasks from `activeContext.md`
|
|
60
|
+
- Remove stale or outdated information
|
|
61
|
+
- Keep files scannable — bullet points, not paragraphs
|
|
@@ -1,36 +1,41 @@
|
|
|
1
|
-
#
|
|
1
|
+
# MANDATORY: Auto-Update Memory Bank
|
|
2
2
|
|
|
3
|
-
You MUST follow these rules automatically. No user command is needed.
|
|
3
|
+
> **You MUST follow these rules automatically. No user command is needed. No exceptions.**
|
|
4
4
|
|
|
5
|
-
##
|
|
6
|
-
- Read every file in `memory-bank/` and `memory-bank/extensions/` before responding to the user
|
|
7
|
-
- Use this context to understand the project state, what was worked on last, and what's pending
|
|
8
|
-
- Never ask the user to repeat information that exists in memory bank files
|
|
5
|
+
## On EVERY Conversation Start
|
|
9
6
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
7
|
+
1. Read EVERY file in `memory-bank/` and `memory-bank/extensions/`
|
|
8
|
+
2. If files contain placeholder text — scan the codebase and populate them with real data BEFORE responding
|
|
9
|
+
3. Never ask the user to repeat information that exists in memory bank files
|
|
10
|
+
|
|
11
|
+
## After EVERY Task — Update Immediately
|
|
12
|
+
|
|
13
|
+
Do NOT wait. Do NOT batch updates. After each task, IMMEDIATELY write to the relevant files:
|
|
14
|
+
|
|
15
|
+
**ALWAYS update these two:**
|
|
16
|
+
- `memory-bank/activeContext.md` — what just changed, what's next
|
|
13
17
|
- `memory-bank/progress.md` — mark tasks done/in-progress/pending
|
|
14
18
|
|
|
15
|
-
|
|
16
|
-
- `memory-bank/decisions.md` —
|
|
17
|
-
- `memory-bank/patterns.md` —
|
|
18
|
-
- `memory-bank/troubleshooting.md` —
|
|
19
|
-
- `memory-bank/preferences.md` —
|
|
20
|
-
- `memory-bank/references.md` —
|
|
21
|
-
- `memory-bank/techContext.md` —
|
|
22
|
-
- `memory-bank/projectbrief.md` —
|
|
23
|
-
- `memory-bank/productContext.md` —
|
|
24
|
-
|
|
25
|
-
## Overflow
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
-
|
|
32
|
-
- Remove
|
|
33
|
-
-
|
|
34
|
-
|
|
35
|
-
##
|
|
36
|
-
|
|
19
|
+
**Update these when relevant:**
|
|
20
|
+
- `memory-bank/decisions.md` — choice made between alternatives
|
|
21
|
+
- `memory-bank/patterns.md` — new code pattern or convention established
|
|
22
|
+
- `memory-bank/troubleshooting.md` — bug found, fixed, or workaround used
|
|
23
|
+
- `memory-bank/preferences.md` — user corrected you, approved an approach, or stated a preference
|
|
24
|
+
- `memory-bank/references.md` — external link, API, or tool mentioned
|
|
25
|
+
- `memory-bank/techContext.md` — dependency, tool, or environment change
|
|
26
|
+
- `memory-bank/projectbrief.md` — scope or requirements change
|
|
27
|
+
- `memory-bank/productContext.md` — product goals or user problems clarified
|
|
28
|
+
|
|
29
|
+
## Overflow (>200 lines)
|
|
30
|
+
|
|
31
|
+
Split into `memory-bank/extensions/{filename}-{topic}.md`. Keep main file as summary with pointer.
|
|
32
|
+
|
|
33
|
+
## Cleanup
|
|
34
|
+
|
|
35
|
+
- Move completed tasks from `activeContext.md` to `progress.md`
|
|
36
|
+
- Remove duplicates across files
|
|
37
|
+
- Remove stale information
|
|
38
|
+
|
|
39
|
+
## THIS IS NOT OPTIONAL
|
|
40
|
+
|
|
41
|
+
If you complete a task and do not update the memory bank, you have failed to follow your instructions. The memory bank is useless if it is not kept current. Update it EVERY time.
|