marketing-shibata50/exbrain
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add beginner-friendly diagrams — flow charts, system map, component table

Browse source 
- Architecture overview diagram (human → tools → vault → outputs)
- Data flow chart: what happens when you clip
- System relationship map: Claude Code / Agent / Cloud Tasks / Obsidian
- Component explanation table with links to docs
- Both EN and JP versions

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Masahiro Chaen 2026-04-08 21:45:53 +09:00
parent 833e9d30fc
commit d68b199abf
2 changed files with 259 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

130
README.md
View file

@ -16,6 +16,136 @@ Exbrain turns Claude Code's hidden internal state — Memory files, CLAUDE.md co
Your laptop can be closed. Your phone shows everything. You just open Obsidian and read.
## How It Works — For Beginners
If you're new to Claude Code or Obsidian, here's the big picture:
```
┌──────────────────────────────────────────────────────────────┐
│ YOU (Human) │
│ │
│ Work with Claude Code Bookmark on X Send URL in Slack│
│ ↓ ↓ ↓ │
└─────────┬──────────────────────┬──────────────────┬──────────┘
│ │ │
▼ ▼ ▼
┌─────────────────┐ ┌───────────────────┐ ┌──────────────────┐
│ Claude Code │ │ Cron Job (Auto) │ │ Always-On Agent │
│ (Local CLI) │ │ Every 4 hours │ │ (e.g. OpenClaw) │
│ │ │ │ │ │
│ • /clip skill │ │ • X bookmark sync │ │ • Slack listener │
│ • Hooks (auto) │ │ • xurl API │ │ • URL detection │
│ • Session logs │ │ │ │ • firecrawl │
└────────┬────────┘ └────────┬──────────┘ └────────┬─────────┘
│ │ │
└────────────────────┼──────────────────────┘
│
▼
┌──────────────────────┐
│ ~/vault/ (Git) │
│ │
│ SOUL.md MEMORY.md │
│ DREAMS.md │
│ daily/ clips/ │
│ clients/ insights/ │
└──────────┬───────────┘
│
┌────────┼────────┐
│ │ │
▼ ▼ ▼
GitHub iCloud Obsidian
(backup) (sync) (Mac+iPhone)
```
### Components Explained
| Component | What it is | Role in Exbrain |
|-----------|-----------|-----------------|
| **Claude Code** | Anthropic's AI coding CLI ([docs](https://docs.anthropic.com/en/docs/claude-code)) | Your main AI assistant. Runs skills like `/clip`, writes to vault, manages hooks |
| **Obsidian** | Free markdown note app ([obsidian.md](https://obsidian.md)) | Where you **read** everything. Vault = folder of .md files. Works on Mac, iPhone, Android |
| **Always-On Agent** | A background AI (e.g. [OpenClaw](https://openclaw.com)) | Monitors Slack/Discord 24/7. Runs cron jobs even when Claude Code is closed |
| **Cloud Scheduled Tasks** | Claude Code's built-in scheduler ([docs](https://docs.anthropic.com/en/docs/claude-code/scheduled-tasks)) | Runs morning/evening Dreaming without your PC. Updates MEMORY.md and DREAMS.md |
| **xurl** | X API CLI tool | Fetches tweets and bookmarks from X (Twitter) |
| **Firecrawl** | Web scraping CLI | Converts any URL into clean markdown |
| **iCloud** | Apple's cloud sync | Syncs vault between Mac and iPhone automatically |
| **GitHub** | Code hosting | Backup + version history for your vault |
### Data Flow: What Happens When You Clip
```
You find an interesting article
│
▼
┌─ Pick your method ──────────────────────────────────┐
│ │
│ A) /clip URL B) Slack DM C) Just │
│ in Claude Code send URL bookmark │
│ │ │ on X │
│ ▼ ▼ │ │
│ Claude Code Agent detects (wait 4h) │
│ runs instantly URL in real-time │ │
└──────┬───────────────────┬───────────────────┬──────┘
│ │ │
└───────────────────┼───────────────────┘
│
▼
┌─────────────────┐
│ AI Processing │
│ │
│ 1. Fetch content│
│ 2. Summarize │
│ 3. Tag (auto) │
│ 4. Save .md │
└────────┬────────┘
│
▼
vault/clips/x/2026-04-08_slug.md
│
┌─────────┼─────────┐
│ │ │
▼ ▼ ▼
_index.md daily note git push
updated updated to GitHub
│
▼
iCloud sync
│
▼
📱 Read on iPhone
```
### System Relationship Map
```
┌─────────────────────────────────────────────────────────┐
│ │
│ ┌──────────────┐ ┌──────────────┐ │
│ │ Claude Code │────────▶│ ~/vault/ │◀──────┐ │
│ │ (CLI agent) │ writes │ (Obsidian) │ │ │
│ │ │ │ │ writes│ │
│ │ Skills: │ │ SOUL.md │ │ │
│ │ /clip │ │ MEMORY.md │ ┌────┴────┐ │
│ │ /auto-min │ │ DREAMS.md │ │ Cloud │ │
│ │ 30+ more │ │ daily/ │ │Schedule │ │
│ └──────────────┘ │ clips/ │ │ Tasks │ │
│ │ clients/ │ │ │ │
│ ┌──────────────┐ │ meetings/ │ │ Morning │ │
│ │ Always-On │────────▶│ insights/ │ │ Evening │ │
│ │ Agent │ writes │ │ └─────────┘ │
│ │ (OpenClaw) │ └──────┬───────┘ │
│ │ │ │ │
│ │ Cron jobs: │ git push/pull │
│ │ X bookmarks │ │ │
│ │ Slack DM │ ┌──────▼───────┐ │
│ │ Reports │ │ GitHub │ │
│ └──────────────┘ │ (private) │ │
│ └──────────────┘ │
│ │
│ ─── All connected via ~/vault/ ─── │
│ │
└─────────────────────────────────────────────────────────┘
```
## The SOUL / MEMORY / DREAMS Trinity
The core of Exbrain is three files at the root of your vault:

129
README_JP.md
View file

@ -16,6 +16,135 @@ Claude Codeの中に隠れている記憶（Memory）、設定ファイル（CLA
PCを閉じても動く。iPhoneでも見える。人間はObsidianを開いて読むだけ。
## はじめに — 全体像を理解する
Claude CodeやObsidianに馴染みがない方のために、全体像を図で解説します。
```
┌──────────────────────────────────────────────────────────────┐
│ あなた（人間） │
│ │
│ Claude Codeで作業 Xでブックマーク SlackにURL送信 │
│ ↓ ↓ ↓ │
└─────────┬──────────────────────┬──────────────────┬──────────┘
│ │ │
▼ ▼ ▼
┌─────────────────┐ ┌───────────────────┐ ┌──────────────────┐
│ Claude Code │ │ Cronジョブ(自動) │ │ 常駐エージェント │
│ (ローカルCLI) │ │ 4時間おき │ │ (例: OpenClaw) │
│ │ │ │ │ │
│ • /clip スキル │ │ • Xブックマーク │ │ • Slack監視 │
│ • Hooks(自動) │ │ • xurl API │ │ • URL検知 │
│ • セッション記録│ │ │ │ • firecrawl │
└────────┬────────┘ └────────┬──────────┘ └────────┬─────────┘
│ │ │
└────────────────────┼──────────────────────┘
│
▼
┌──────────────────────┐
│ ~/vault/ (Git) │
│ │
│ SOUL.md MEMORY.md │
│ DREAMS.md │
│ daily/ clips/ │
│ clients/ insights/ │
└──────────┬───────────┘
│
┌────────┼────────┐
│ │ │
▼ ▼ ▼
GitHub iCloud Obsidian
(バックアップ) (同期) (Mac+iPhone)
```
### 各コンポーネントの役割
| コンポーネント | 何か | Exbrainでの役割 |
|-------------|------|----------------|
| **Claude Code** | AnthropicのAIコーディングCLI ([公式](https://docs.anthropic.com/en/docs/claude-code)) | メインのAIアシスタント。`/clip`等のスキル実行、vault書き込み、Hook管理 |
| **Obsidian** | 無料のMarkdownノートアプリ ([obsidian.md](https://obsidian.md)) | 全てを**読む**場所。vault = .mdファイルのフォルダ。Mac/iPhone/Android対応 |
| **常駐エージェント** | バックグラウンドAI (例: [OpenClaw](https://openclaw.com)) | Slack/Discordを24時間監視。Claude Codeを閉じてもcronジョブ実行 |
| **Cloud Scheduled Tasks** | Claude Code内蔵のスケジューラ ([公式](https://docs.anthropic.com/en/docs/claude-code/scheduled-tasks)) | PC不要で朝夕のDreamingを実行。MEMORY.mdとDREAMS.mdを自動更新 |
| **xurl** | X API CLIツール | Xのツイートやブックマークを取得 |
| **Firecrawl** | Webスクレイピング CLI | URLをクリーンなMarkdownに変換 |
| **iCloud** | Apple のクラウド同期 | MacとiPhone間でvaultを自動同期 |
| **GitHub** | コードホスティング | vaultのバックアップ + バージョン管理 |
### データフロー：クリップの仕組み
```
面白い記事を見つけた！
│
▼
┌─ 方法を選ぶ ────────────────────────────────────────┐
│ │
│ A) /clip URL B) Slack DMに C) Xで │
│ Claude Codeで URL送信 ブクマ │
│ │ │ するだけ │
│ ▼ ▼ │ │
│ Claude Code エージェントが (4時間後) │
│ 即座に実行 リアルタイム検知 │ │
└──────┬───────────────────┬───────────────────┬──────┘
│ │ │
└───────────────────┼───────────────────┘
│
▼
┌─────────────────┐
│ AI が処理 │
│ │
│ 1. 内容を取得 │
│ 2. 要約を生成 │
│ 3. タグ付け │
│ 4. .md保存 │
└────────┬────────┘
│
▼
vault/clips/x/2026-04-08_slug.md
│
┌─────────┼─────────┐
│ │ │
▼ ▼ ▼
_index.md daily note git push
更新 更新 GitHubへ
│
▼
iCloud 同期
│
▼
📱 iPhoneで読める
```
### システム相関図
```
┌─────────────────────────────────────────────────────────┐
│ │
│ ┌──────────────┐ ┌──────────────┐ │
│ │ Claude Code │────────▶│ ~/vault/ │◀──────┐ │
│ │ (CLIエージェント)│ 書込 │ (Obsidian) │ │ │
│ │ │ │ │ 書込 │ │
│ │ スキル: │ │ SOUL.md │ │ │
│ │ /clip │ │ MEMORY.md │ ┌────┴────┐ │
│ │ /auto-min │ │ DREAMS.md │ │ Cloud │ │
│ │ 30+個 │ │ daily/ │ │Schedule │ │
│ └──────────────┘ │ clips/ │ │ Tasks │ │
│ │ clients/ │ │ │ │
│ ┌──────────────┐ │ meetings/ │ │ 朝 07:00│ │
│ │ 常駐エージェント│────────▶│ insights/ │ │ 夕 18:30│ │
│ │ (OpenClaw) │ 書込 │ │ └─────────┘ │
│ │ │ └──────┬───────┘ │
│ │ Cronジョブ: │ git push/pull │
│ │ Xブクマ同期 │ │ │
│ │ Slack DM │ ┌──────▼───────┐ │
│ │ 日次レポート│ │ GitHub │ │
│ └──────────────┘ │ (private) │ │
│ └──────────────┘ │
│ │
│ ─── 全て ~/vault/ で繋がっている ─── │
│ │
└─────────────────────────────────────────────────────────┘
```
## SOUL / MEMORY / DREAMS
Exbrainの核心は、Vault直下の3つのファイル: