Skip to content

Commit 171f4a2

Browse files
Olow304Olow304
committed
updated the readme file
1 parent 53fbad9 commit 171f4a2

1 file changed

Lines changed: 56 additions & 143 deletions

File tree

‎README.md‎

Lines changed: 56 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -1,224 +1,137 @@
11
<div align="center">
22

3-
# 🧠 Claude Brain
3+
# Claude Brain
44

5-
### **Claude Code finally remembers.**
5+
### Give Claude Code photographic memory.
66

7-
*One file. Instant recall. Zero config.*
8-
9-
[![npm version](https://img.shields.io/npm/v/claude-brain.svg)](https://www.npmjs.com/package/claude-brain)
107
[![GitHub stars](https://img.shields.io/github/stars/memvid/claude-brain?style=social)](https://github.com/memvid/claude-brain)
118
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
129

13-
[Installation](#-installation) • [How it Works](#-how-it-works) • [Commands](#-commands) • [FAQ](#-faq)
14-
15-
10+
<br />
1611

1712
https://github.com/user-attachments/assets/b57cb3db-576b-4c1f-af92-95796ba3fb5b
1813

14+
<br />
1915

16+
**[Install in 30 seconds](#installation)** · [How it Works](#how-it-works) · [Commands](#commands)
2017

2118
</div>
2219

23-
---
20+
<br />
2421

2522
## The Problem
2623

2724
```
28-
You: "Hey Claude, remember when we fixed that auth bug?"
29-
25+
You: "Remember that auth bug we fixed?"
3026
Claude: "I don't have memory of previous conversations."
31-
32-
You: "We literally spent 3 hours on this yesterday"
33-
34-
Claude: "I'd be happy to help you debug it from scratch!"
27+
You: "We spent 3 hours on it yesterday"
28+
Claude: "I'd be happy to help debug from scratch!"
3529
```
3630

3731
**200K context window. Zero memory between sessions.**
3832

39-
You're paying $200/month for a goldfish with a PhD.
33+
You're paying for a goldfish with a PhD.
4034

41-
---
35+
<br />
4236

43-
## The Solution
37+
## The Fix
4438

4539
```
46-
You: "What did we decide about the auth system?"
47-
48-
Claude: "Last week we chose JWT over sessions because of your
49-
microservices architecture. I also remember we had issues with
50-
the refresh token rotation - here's what we fixed..."
40+
You: "What did we decide about auth?"
41+
Claude: "We chose JWT over sessions for your microservices.
42+
The refresh token issue - here's exactly what we fixed..."
5143
```
5244

53-
**One plugin. One file. Claude remembers everything.**
54-
55-
---
45+
One file. Claude remembers everything.
5646

57-
## 🚀 Installation
47+
<br />
5848

59-
**30 seconds. No config.**
49+
## Installation
6050

61-
1. Add the marketplace in Claude Code:
62-
```
51+
```bash
52+
# In Claude Code
6353
/plugin add marketplace memvid/claude-brain
6454
```
6555

66-
2. Go to **Plugins tab** (`/plugins`) → **Discover** → Install **mind**
56+
Then: `/plugins` → Discover → Install **mind** → Restart.
6757

68-
3. Restart Claude Code. **Done.**
58+
Done.
6959

70-
---
60+
<br />
7161

72-
## 🔮 How it Works
62+
## How it Works
7363

74-
After install, Claude stores memories in **one portable file**:
64+
After install, Claude's memory lives in one file:
7565

7666
```
77-
your-project/
78-
└── .claude/
79-
└── mind.mv2 # Claude's brain. That's it.
67+
your-project/.claude/mind.mv2
8068
```
8169

82-
### What Gets Captured
70+
That's it. No database. No cloud. No API keys.
8371

84-
| When | What |
85-
|------|------|
86-
| **Session start** | Injects relevant context from past sessions |
87-
| **While working** | Decisions, bugs found, solutions, file changes |
88-
| **Session end** | Session summary for future recall |
72+
**What gets captured:**
73+
- Session context, decisions, bugs, solutions
74+
- Auto-injected at session start
75+
- Searchable anytime
8976

90-
### Why One File?
77+
**Why one file?**
78+
- `git commit` → version control Claude's brain
79+
- `scp` → transfer anywhere
80+
- Send to teammate → instant onboarding
9181

92-
| Action | Result |
93-
|--------|--------|
94-
| `git commit` | Version control Claude's memory |
95-
| `scp file user@server:` | Transfer to any machine |
96-
| Send to teammate | Instant project onboarding |
82+
<br />
9783

98-
**No database. No background service. No API keys. No cloud.**
99-
100-
---
101-
102-
## 📦 Commands
84+
## Commands
10385

10486
```bash
105-
/mind:mind stats # memory statistics
106-
/mind:mind search "authentication" # find past context
107-
/mind:mind ask "why did we choose X?" # ask your memory
108-
/mind:mind recent # what happened lately
109-
```
110-
111-
---
112-
113-
## ⚡ Endless Mode
114-
115-
Claude hits context limits fast. Claude Mind compresses tool outputs ~20x:
116-
117-
```
118-
Before: Read (8K) + Edit (4K) + Bash (12K) = 24K tokens gone
119-
After: Read (400) + Edit (200) + Bash (600) = 1.2K tokens
87+
/mind:mind search "auth bug" # find past context
88+
/mind:mind ask "why JWT?" # query memory
89+
/mind:mind recent # latest memories
90+
/mind:mind stats # usage stats
12091
```
12192

122-
Keeps errors, structure, key functions. Drops the noise.
93+
<br />
12394

124-
Work longer without hitting limits.
125-
126-
---
127-
128-
## ❓ FAQ
95+
## FAQ
12996

13097
<details>
131-
<summary><b>How big is the .mv2 file?</b></summary>
132-
133-
An empty `.mv2` file is only **~70KB**. It includes:
134-
135-
- **Lexical index** for fast keyword search
136-
- **Vector index** for semantic search (find by meaning)
137-
- **Block-aligned storage** for O(1) random access
98+
<summary><b>How big is the file?</b></summary>
13899

139-
The file grows as you add memories (~1KB per memory). A year of daily use typically stays under 5MB.
100+
Empty: ~70KB. Grows ~1KB per memory. A year of use stays under 5MB.
140101

141102
</details>
142103

143104
<details>
144-
<summary><b>How big does the file get?</b></summary>
105+
<summary><b>Is it private?</b></summary>
145106

146-
~1KB per memory. 1000 memories ≈ 1MB. The base ~70KB is minimal overhead.
107+
100% local. Nothing leaves your machine. Ever.
147108

148109
</details>
149110

150111
<details>
151-
<summary><b>Is my data private?</b></summary>
112+
<summary><b>How fast?</b></summary>
152113

153-
**100% local.** Nothing leaves your machine. No telemetry. No cloud sync. You own your data.
154-
155-
The `.mv2` file is just a file - encrypt it, back it up, delete it, share it. Your choice.
156-
157-
</details>
158-
159-
<details>
160-
<summary><b>How fast is it?</b></summary>
161-
162-
Native Rust core via [memvid](https://github.com/memvid/memvid). Sub-millisecond operations:
163-
164-
- Search: < 1ms for 10K+ memories
165-
- Insert: < 0.5ms
166-
- Load context: < 5ms
167-
168-
</details>
169-
170-
<details>
171-
<summary><b>Can I reset Claude's memory?</b></summary>
172-
173-
```bash
174-
rm .claude/mind.mv2
175-
```
176-
177-
Or use `/mind clear` (coming soon).
114+
Sub-millisecond. Native Rust core. Searches 10K+ memories in <1ms.
178115

179116
</details>
180117

181118
<details>
182-
<summary><b>Does it work with multiple projects?</b></summary>
119+
<summary><b>Reset memory?</b></summary>
183120

184-
Yes! Each project gets its own `.claude/mind.mv2` file. Memories are project-scoped by default.
121+
`rm .claude/mind.mv2`
185122

186123
</details>
187124

188-
---
189-
190-
## 🔧 Configuration (Optional)
191-
192-
Create `.claude/mind.config.json`:
193-
194-
```json
195-
{
196-
"memoryPath": ".claude/mind.mv2",
197-
"maxContextObservations": 20,
198-
"endlessMode": true
199-
}
200-
```
201-
202-
Most users don't need to configure anything.
125+
<br />
203126

204127
---
205128

206-
## 🤝 Contributing
207-
208-
We love contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
209-
210-
**Quick wins:**
211-
- Add to [awesome-claude-skills](https://github.com/travisvn/awesome-claude-skills)
212-
- Star the repo ⭐
213-
- Share on Twitter/X with a demo
214-
215-
---
216-
217-
218129
<div align="center">
219130

220-
**MIT License** • Built on [memvid](https://github.com/memvid/memvid) — the single-file memory engine
131+
Built on **[memvid](https://github.com/memvid/memvid)** — the single-file memory engine
132+
133+
<br />
221134

222-
[Report Bug](https://github.com/memvid/claude-brain/issues) • [Request Feature](https://github.com/memvid/claude-brain/issues)
135+
**If this saved you time, [star the repo](https://github.com/memvid/claude-brain)**
223136

224137
</div>

0 commit comments

Comments
 (0)