@onebrain-ai/cli 2.0.7 → 2.0.9

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 (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +412 -22
  3. package/dist/onebrain +7603 -7556
  4. package/package.json +7 -6
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 kengio
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,8 +1,192 @@
1
- # @onebrain-ai/cli
1
+ <p align="center">
2
+ <img src="assets/banner.png" alt="OneBrain — Your personal AI OS" width="100%" />
3
+ </p>
2
4
 
3
- The CLI binary for [OneBrain](https://github.com/kengio/onebrain) — a personal AI OS built on Obsidian with persistent memory, 24+ skills, and Claude Code integration.
5
+ <p align="center">
6
+ <a href="https://github.com/kengio/onebrain/releases"><img src="https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/kengio/onebrain/main/.claude/plugins/onebrain/.claude-plugin/plugin.json&query=%24.version&label=version&style=flat-square&color=blue" alt="Version" /></a>
7
+ <a href="LICENSE"><img src="https://img.shields.io/github/license/kengio/onebrain?style=flat-square" alt="License" /></a>
8
+ <a href="https://github.com/kengio/onebrain/stargazers"><img src="https://img.shields.io/github/stars/kengio/onebrain?style=flat-square" alt="GitHub Stars" /></a>
9
+ <a href="https://github.com/kengio/onebrain/commits/main"><img src="https://img.shields.io/github/last-commit/kengio/onebrain?style=flat-square" alt="Last Commit" /></a>
10
+ </p>
4
11
 
5
- ## Install
12
+ <h1 align="center">OneBrain</h1>
13
+
14
+ <p align="center">
15
+ <em>Your AI forgets everything when the session ends.<br>
16
+ Your notes, your AI, and your tools live in separate silos.<br>
17
+ OneBrain fixes both — giving you a thinking partner that remembers everything.</em>
18
+ </p>
19
+
20
+ <p align="center">
21
+ <strong>Your personal AI OS</strong> — persistent memory, 24+ skills, and a full local stack<br>
22
+ (Claude Code + Obsidian + tmux + Telegram), entirely on your own machine.
23
+ </p>
24
+
25
+ <p align="center">
26
+ <a href="#get-started">Get Started →</a> &nbsp;·&nbsp; <a href="#commands">View Commands →</a>
27
+ </p>
28
+
29
+ ---
30
+
31
+ ## What is OneBrain?
32
+
33
+ OneBrain is an AI operating system layer built on top of Obsidian. It gives your AI agent persistent memory, a structured knowledge vault, and 24+ pre-built skills — so every session picks up exactly where the last one left off.
34
+
35
+ Unlike chat-based AI tools, OneBrain lives in plain Markdown files you own forever. No cloud sync required. No proprietary format. Just your agent, your vault, your data.
36
+
37
+ **Works with:** Claude Code · Gemini CLI · any agent that reads Markdown
38
+
39
+ ---
40
+
41
+ ## Features
42
+
43
+ | | Feature | Description |
44
+ |---|---|---|
45
+ | 🧠 | **Persistent Memory** | Remembers your name, goals, preferences, and decisions across every session |
46
+ | 🖥️ | **Personal AI OS** | Full local stack: Claude Code + Obsidian + tmux + Telegram — no cloud infra needed |
47
+ | ⚡ | **24+ Skills** | Braindump, research, consolidate, bookmark, import files, daily briefing, and more |
48
+ | 📂 | **Vault-native Markdown** | Plain Markdown, no lock-in. Your data stays yours forever |
49
+ | 🤖 | **Multi-agent** | Works with Claude Code, Gemini CLI, or any agent that reads Markdown |
50
+ | 🔌 | **Zero Config** | Clone, open in Obsidian, run `/onboarding`. Ready in under 2 minutes |
51
+ | 📓 | **Session Logs & Checkpoints** | Every conversation saved with summaries and action items. Auto-checkpoints fire every 15 messages or 30 min so nothing is lost mid-session *(auto-checkpoint requires Claude Code)* |
52
+ | 💾 | **Auto Session Summary** | When you say "bye", the agent silently saves a complete session log — no `/wrapup` needed |
53
+ | 🔗 | **Knowledge Synthesis** | `/consolidate` turns inbox captures into permanent connected knowledge |
54
+ | 🔬 | **Confidence-scored Memory** | Every insight carries `[conf:high/medium/low]` + `[verified:YYYY-MM-DD]` — knowledge that grows more reliable with use |
55
+ | 💎 | **Knowledge Distillation** | `/distill` crystallizes a completed research thread into a permanent structured note in your knowledge base |
56
+ | 🩺 | **Vault Doctor** | `/doctor` audits broken links, orphan notes, stale memory, and inbox backlog; `--fix` auto-repairs confidence scores and wikilinks |
57
+ | 🎓 | **Teachable AI** | `/learn` permanently shapes how your agent thinks and responds |
58
+ | 🪄 | **Smart Memory Review** | `/memory-review` lets you interactively prune, update, or archive memory entries one by one |
59
+ | 🔒 | **Concurrent-session Safe** | Each session generates an isolated 6-char token — multiple parallel sessions never mix checkpoints |
60
+ | 📱 | **Mobile Access** | Send instructions and receive briefings from anywhere via Telegram |
61
+ | ⚙️ | **CLI Binary** | `onebrain` binary handles checkpoints, session init, doctor, vault-sync, and updates — no Python or Node.js required |
62
+
63
+ ---
64
+
65
+ ## Use Cases
66
+
67
+ ### 🖥️ Personal AI OS
68
+
69
+ Run OneBrain as your personal AI operating system — a complete AI environment that runs locally with no cloud infrastructure required.
70
+
71
+ **Recommended stack:**
72
+
73
+ | Tool | Role |
74
+ |------|------|
75
+ | [Claude Code](https://claude.ai/code) | Your AI agent, running in the terminal |
76
+ | [Obsidian](https://obsidian.md) | Your vault — single source of truth for memory and knowledge |
77
+ | [tmux](https://github.com/tmux/tmux) | Persistent sessions that survive disconnects and reboots |
78
+ | [Telegram](https://telegram.org) | Mobile access: send instructions, receive briefings from anywhere |
79
+
80
+ **Setting up the full stack:**
81
+
82
+ 1. Install OneBrain and open your vault in Obsidian ([Get Started](#get-started))
83
+ 2. Start a tmux session: `tmux new -s onebrain`
84
+ 3. Start Claude Code in your vault directory: `claude`
85
+ 4. Run `/telegram:configure` to connect Claude Code's built-in Telegram channel — no custom bot or external infra needed
86
+ 5. From any device, open Telegram and send instructions directly to your OneBrain agent
87
+
88
+ Your agent, your vault, your data — forever.
89
+
90
+ ### 🧠 Thinking Partner
91
+
92
+ Use OneBrain as a daily thinking partner. Capture ideas with `/braindump`, research topics with `/research`, synthesize knowledge with `/consolidate`, and surface connections you'd never find manually with `/connect`.
93
+
94
+ ### 📚 Knowledge Base Builder
95
+
96
+ Turn your AI into a knowledge curator: research, summarize, import files, and build a connected Markdown knowledge base that grows smarter over time.
97
+
98
+ ---
99
+
100
+ ## How It Works
101
+
102
+ After `/onboarding`, your AI agent:
103
+
104
+ 1. **Loads your identity** — name, role, goals, communication style, active projects
105
+ 2. **Greets you with context** — inbox status, overdue tasks, patterns from recent sessions
106
+ 3. **Remembers everything** — decisions, preferences, and insights accumulate over time
107
+ 4. **Suggests next actions** — based on what's in your vault, not what it can infer from scratch
108
+
109
+ ### Memory System
110
+
111
+ OneBrain uses a four-tier memory system — each tier is more compressed and longer-lived than the one below. The Semantic tier has two loading modes (always-loaded and lazy-loaded):
112
+
113
+ | Tier | Location | What it stores | Promoted by |
114
+ |------|----------|---------------|-------------|
115
+ | **Working** | `00-inbox/` + current session | Raw captures, active conversation | `/consolidate`, `/wrapup` |
116
+ | **Episodic** | `07-logs/YYYY/MM/` | Session summaries, decisions, action items | `/wrapup`, auto-checkpoint |
117
+ | **Semantic** (always-loaded) | `05-agent/MEMORY.md` + `05-agent/MEMORY-INDEX.md` | Identity + Active Projects + Critical Behaviors + memory file registry | `/learn`, `/onboarding` |
118
+ | **Semantic** (lazy-loaded) | `05-agent/memory/` | Behavioral patterns, domain facts — loaded on demand via MEMORY-INDEX.md | `/learn`, `/recap`, `/memory-review` |
119
+ | **Knowledge** | `03-knowledge/` | Permanent synthesized notes | `/distill` |
120
+
121
+ ---
122
+
123
+ ## Memory Promotion
124
+
125
+ OneBrain organizes agent memory across three layers. Each layer has specific skills responsible for writing to it.
126
+
127
+ | Layer | Storage | Written by |
128
+ |---|---|---|
129
+ | Session log | `07-logs/` | `/wrapup` (end of session) |
130
+ | Memory files | `05-agent/memory/` | `/learn` (user-driven, single fact), `/recap` (batch synthesis), `/memory-review` (edits) |
131
+ | Always-loaded — Identity | `05-agent/MEMORY.md` | `/onboarding` (one-time), manual edits |
132
+ | Always-loaded — Active Projects | `05-agent/MEMORY.md` | `/learn` (project lifecycle events), manual edits |
133
+ | Always-loaded — Critical Behaviors | `05-agent/MEMORY.md` | `/learn` only (user explicitly teaches behavior; must meet all 3 threshold conditions) |
134
+ | Always-loaded — Memory registry | `05-agent/MEMORY-INDEX.md` | Any skill writing to `memory/` (`/learn`, `/recap`, `/memory-review`) |
135
+
136
+ **Promotion pipeline:**
137
+ session → session log (`/wrapup`) → `memory/` files (`/recap`) → `MEMORY.md` Critical Behaviors (`/learn`)
138
+
139
+ **Rules:**
140
+ - `/wrapup` writes session logs only — does not promote to `memory/`
141
+ - `/learn` writes to `memory/` immediately; only skill that writes to MEMORY.md Critical Behaviors
142
+ - `/recap` batch-promotes from session logs → `memory/` only — does NOT write to MEMORY.md
143
+ - Only behaviors applying every session with high-impact failure if missed → MEMORY.md Critical Behaviors
144
+ - `MEMORY-INDEX.md` is loaded every session alongside `MEMORY.md` — it is the registry that enables lazy-loading of `memory/` files; updated automatically by any skill that writes to `memory/`
145
+
146
+ ---
147
+
148
+ ## Automatic Session Saving
149
+
150
+ OneBrain has three automatic behaviors that run without you doing anything:
151
+
152
+ | Behavior | Trigger | What it does |
153
+ |----------|---------|-------------|
154
+ | **Auto Checkpoint** | Every 15 messages, every 30 min, or before context compression | Writes a checkpoint file to `07-logs/YYYY/MM/` as a safety net |
155
+ | **Auto Session Summary** | You say "bye", "good night", "I'm done for today", etc. — only if `/wrapup` was not already run this session AND ≥ 3 exchanges | Saves a silent session log (marked `auto-saved: true`) without showing any output |
156
+
157
+ **How they work together:**
158
+
159
+ - Say "bye" → Auto Session Summary fires silently and saves a session log. No extra steps needed.
160
+ - If you already ran `/wrapup` manually and then say "bye": Auto Session Summary **skips** — the log was already written.
161
+ - If the session ends with no signal (browser closed, terminal killed): Auto Checkpoint files serve as the recovery mechanism. At next session start, Phase 2 automatically synthesizes any orphaned checkpoints into a session log.
162
+
163
+ **`/wrapup` is manual only.** Run it yourself when you want a visible, full session summary with output shown.
164
+
165
+ **The practical result:** Just say "bye" and everything is saved. If the session ends unexpectedly, you lose at most 15 messages — the last checkpoint recovers the rest.
166
+
167
+ > Auto Checkpoint requires Claude Code (uses the Claude Code stop hook) and the `onebrain` CLI binary. Install with `bun install -g @onebrain-ai/cli`. Auto Session Summary works with any agent that follows INSTRUCTIONS.md.
168
+
169
+ ---
170
+
171
+ ## Get Started
172
+
173
+ ### Option 1 — Fresh vault (recommended)
174
+
175
+ **macOS / Linux:**
176
+
177
+ ```bash
178
+ curl -fsSL https://raw.githubusercontent.com/kengio/onebrain/main/install.sh | bash
179
+ ```
180
+
181
+ **Windows (PowerShell):**
182
+
183
+ ```powershell
184
+ irm https://raw.githubusercontent.com/kengio/onebrain/main/install.ps1 | iex
185
+ ```
186
+
187
+ > Or clone manually: `git clone https://github.com/kengio/onebrain.git`
188
+
189
+ **Install the CLI binary** (required for auto-checkpoints, `/doctor`, and `/update`):
6
190
 
7
191
  ```bash
8
192
  # with bun (recommended)
@@ -14,35 +198,241 @@ npm install -g @onebrain-ai/cli
14
198
 
15
199
  Verify: `onebrain --version`
16
200
 
17
- ## What it does
201
+ 1. **Open in Obsidian** — Open folder as vault, install community plugins when prompted
202
+ 2. **Start your agent** — Open the terminal plugin, run `claude` or `gemini`
203
+ 3. **Run `/onboarding`** — 2 minutes to personalize your vault and AI assistant
204
+
205
+ ---
206
+
207
+ ### Option 2 — Add to existing vault
18
208
 
19
- The `onebrain` binary handles the low-level operations that keep your vault running.
209
+ Run from within your existing vault in Claude Code:
20
210
 
21
- **User-facing commands:**
211
+ ```
212
+ /plugin marketplace add kengio/onebrain
213
+ /plugin install onebrain@onebrain
214
+ ```
215
+
216
+ Then install the CLI binary and run `/onboarding`:
217
+
218
+ ```bash
219
+ bun install -g @onebrain-ai/cli # or: npm install -g @onebrain-ai/cli
220
+ ```
221
+
222
+ ---
223
+
224
+ > **After `/update`:** Run `/reload-plugins` to pick up changes in your current session, or simply start a new session.
225
+
226
+ ---
227
+
228
+ ## Supported Agents
229
+
230
+ | Agent | Instruction file | Setup |
231
+ |-------|-----------------|-------|
232
+ | Claude Code | `CLAUDE.md` | Loaded automatically |
233
+ | Gemini CLI | `GEMINI.md` | Loaded automatically |
234
+ | Any agent | `AGENTS.md` | Read manually or via system prompt |
235
+
236
+ ---
237
+
238
+ <a id="commands"></a>
239
+
240
+ <details>
241
+ <summary><strong>📋 24+ Commands</strong></summary>
242
+ <br>
243
+
244
+ | Command | What it does |
245
+ |---------|-------------|
246
+ | `/onboarding` | First-run setup — run this first |
247
+ | `/braindump` | Dump everything on your mind — it gets classified and filed |
248
+ | `/capture` | Quick note with auto-linking to related notes |
249
+ | `/bookmark [url]` | Save a URL with AI-generated name, description, and category to Bookmarks.md |
250
+ | `/consolidate` | Process inbox into permanent knowledge |
251
+ | `/connect` | Find connections between notes, suggest wikilinks |
252
+ | `/research [topic]` | Web research → structured note in your vault |
253
+ | `/summarize [url]` | Fetch a URL and save a deep summary note |
254
+ | `/import [path]` | Import local files (PDF, Word, images, scripts) into vault notes |
255
+ | `/reading-notes` | Turn a book or article into structured notes |
256
+ | `/weekly` | Review the week, surface patterns, set intentions |
257
+ | `/daily` | Daily briefing — surfaces tasks and last session context, then saves your focus as a daily note |
258
+ | `/recap` | Cross-session synthesis — batch-promote recurring insights from session logs into `memory/` files (does NOT write to MEMORY.md) |
259
+ | `/distill [topic]` | Crystallize a completed topic thread into a permanent knowledge note in `03-knowledge/` |
260
+ | `/tasks` | Live task dashboard in Obsidian — creates/updates `TASKS.md` with always-current query sections |
261
+ | `/moc` | Vault portal in Obsidian — creates/updates `MOC.md` with projects, areas, knowledge, tasks, and pinned links |
262
+ | `/wrapup` | Wrap up session — merges any auto-checkpoints and saves full summary to session log |
263
+ | `/learn` | Teach the agent something — facts about your world or behavioral preferences |
264
+ | `/memory-review` | Interactive review of memory files — keep, update, deprecate, or delete entries |
265
+ | `/clone` | Package your agent context for transfer to a new vault |
266
+ | `/reorganize` | Migrate flat notes into organized subfolders |
267
+ | `/qmd` | Set up fast vault search index — enables semantic search across all notes |
268
+ | `/doctor` | Vault + config health check — broken links, orphan notes, stale memory entries, inbox backlog |
269
+ | `/update` | Update skills, config, and plugins from GitHub |
270
+ | `/help` | List all available commands with descriptions |
271
+
272
+ </details>
273
+
274
+ <details>
275
+ <summary><strong>📁 Vault Structure</strong></summary>
276
+ <br>
277
+
278
+ Vault folders are created during `/onboarding`.
279
+
280
+ ```
281
+ onebrain/
282
+ ├── 00-inbox/ Raw braindumps and captures (process regularly)
283
+ │ └── imports/ Staging area for /import (drop files here)
284
+ ├── 01-projects/ Active projects with inline tasks
285
+ ├── 02-areas/ Ongoing responsibilities (health, finances, career...)
286
+ ├── 03-knowledge/ Your own synthesized thinking and insights
287
+ ├── 04-resources/ External info — research output, summaries, reference
288
+ ├── 05-agent/ AI-specific context and memory
289
+ │ ├── MEMORY.md Identity + Active Projects + Critical Behaviors
290
+ │ ├── MEMORY-INDEX.md Registry of all memory files — loaded every session, enables lazy-loading
291
+ │ └── memory/ All memory files — behavioral patterns, domain context, project facts
292
+ ├── 06-archive/ Completed projects and archived areas
293
+ ├── 07-logs/ Session logs and checkpoints (YYYY/MM/ subfolders)
294
+ ├── attachments/ Copied files from /import --attach
295
+ │ ├── pdf/
296
+ │ ├── images/
297
+ │ └── video/
298
+ ├── TASKS.md Live task dashboard (created by /tasks, opened in Obsidian)
299
+ ├── MOC.md Vault portal — Map of Content (created by /moc)
300
+ ├── CLAUDE.md Instructions for Claude Code
301
+ ├── GEMINI.md Instructions for Gemini CLI
302
+ ├── AGENTS.md Universal agent instructions
303
+ ├── vault.yml Your vault configuration (created during onboarding)
304
+ └── .claude/plugins/ AI skills and hooks
305
+ ```
306
+
307
+ The core workflow: capture everything to inbox → process with `/consolidate` → synthesize into knowledge or save as reference → archive what's done.
308
+
309
+ **`00-inbox/`** — Raw braindumps and captures
310
+ Process regularly. Everything unclassified lands here first. The `imports/` subfolder is the staging area for `/import` — copy files there and run `/import` to distill them into vault notes.
311
+
312
+ **`01-projects/`** — Active work with a clear goal and end date
313
+ Examples: `work/Website Redesign.md`, `personal/Japan Trip 2026.md`
314
+
315
+ **`02-areas/`** — Ongoing responsibilities that never "complete"
316
+ Examples: `health/Running Log.md`, `finances/Budget 2026.md`
317
+
318
+ **`03-knowledge/`** — Your own synthesized thinking
319
+ Conclusions, frameworks, and insights you've developed — not raw reference material.
320
+ Examples: `productivity/Deep Work Principles.md`, `technology/When to Use Microservices.md`
321
+
322
+ **`04-resources/`** — External information saved for reference
323
+ Output from `/research`, `/summarize`, `/reading-notes`, `/import`, and saved reference material.
324
+ Examples: `research/Zettelkasten Method.md`, `code-snippets/Go HTTP Middleware.md`
325
+
326
+ **`05-agent/`** — Your agent's portable mind
327
+ Everything the AI knows about you. Copy this folder to move your agent to a new vault.
328
+ - `MEMORY.md` — Identity + Active Projects + Critical Behaviors — loaded every session
329
+ - `MEMORY-INDEX.md` — Registry of all memory files — loaded every session, enables lazy-loading of `memory/` files
330
+ - `memory/` — All memory files — behavioral patterns, domain context, project facts
331
+
332
+ **`06-archive/`** — Completed projects and retired areas
333
+ Organized by date archived: `06-archive/YYYY/MM/`.
334
+
335
+ **`07-logs/`** — Session logs and checkpoints
336
+ Session logs: `07-logs/YYYY/MM/YYYY-MM-DD-session-NN.md` — generated by `/wrapup` or auto-saved at session end.
337
+ Checkpoints: `07-logs/YYYY/MM/YYYY-MM-DD-{session_token}-checkpoint-NN.md` — auto-generated by hooks every 15 messages or 30 minutes, and before context compression. Incorporated and deleted by `/wrapup` when wrapping up.
22
338
 
23
- | Command | Purpose |
24
- |---------|---------|
25
- | `onebrain init` | First-time vault initialization |
26
- | `onebrain update` | Pull latest plugin files from GitHub |
27
- | `onebrain doctor` | Audit vault health — orphan checkpoints, version drift, qmd embedding status, missing config |
28
- | `onebrain help` | List all available commands |
339
+ </details>
340
+
341
+ <details>
342
+ <summary><strong>🧠 Memory System</strong></summary>
343
+ <br>
344
+
345
+ OneBrain uses a four-tier memory system, where knowledge flows upward as it gets validated. The Semantic tier has two loading modes (always-loaded and lazy-loaded):
346
+
347
+ **Tier 1 — Working memory** (`00-inbox/` + current session)
348
+ Everything that hasn't been processed yet. Captures from `/braindump`, `/capture`, and quick notes land here. Process with `/consolidate` to move into the knowledge base.
349
+
350
+ **Tier 2 — Episodic memory** (`07-logs/`)
351
+ Session logs: `YYYY-MM-DD-session-NN.md` in `YYYY/MM/` subfolders. Contains summaries, decisions, insights, and action items from each session. Generated by `/wrapup`.
352
+ Checkpoints: `YYYY-MM-DD-{session_token}-checkpoint-NN.md` — auto-generated mid-session by hooks. Incorporated and deleted by `/wrapup`.
353
+
354
+ **Tier 3 — Semantic memory** (`05-agent/MEMORY.md` + `05-agent/MEMORY-INDEX.md` + `05-agent/memory/`)
355
+ Always loaded at session start: `MEMORY.md` holds Identity, Active Projects, and Critical Behaviors (~55 lines target). `MEMORY-INDEX.md` is the registry of all `memory/` files — loaded every session, enables lazy-loading. Individual `memory/` files are lazy-loaded on demand via MEMORY-INDEX.md. Only `/learn` writes to MEMORY.md Critical Behaviors. Use `/doctor --fix` to audit and repair stale entries.
356
+
357
+ **Tier 4 — Knowledge base** (`03-knowledge/`)
358
+ Permanent, synthesized notes. `/distill` crystallizes a completed topic thread into a structured note in `03-knowledge/`.
359
+
360
+ ### Task Syntax
361
+
362
+ OneBrain uses the [Obsidian Tasks](https://publish.obsidian.md/tasks/) plugin format:
363
+
364
+ ```
365
+ - [ ] Task description 📅 2026-03-25
366
+ - [ ] High priority task 🔺 📅 2026-03-22
367
+ ```
368
+
369
+ Tasks live inline in your notes — the Tasks plugin surfaces them across the vault. Run `/tasks` to open a live dashboard in Obsidian (`TASKS.md` at vault root) with sections for overdue, due this week, unscheduled, due later, and recently completed.
370
+
371
+ </details>
372
+
373
+ <details>
374
+ <summary><strong>⚙️ Prerequisites & Detailed Setup</strong></summary>
375
+ <br>
376
+
377
+ ### Prerequisites
378
+
379
+ **Required:** [git](https://git-scm.com) — used to version-control your vault.
380
+
381
+ | Platform | Install command |
382
+ |----------|----------------|
383
+ | macOS (Homebrew) | `brew install git` |
384
+ | macOS (Xcode CLT) | `xcode-select --install` |
385
+ | Windows (winget) | `winget install --id Git.Git` |
386
+ | Windows (Chocolatey) | `choco install git` |
387
+ | Debian / Ubuntu | `sudo apt install git` |
388
+ | Fedora / RHEL | `sudo dnf install git` |
389
+ | Arch | `sudo pacman -S git` |
390
+
391
+ Verify with `git --version` before running the installer.
392
+
393
+ **Required for auto-checkpoints, `/doctor`, and `/update`:** [bun](https://bun.sh) or [npm](https://nodejs.org) — used to install the `onebrain` CLI binary (`bun install -g @onebrain-ai/cli`). The binary handles checkpoints, session init, vault-sync, and doctor without requiring Python or Node.js in your PATH.
394
+
395
+ **Windows:** Git for Windows (above) includes Git Bash, which provides the `bash` environment required to run all hooks.
396
+
397
+ ### Community Plugins
398
+
399
+ These three plugins are pre-configured in vault settings — install them via **Settings → Community plugins → Browse**, then click **Trust author and enable plugins** when prompted:
400
+
401
+ - **Tasks** — task management with due dates
402
+ - **Dataview** — query notes like a database
403
+ - **Terminal** — run your AI agent from within Obsidian
404
+
405
+ These are recommended but optional:
406
+
407
+ - **Templater** — advanced templates
408
+ - **Calendar** — visual calendar view
409
+ - **Tag Wrangler** — manage tags across vault
410
+ - **QuickAdd** — fast capture workflows
411
+ - **Obsidian Git** — version control for your vault
412
+
413
+ ### Claude Code Skills (Optional)
414
+
415
+ For Obsidian-specific Claude Code skills (markdown, bases, canvas, and more), install the [Obsidian Skills](https://github.com/kepano/obsidian-skills) plugin separately:
416
+
417
+ ```
418
+ /plugin marketplace add kepano/obsidian-skills
419
+ /plugin install obsidian@obsidian-skills
420
+ ```
29
421
 
30
- **Internal commands** (not meant to be run directly):
422
+ </details>
31
423
 
32
- `session-init` · `orphan-scan` · `checkpoint` · `qmd-reindex` · `vault-sync` · `register-hooks` · `migrate`
424
+ ---
33
425
 
34
- ## Requirements
426
+ ## Customization
35
427
 
36
- - macOS, Linux, or Windows (Git Bash)
37
- - Bun or Node.js required (used as the runtime for the npm package)
38
- - For a self-contained binary with no runtime dependency, download from [GitHub Releases](https://github.com/kengio/onebrain/releases)
428
+ Edit `05-agent/MEMORY.md` directly to update your identity, goals, or recurring context at any time. The AI picks up changes on the next session start.
39
429
 
40
- ## OneBrain
430
+ The full set of AI instructions that govern your agent's behavior lives in [`.claude/plugins/onebrain/INSTRUCTIONS.md`](.claude/plugins/onebrain/INSTRUCTIONS.md). You can read it to understand how your agent works. Note that `/update` will overwrite this file — add any session-level customizations to your `CLAUDE.md` instead, so they survive updates.
41
431
 
42
- OneBrain gives your AI agent persistent memory across sessions, a structured Markdown vault, and 24+ pre-built skills — so every session picks up exactly where the last one left off.
432
+ ## Contributing
43
433
 
44
- **Full documentation and vault setup:** [github.com/kengio/onebrain](https://github.com/kengio/onebrain)
434
+ Pull requests welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
45
435
 
46
436
  ## License
47
437
 
48
- [MIT](https://github.com/kengio/onebrain/blob/main/LICENSE)
438
+ [MIT](LICENSE)