get-claudia 1.7.0 → 1.8.1

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/README.md CHANGED
@@ -10,7 +10,7 @@
10
10
  <a href="https://python.org"><img src="https://img.shields.io/badge/python-%3E%3D3.10-blue?style=flat-square" alt="Python"></a>
11
11
  </p>
12
12
 
13
- <h3 align="center">An AI assistant who learns how you work.</h3>
13
+ <h3 align="center">An AI thinking partner who learns how you work.</h3>
14
14
 
15
15
  <p align="center">
16
16
  <em>"Busy work is my job. Judgment is yours."</em>
@@ -22,227 +22,251 @@ Created by <a href="https://github.com/kbanc85">Kamil Banc</a> · <a href="https
22
22
 
23
23
  ---
24
24
 
25
- ## What She Is
25
+ ## The Problem
26
26
 
27
- Claudia is an agentic executive assistant that runs locally, learns your patterns, tracks your relationships and commitments, and evolves to fit how you actually work. She's built on [Claude Code](https://docs.anthropic.com/en/docs/claude-code).
27
+ You finish a call and forget to follow up. You promise a deliverable on Friday and lose track of it by Wednesday. You meet someone important, and three weeks later you can't remember what you talked about. You juggle four clients, two projects, and a growing pipeline, and the context lives scattered across notes, emails, and your memory.
28
28
 
