Your Obsidian-powered second brain — knowledge management, web clippings, and multi-agent orchestration in one vault.

🇨🇳 中文文档 · Quick Start · Features · Architecture

---

🤔 What is Oh-My-Brain?

Oh-My-Brain is an opinionated Obsidian vault template for power users who want a single hub for:

• 📚 Personal knowledge — notes, memories, and structured thinking
• ✂️ Web clippings — articles and pages collected from browsers
• 🤖 Multi-agent orchestration — mount external code repos and coordinate AI agents from one place
• 🎨 Visual organization — color-coded folders with a shared config that travels with your vault

It ships with a custom Obsidian plugin (Oh My Brain) and a one-click setup script — clone, run, and you're ready.

✨ Features

🔌 Oh My Brain Plugin

🎨 Folder Coloring Right-click any folder → pick from 27 presets or a custom color picker. Colors cascade to child folders. Config is git-tracked so every clone looks the same.	🤖 External Agent Management Mount any local code repository as a vault subdirectory. The repo's CLAUDE.md is symlinked automatically — your AI agent context lives alongside your notes.
🔗 CLAUDE.md Linking & Sync Symlinks preferred; auto-falls back to copy when symlinks aren't available. One-click re-sync from command palette or right-click menu.	⚙️ Two-Layer Color Config Shared colors in folder-colors.json (git-tracked) + personal overrides in data.json (gitignored). Just like VS Code's settings model.

🏗️ Architecture

📂 Directory tree

oh-my-brain/
├── Brain/                  # Core knowledge: SOUL.md, Memory.md
│   ├── SOUL.md             # Agent identity & behavioral constraints
│   └── Memory.md           # Persistent runtime memory & decisions
├── Clippings/              # Web clippings from browsers
├── Skills/                 # Workspace skill definitions
├── Agents/                 # External agent workspaces
│   └── <alias>/
│       └── CLAUDE.md       # → Symlink to external repo's CLAUDE.md
├── Output/                 # Generated reports, slides, images
├── oh-my-brain-plugin/     # Plugin source & setup script
│   ├── src/                # TypeScript source code
│   ├── folder-colors.json  # Shared color config (git-tracked)
│   └── setup.py            # One-click initialization
├── .obsidian/              # Obsidian internal config
└── CLAUDE.md               # Project guide for AI agents

⚡ How It Works

Oh-My-Brain acts as a central coordinator. Your knowledge, clippings, and external agent workspaces are all visible in one vault. The custom plugin handles folder coloring and repo mounting. AI agents read CLAUDE.md files to understand each workspace's context.

🚀 Quick Start

Prerequisites

Tool	Version	Purpose
Obsidian	v1.4.5+	The vault host
Node.js	v18+	Build the plugin
Python 3	v3.10+	Run the setup script
Git	any	Clone the repo

Installation

# 1. Clone the vault
git clone https://github.com/<your-username>/oh-my-brain.git
cd oh-my-brain

# 2. One-click setup — builds plugin, downloads dependencies
python oh-my-brain-plugin/setup.py

# 3. Open in Obsidian
#    Obsidian → Open folder as vault → select oh-my-brain/
#    Settings → Community plugins → Disable Restricted mode → Enable plugins

⚙️ Setup options

python oh-my-brain-plugin/setup.py --force          # Force rebuild / reinstall
python oh-my-brain-plugin/setup.py --skip-build     # Skip building local plugins
python oh-my-brain-plugin/setup.py --skip-download   # Offline mode, skip remote downloads

Bundled Plugins

Required (auto-installed)

Plugin	Source	Description
Oh My Brain	Local (oh-my-brain-plugin/)	Core plugin: folder coloring, agent management, CLAUDE.md linking
Execute Code	twibiral/obsidian-execute-code	Run code blocks directly in notes (Python, JS, Shell, 20+ languages)

Optional (interactive selection during setup)

Plugin	Source	Description
Claudian	YishenTu/claudian	Claude AI chat inside Obsidian (requires API key)
Marp Slides	samuele-cozzi/obsidian-marp-slides	Markdown → presentation slides
Excalidraw	zsviczian/obsidian-excalidraw-plugin	Whiteboard diagrams, sketches, and mind maps

📖 Usage

🎨 Folder Coloring

1. Right-click any folder in the file explorer
2. Click Set folder color → pick a color
3. Toggle Apply to children to cascade

Shared vs. Personal: Colors saved to oh-my-brain-plugin/folder-colors.json are shared via git. Personal overrides in plugin data.json are gitignored.

🤖 Adding an External Agent

1. Ctrl+P → Add External Agent
2. Browse to a local repo
3. Set an alias and color
4. The plugin creates Agents/<alias>/ with a symlinked CLAUDE.md

🔄 Syncing CLAUDE.md

• Single agent: Right-click agent folder → Sync CLAUDE.md
• All agents: Command palette → Sync all agent CLAUDE.md files

🎨 Color Config System

The plugin uses a two-layer config model — think VS Code settings:

┌─────────────────────────────────────────────────────┐
│  User Layer (data.json)           ← gitignored      │
│  Overrides per-path                                  │
├─────────────────────────────────────────────────────┤
│  Shared Layer (folder-colors.json) ← git-tracked    │
│  Defaults for all users                              │
└─────────────────────────────────────────────────────┘
         ▲ User wins when both define the same path

Toggle "Use shared colors" in plugin settings to disable the shared layer entirely.

🛠️ Development

cd oh-my-brain-plugin
npm install
npm run build          # Production build
# Output → .obsidian/plugins/oh-my-brain/

The plugin is built with TypeScript + esbuild. Source lives in oh-my-brain-plugin/src/.

🗂️ Key Files

File	Purpose
CLAUDE.md	Project guide — AI agent reads this for vault context
Brain/SOUL.md	Agent identity and behavioral constraints
Brain/Memory.md	Persistent agent memory and experience
oh-my-brain-plugin/setup.py	One-click vault initialization
oh-my-brain-plugin/folder-colors.json	Shared folder color config
oh-my-brain-plugin/src/	Plugin TypeScript source

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

1. Fork the repository
2. Create your branch (git checkout -b feature/amazing-feature)
3. Commit your changes
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 License

MIT © Xu Jihui

---

Made with 🧠 and ☕ — powered by Obsidian