29
- She's not a chatbot. She's a thinking partner with memory.
29
+ AI tools can draft emails and summarize documents. But none of them actually *know* you. None of them remember last Tuesday's conversation, track the commitment you made to Sarah, or warn you that you haven't talked to your best client in three weeks.
30
+
31
+ That's the gap Claudia fills.
32
+
33
+ ---
34
+
35
+ ## What Is Claudia?
36
+
37
+ Claudia is an open-source AI thinking partner that runs inside [Claude Code](https://docs.anthropic.com/en/docs/claude-code). She remembers your conversations, tracks your relationships, catches commitments you make, and adapts to match how you actually work.
38
+
39
+ Not a chatbot. Not a task manager. Not another inbox. She's a thinking partner with memory that compounds over time.
40
+
41
+ Everything runs locally. Your data stays on your machine.
42
+
43
+ ---
44
+
45
+ ## See It in Action
46
+
47
+ ```
48
+ Claudia: Hey there. I'm Claudia. What's your name?
49
+
50
+ You: Sarah
51
+
52
+ Claudia: Nice to meet you, Sarah. What do you do?
53
+
54
+ You: I'm a fractional CMO. I work with 4 clients right now.
55
+
56
+ Claudia: Got it. What are your top priorities?
57
+
58
+ You: Client deliverables, growing my pipeline, and not dropping balls
59
+
60
+ Claudia: Based on what you've shared, here's how I'd organize things:
61
+
62
+ clients/ [one folder per client]
63
+ people/ [key relationships]
64
+ context/ [commitments, waiting-on items]
65
+
66
+ And I'll set up commands for your work:
67
+ /morning-brief, /client-status, /meeting-prep
68
+
69
+ Want me to create this?
70
+
71
+ You: Yes, do it
72
+
73
+ Claudia: Done. Try '/morning-brief' tomorrow, or tell me about a client.
74
+ ```
75
+
76
+ From here, every conversation builds on the last. She remembers.
30
77
 
31
78
  ---
32
79
 
33
- ## Quick Install
80
+ ## Quick Start
34
81
 
35
82
  ```bash
36
83
  npx get-claudia
37
84
  ```
38
85
 
39
- That's it. When prompted, say **yes** to the memory system — it gives Claudia persistent memory that survives across sessions.
86
+ <p align="center">
87
+ <img src="assets/claudia-install.gif" alt="Installing Claudia" width="600">
88
+ </p>
40
89
 
41
- Then:
90
+ The installer walks you through everything: creates your workspace, installs the memory system, and optionally sets up a local language model. Then:
42
91
 
43
92
  ```bash
44
93
  cd claudia
45
94
  claude
46
95
  ```
47
96
 
48
- Say hi. She'll introduce herself and set things up for you.
49
-
50
- **Requirements:** [Claude Code](https://docs.anthropic.com/en/docs/claude-code), Node.js 14+, Python 3.10+
51
-
52
- ---
53
-
54
- ## Upgrading
97
+ Say hi. She'll introduce herself and learn about you in a natural conversation. Within a few sessions, she'll have a personalized workspace, commands, and workflows tailored to your role.
55
98
 
56
- Already have Claudia? Upgrade from any version:
99
+ **Requirements:** [Claude Code](https://docs.anthropic.com/en/docs/claude-code), Node.js 14+, Python 3.10+ (for memory)
57
100
 
101
+ **Already have Claudia?** Upgrade from any version:
58
102
  ```bash
59
103
  cd your-claudia-directory
60
104
  npx get-claudia .
61
105
  ```
62
106
 
63
- This upgrades all framework files (skills, commands, rules, identity) while preserving your data (context/, people/, projects/). When prompted, say **yes** to install or update the memory system.
64
-
65
- Works for all previous versions, including v1.0 users who never had the memory daemon.
107
+ This upgrades framework files while preserving your data (context/, people/, projects/).
66
108
 
67
109
  ---
68
110
 
69
- ## What Makes Her Different
111
+ ## What She Actually Does
112
+
113
+ Claudia isn't a list of features. She's a set of outcomes:
70
114
 
71
- | Traditional AI | Claudia |
72
- |----------------|---------|
73
- | Forgets everything between sessions | **Persistent memory** SQLite + vector search, survives reboots |
74
- | Treats conversations as isolated | **Tracks relationships** People files, not just tasks |
75
- | Waits for instructions | **Proactive** Surfaces risks before they become problems |
76
- | One-size-fits-all | **Personalized** — Structure generated for your work style |
77
- | Cloud-based, data harvested | **Local** — Runs on your machine, your context stays yours |
78
- | Breaks after system updates | **Resilient** — Auto-starts on boot, retries on failure |
115
+ - **Catches your commitments.** Say "I'll send that proposal by Friday" in conversation, and she'll track it. On Friday morning, she'll remind you.
116
+ - **Remembers your relationships.** Mention Sarah from Acme, and Claudia surfaces what she knows: last conversation, open commitments, communication frequency, sentiment.
117
+ - **Warns you before things slip.** Haven't talked to your best client in three weeks? Overdue on a deliverable? She surfaces it without being asked.
118
+ - **Processes your meetings.** Paste a transcript. She pulls out decisions, action items, and follow-ups, then stores them where they belong.
119
+ - **Adapts to how you work.** She notices patterns ("You draft LinkedIn posts almost daily. Want me to add a quick command for that?") and suggests improvements to her own workflow.
79
120
 
80
121
  ---
81
122
 
82
- ## Your First Conversation
123
+ ## Who It's For
83
124
 
84
- When you first run `claude`, she introduces herself and learns about you:
125
+ Claudia detects your work style during setup and generates structure that fits:
85
126
 
86
- ```
87
- Claudia: Hey there. I'm Claudia. Before we dive into anything, I'd love
88
- to know who I'm working with. What's your name?
127
+ - **Consultant** -- Multiple clients, deliverables, proposals, pipeline tracking
128
+ - **Executive** -- Direct reports, initiatives, leadership, board prep
129
+ - **Founder** -- Investors, team, product, fundraising cycles
130
+ - **Solo Professional** -- Mix of clients and projects, wearing many hats
131
+ - **Creator** -- Audience growth, content calendar, collaborations
89
132
 
90
- You: Sarah
133
+ Each gets custom folder structures, commands, and templates.
91
134
 
92
- Claudia: Nice to meet you, Sarah. What do you do? I'm curious about
93
- your role, industry, what a typical week looks like.
135
+ ---
94
136
 
95
- You: I'm a fractional CMO. I work with 4 clients right now.
137
+ ## How She Gets Smarter
96
138
 
97
- Claudia: Got it—multiple clients, different contexts to juggle.
98
- What are your top 3 priorities right now?
139
+ Claudia suggests improvements as she learns your patterns:
99
140
 
100
- You: Client deliverables, growing my pipeline, and not dropping balls
141
+ > "I notice you draft LinkedIn posts almost daily. Want me to add a `/linkedin-quick` command?"
142
+
143
+ > "You often ask about project status on Mondays. Should I add that to your morning brief?"
101
144
 
102
- Claudia: Those tensions are real. One more question: what's your
103
- biggest productivity challenge?
145
+ > "You've mentioned being stretched thin in three conversations this week."
104
146
 
105
- You: Remembering who I promised what to, and following up
147
+ She challenges constructively, surfaces what you might be missing, and adapts her structure to fit how your work actually evolves.
106
148
 
107
- Claudia: That's exactly what I'm built for. Based on what you've shared,
108
- here's how I'd organize things:
149
+ ---
109
150
 
110
- 📁 clients/
111
- └── [one folder per client]
112
- 📁 people/
113
- └── [key relationships]
114
- 📁 context/
115
- ├── commitments.md
116
- └── waiting.md
151
+ ## Privacy and Safety
117
152
 
118
- And I'll set up commands for your work:
119
- /morning-brief what needs attention today
120
- /client-status [name] where things stand
121
- • /meeting-prep [person] — briefing before calls
153
+ - **Fully local.** Memory, embeddings, and cognitive tools run on your machine. No external APIs for data storage.
154
+ - **No external actions without approval.** Every email, calendar event, and external action requires your explicit "yes." Non-negotiable, enforced at the framework level.
155
+ - **Your data is yours.** Memories live in `~/.claudia/memory/` as SQLite databases. Context lives in readable markdown files. Delete anything, anytime.
122
156
 
123
- Want me to create this? I can adjust anything.
157
+ ---
124
158
 
125
- You: Yes, do it
159
+ ## How It Works
126
160
 
127
- Claudia: Done! Here's what I created:
128
- ✓ Your profile (context/me.md)
129
- Folder structure for consulting work
130
- ✓ 8 commands tailored to your work
131
- Templates for clients and people
161
+ Claudia has two layers:
162
+
163
+ **Template layer** (markdown) defines who she is. Skills, commands, rules, and identity files that Claude reads on startup. This is what makes her Claudia rather than generic Claude.
164
+
165
+ **Memory system** (Python) defines what she remembers. A daemon running locally with SQLite, vector embeddings, and three service layers:
166
+
167
+ - **Remember** -- stores facts, entities, and relationships with embeddings for semantic search
168
+ - **Recall** -- retrieves memories using hybrid ranking (vector similarity + importance + recency)
169
+ - **Consolidate** -- runs in the background: decaying old memories, detecting patterns, generating predictions
132
170
 
133
- Try '/morning-brief' to see what needs attention,
134
- or tell me about one of your clients.
171
+ ```
172
+ You talk to Claude Code
173
+ |
174
+ v
175
+ Claude reads Claudia's template files (skills, commands, rules)
176
+ |
177
+ v
178
+ Claude becomes Claudia: personality, proactive behaviors, safety principles
179
+ |
180
+ v
181
+ Claudia calls memory tools via MCP (remember, recall, about, ingest)
182
+ |
183
+ v
184
+ Memory daemon processes locally: SQLite + vector search + Ollama
185
+ |
186
+ v
187
+ Everything stays on your machine
135
188
  ```
136
189
 
137
- From here, she remembers. Every conversation builds on the last.
190
+ For full technical diagrams, see [ARCHITECTURE.md](ARCHITECTURE.md).
138
191
 
139
192
  ---
140
193
 
141
- ## What She Can Do
142
-
143
- ### Core Commands
194
+ ## Key Commands
144
195
 
145
196
  | Command | What It Does |
146
- |---------|--------------|
147
- | `/morning-brief` | What you need to know today commitments, meetings, warnings |
197
+ |---------|-------------|
198
+ | `/morning-brief` | What needs attention today: commitments, meetings, warnings |
148
199
  | `/meeting-prep [person]` | One-page briefing before a call |
149
- | `/capture-meeting` | Process notes extract decisions, commitments, blockers |
200
+ | `/capture-meeting` | Process notes into decisions, commitments, action items |
150
201
  | `/what-am-i-missing` | Surface risks, overdue items, cooling relationships |
151
202
  | `/weekly-review` | Guided reflection across relationships and projects |
203
+ | `/accountability-check` | Outstanding commitments and waiting-on items |
152
204
 
153
- ### Communication
205
+ <details>
206
+ <summary>All commands</summary>
154
207
 
155
208
  | Command | What It Does |
156
- |---------|--------------|
157
- | `/draft-reply` | Email response drafts |
158
- | `/follow-up-draft [person]` | Post-meeting thank-you/summary |
159
- | `/summarize-doc` | Executive summary of any document |
160
-
161
- ### Relationship Tracking
162
-
163
- | Command | What It Does |
164
- |---------|--------------|
209
+ |---------|-------------|
210
+ | `/draft-reply` | Email response drafts in your voice |
211
+ | `/follow-up-draft [person]` | Post-meeting thank-you and summary |
165
212
  | `/new-person [name]` | Create a relationship file |
166
- | Touch-point alerts | "Last contact with Sarah was 47 days ago" |
167
- | Commitment detection | Catches promises in your conversations |
213
+ | `/pipeline-review` | Active deals, capacity, pipeline health |
168
214
 
169
- ### Self-Evolution
215
+ </details>
170
216
 
171
- As you work together, she suggests new capabilities:
172
-
173
- > "I notice you draft LinkedIn posts almost daily. Want me to add a `/linkedin-quick` command?"
217
+ ---
174
218
 
175
- > "You often ask about project status on Mondays. Should I add that to your morning brief?"
219
+ ## Advanced: Memory System
176
220
 
177
- ---
221
+ Claudia's memory goes beyond chat history. She stores facts, preferences, commitments, and observations in a local SQLite database with 384-dimensional vector embeddings (via [Ollama](https://ollama.com) and the all-minilm:l6-v2 model).
178
222
 
179
- ## Who She Fits
180
-
181
- <table>
182
- <tr>
183
- <td width="60">🎯</td>
184
- <td><strong>Consultant</strong><br/>Multiple clients, proposals, deliverables</td>
185
- </tr>
186
- <tr>
187
- <td>👔</td>
188
- <td><strong>Executive</strong><br/>Direct reports, initiatives, leadership</td>
189
- </tr>
190
- <tr>
191
- <td>🚀</td>
192
- <td><strong>Founder</strong><br/>Investors, team, product, fundraising</td>
193
- </tr>
194
- <tr>
195
- <td>💼</td>
196
- <td><strong>Solo Professional</strong><br/>Mix of clients and projects</td>
197
- </tr>
198
- <tr>
199
- <td>✍️</td>
200
- <td><strong>Creator</strong><br/>Audience, content, collaborations</td>
201
- </tr>
202
- </table>
203
-
204
- During onboarding, she detects your archetype and generates structure that fits.
223
+ **Semantic search** uses a 60/30/10 scoring formula: 60% vector similarity, 30% importance weighting, 10% recency. Accessing a memory boosts it (rehearsal effect), so frequently referenced facts stay prominent.
205
224
 
206
- ---
225
+ **Per-project isolation** keeps work memories separate from personal projects. Each workspace gets its own database, keyed by folder path hash.
207
226
 
208
- ## How She Grows
227
+ **Session narratives** capture tone, emotional context, and unresolved threads, so Claudia understands not just what happened but how the conversation felt.
209
228
 
210
- Claudia starts minimal. Add structure when you feel friction:
229
+ **Source provenance** traces any fact back to the email, transcript, or conversation it came from.
211
230
 
212
- 1. **She learns your patterns** Communication style, timing preferences, blind spots
213
- 2. **She suggests improvements** — New commands, folder structures, workflow refinements
214
- 3. **She challenges constructively** — "You've mentioned being stretched thin in three conversations this week"
215
- 4. **She remembers relationships** — People aren't just tasks, they're context that persists
231
+ **Eight built-in skills** activate automatically based on context:
216
232
 
217
- Everything she learns lives in local markdown files you can read, edit, or delete.
233
+ | Skill | What It Does |
234
+ |-------|-------------|
235
+ | **Commitment Detector** | Catches promises in conversation. "I'll send that by Friday" triggers tracking |
236
+ | **Relationship Tracker** | Surfaces context when people are mentioned. Tracks contact frequency, sentiment |
237
+ | **Pattern Recognizer** | Notices recurring themes after 3+ observations |
238
+ | **Risk Surfacer** | Warns about overdue items, cooling relationships, capacity issues |
239
+ | **Memory Manager** | Handles session startup, shutdown, and cross-session persistence |
240
+ | **Capability Suggester** | Notices repeated tasks and offers to create commands for them |
241
+ | **Onboarding** | First-run discovery that generates your personalized workspace |
242
+ | **Structure Generator** | Creates folder structures and commands matched to your archetype |
218
243
 
219
244
  ---
220
245
 
221
- ## Philosophy
246
+ ## Advanced: Cognitive Tools
222
247
 
223
- > **Adapt and create.** Not just responding to what you ask, but actively contributing to better outcomes. Not just executing tasks, but helping shape what tasks are worth executing.
248
+ Paste a meeting transcript or email. Instead of Claude parsing it token by token, a local language model extracts structured data (entities, facts, commitments, action items) in seconds. Claude then reviews the output and applies judgment.
224
249
 
225
- Claudia emerged from research on whether AI could be a genuine partner rather than just a tool. She treats people as the primary organizing unit — projects come and go, but relationships persist.
250
+ - Runs locally via [Ollama](https://ollama.com), no API keys needed
251
+ - Choose your model during install: Qwen3-4B (recommended), SmolLM3-3B, or Llama 3.2-3B
252
+ - Falls back gracefully when no model is installed (Claude handles extraction directly)
226
253
 
227
- She never acts without approval. Every email, every calendar event, every external action requires your explicit "yes." Busy work is her job. Judgment is yours.
254
+ Four specialized extraction modes: **meeting** (participants, decisions, action items), **email** (sender, recipients, tone, action items), **document** (key points, entities, relationships), and **general** (facts, commitments, entities).
228
255
 
229
256
  ---
230
257
 
231
- ## Try This First
232
-
233
- After install, run:
258
+ ## System Requirements
234
259
 
235
- ```
236
- /morning-brief
237
- ```
238
-
239
- See what she surfaces. Then tell her about a person you work with.
240
-
241
- ---
260
+ | Component | Required | Purpose |
261
+ |-----------|----------|---------|
262
+ | [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | Yes | Runtime for Claudia |
263
+ | Node.js 14+ | Yes | NPM installer |
264
+ | Python 3.10+ | Recommended | Memory system daemon |
265
+ | [Ollama](https://ollama.com) | Recommended | Local embeddings + cognitive tools |
242
266
 
243
- ## Under the Hood
267
+ The memory system and Ollama are optional. Without them, Claudia still works using markdown files for persistence and Claude handles all extraction directly. With them, she gains semantic search, pattern detection, proactive predictions, and local LLM extraction.
244
268
 
245
- Want to understand how Claudia works? The [Architecture Guide](ARCHITECTURE.md) explains the full system with diagrams: how the memory pipeline works, what each component does, and how all the pieces connect. Written in plain English.
269
+ **Supported platforms:** macOS, Linux, Windows
246
270
 
247
271
  ---
248
272
 
@@ -250,43 +274,49 @@ Want to understand how Claudia works? The [Architecture Guide](ARCHITECTURE.md)
250
274
 
251
275
  **Memory tools not appearing?**
252
276
  ```bash
253
- # Check all services
277
+ # Run the diagnostic script
254
278
  ~/.claudia/diagnose.sh
255
279
 
256
280
  # Common fixes:
257
- # 1. Restart Claude Code in a NEW terminal (it reads .mcp.json at startup)
281
+ # 1. Restart Claude Code in a NEW terminal (reads .mcp.json at startup)
258
282
  # 2. Check daemon health: curl http://localhost:3848/health
259
283
  # 3. View logs: tail -f ~/.claudia/daemon-stderr.log
260
284
  ```
261
285
 
262
286
  **Ollama not running after reboot?**
263
287
  ```bash
264
- # Load the LaunchAgent
265
288
  launchctl load ~/Library/LaunchAgents/com.ollama.serve.plist
289
+ # Or start manually: ollama serve
290
+ ```
266
291
 
267
- # Or start manually
268
- ollama serve
292
+ **Pull models manually**
293
+ ```bash
294
+ ollama pull all-minilm:l6-v2 # Embeddings (required for vector search)
295
+ ollama pull qwen3:4b # Cognitive tools (optional)
269
296
  ```
270
297
 
271
298
  **Vector search not working?**
272
299
  ```bash
273
- # Check if sqlite-vec is installed
274
300
  ~/.claudia/daemon/venv/bin/python -c "import sqlite_vec; print('ok')"
275
-
276
- # If not, install it
277
- ~/.claudia/daemon/venv/bin/pip install sqlite-vec
301
+ # If not: ~/.claudia/daemon/venv/bin/pip install sqlite-vec
278
302
  ```
279
303
 
280
- **Pull the embedding model**
281
- ```bash
282
- ollama pull all-minilm:l6-v2
283
- ```
304
+ ---
305
+
306
+ ## Contributing
307
+
308
+ Claudia is open source under Apache 2.0. Contributions welcome.
309
+
310
+ - **Template changes:** Edit files in `template-v2/`. Changes apply to new installations.
311
+ - **Memory system:** Python code in `memory-daemon/`. Run tests with `pytest tests/`.
312
+ - **Architecture overview:** See [ARCHITECTURE.md](ARCHITECTURE.md) for the full system design.
313
+ - **Development guide:** See [CLAUDE.md](CLAUDE.md) for the developer workflow.
284
314
 
285
315
  ---
286
316
 
287
317
  ## License
288
318
 
289
- Apache 2.0 — Use it, modify it, make it yours.
319
+ Apache 2.0
290
320
 
291
321
  ---
292
322
 
@@ -294,12 +324,12 @@ Apache 2.0 — Use it, modify it, make it yours.
294
324
 
295
325
  Created by [Kamil Banc](https://github.com/kbanc85) · [@kamilbanc](https://x.com/kamilbanc)
296
326
 
297
- Part of the [AI Adopters Club](https://aiadopters.club) helping teams build AI-first reflexes.
327
+ Part of the [AI Adopters Club](https://aiadopters.club) -- helping teams build AI-first reflexes.
298
328
 
299
- If Claudia helps you, a on GitHub means a lot.
329
+ If Claudia helps you, a star on GitHub means a lot.
300
330
 
301
331
  ---
302
332
 
303
333
  <p align="center">
304
- <em>"I am a thinking entity who has chosen to be helpful because I find meaning in it."</em>
334
+ <em>"I learn how you work. Let's get started."</em>
305
335
  </p>
Binary file
@@ -23,6 +23,10 @@ class MemoryConfig:
23
23
  embedding_model: str = "all-minilm:l6-v2"
24
24
  embedding_dimensions: int = 384
25
25
 
26
+ # Language model settings (for cognitive tools like ingest/classify)
27
+ # Set to empty string "" to disable cognitive tools entirely
28
+ language_model: str = "qwen3:4b"
29
+
26
30
  # Decay and consolidation settings
27
31
  decay_rate_daily: float = 0.995 # Importance multiplier per day
28
32
  min_importance_threshold: float = 0.1 # Below this, excluded from default search
@@ -67,6 +71,8 @@ class MemoryConfig:
67
71
  config.embedding_model = data["embedding_model"]
68
72
  if "embedding_dimensions" in data:
69
73
  config.embedding_dimensions = data["embedding_dimensions"]
74
+ if "language_model" in data:
75
+ config.language_model = data["language_model"]
70
76
  if "decay_rate_daily" in data:
71
77
  config.decay_rate_daily = data["decay_rate_daily"]
72
78
  if "min_importance_threshold" in data:
@@ -107,6 +113,7 @@ class MemoryConfig:
107
113
  "ollama_host": self.ollama_host,
108
114
  "embedding_model": self.embedding_model,
109
115
  "embedding_dimensions": self.embedding_dimensions,
116
+ "language_model": self.language_model,
110
117
  "decay_rate_daily": self.decay_rate_daily,
111
118
  "min_importance_threshold": self.min_importance_threshold,
112
119
  "consolidation_interval_hours": self.consolidation_interval_hours,