← 返回 Skills 市场
lukeaustin13

Forge Obsidian Brain

作者 LukeAustin13 · GitHub ↗ · v1.0.2 · MIT-0
cross-platform ⚠ suspicious
73
总下载
0
收藏
0
当前安装
3
版本数
在 OpenClaw 中安装
/install forge-obsidian-brain
功能描述
CLI tool for managing an AI's Obsidian vault with note CRUD, bidirectional sync, capture commands, and intelligent resurface. Local-only — no network access....
使用说明 (SKILL.md)

ForgeObsidianBrain

Analytics and capture layer for an AI's Obsidian vault. Auto-discovers vaults, manages note CRUD operations, captures fleeting thoughts, resurfaces forgotten knowledge, with fuzzy matching, regex patterns, and case-insensitive search.

Security Note: See SECURITY.md for full security model. This skill operates entirely locally with no network access.


Installation

# Clone or copy to your OpenClaw skills folder
cp -r skills/forge-obsidian-brain ~/.openclaw/workspace/skills/

# Make executable
chmod +x ~/.openclaw/workspace/skills/forge-obsidian-brain/scripts/brain.js

# Set up alias (optional)
alias brain="node ~/.openclaw/workspace/skills/forge-obsidian-brain/scripts/brain.js"

Configuration

Set the default vault path via environment variable:

export OBSIDIAN_VAULT="$HOME/obsidian-vault"

Or specify --vault \x3Cpath> for any command.

The skill auto-discovers vaults by:

  1. Checking OBSIDIAN_VAULT environment variable
  2. Reading Obsidian's config (~/.config/obsidian/obsidian.json)
  3. Falling back to ~/obsidian-vault

Commands

Core Commands

Command Description
discover Auto-detect vault location
config Show Obsidian configuration
init Create Brain folder structure
sync Bidirectional sync with memory folder

Note CRUD

Command Usage
read \x3Cpath> Read a note
create \x3Cpath> [content] Create a new note
update \x3Cpath> [content] Update existing note
delete \x3Cpath> Delete a note
list [folder] List notes in folder
search \x3Cquery> Search notes by content (case-insensitive by default)
search \x3Cquery> --fuzzy Fuzzy search (typo-tolerant)
search \x3Cquery> --regex Regex pattern search
exists \x3Cpath> Check if note exists

Capture Commands

Capture content to structured folders:

Command Description
capture thought \x3Ctext> Quick thought → Brain/Thoughts/
capture research --url \x3Curl> --title \x3Ctitle> Research ref → Brain/Research/
capture conversation --source \x3Csrc> --id \x3Cid> Chat log → Brain/Conversations/

Examples:

# Fleeting thought
brain capture thought "I should refactor the auth module"

# Research capture
brain capture research \
  --url "https://martinfowler.com/articles/microservices.html" \
  --title "Microservices Guide" \
  --text "Key points about service boundaries"

# Conversation log
brain capture conversation \
  --source telegram \
  --id "12345" \
  --text "User asked about distributed systems"

Resurface Commands

Find relevant or neglected notes:

Command Description
resurface topic \x3Cquery> Fuzzy search with relevance scoring
resurface stale --days \x3Cn> Find notes untouched in N days

Examples:

# Find notes about microservices
brain resurface topic "microservices"

# Find all notes older than 30 days
brain resurface stale --days 30 --limit 20

Options

Flag Description
--vault \x3Cpath> Override vault location
--frontmatter '\x3Cjson>' Add frontmatter to note
--merge Merge instead of replace frontmatter
--overwrite Allow overwriting existing notes
--limit \x3Cn> Limit results (default: 5)
--dry-run Preview sync without writing
--days \x3Cn> Days threshold for stale search
--fuzzy Use fuzzy matching for search
--regex Use regex pattern for search
--case-sensitive Force case-sensitive search

Workflow Examples

Daily Brain Maintenance

# 1. Initialize structure (once)
brain init

# 2. Capture a thought
brain capture thought "Kubernetes selectors are just labels as queries"

# 3. Save research for later
brain capture research \
  --url "https://distcc.github.io/" \
  --title "Distributed Compilation"

# 4. Check for stale notes to review
brain resurface stale --days 14

# 5. Sync to memory folder
brain sync

Search and Resurface

# Case-insensitive search (new default)
brain search "OpenClaw"

# Fuzzy search - matches "opneclaw" to "openclaw"
brain search "opneclaw" --fuzzy

# Regex search
brain search "^# .* Title" --regex

# Case-sensitive search
brain search "OpenClaw" --case-sensitive

# Resurface topic with fuzzy matching
brain resurface topic distributed --limit 10

# Output:
# {
#   "success": true,
#   "query": "distributed",
#   "totalMatches": 3,
#   "shown": 3,
#   "searchMode": "fuzzy",
#   "results": [
#     { "relativePath": "Brain/Research/...", "relevance": 5, "rank": 1, "matches": [...] },
#     ...
#   ]
# }

Folder Structure

After brain init, your vault gets these folders:

vault/
├── Brain/
│   ├── Thoughts/          # Quick captures
│   ├── Research/          # URL references
│   ├── Conversations/     # Chat logs
│   ├── Entities/          # Structured data
│   └── Relations/         # Connections
└── .obsidian/
    └── ...

Implementation Details

  • Vault Discovery: Cross-platform (Linux, macOS, Windows)
  • Note Format: Markdown with YAML frontmatter
  • Search: Uses grep for fast content matching
  • Sync: Bidirectional between ~/.openclaw/workspace/memory and vault Inbox
  • IDs: Base36 timestamps for collision-resistant filenames

Security

This skill operates entirely on the local filesystem with no network access:

  • No external APIs — No network requests are made
  • No data exfiltration — All data stays on your machine
  • No arbitrary code executionexecSync is used only for grep text search with strictly validated input
  • Plain source code — No obfuscation, all JavaScript is readable

See SECURITY.md for complete security documentation including data access patterns, credentials, and execution details.


Related

安全使用建议
Review or patch the path validation and delete-confirmation behavior before installing. If you use it, set an explicit vault path, back up your vault, use dry runs for sync, and only sync folders whose contents you are comfortable becoming persistent agent memory.
功能分析
Type: OpenClaw Skill Name: forge-obsidian-brain Version: 1.0.2 The forge-obsidian-brain skill is a local-only CLI tool for managing an Obsidian vault, providing note CRUD, bidirectional synchronization, and advanced search capabilities (fuzzy, regex, case-insensitive). The implementation uses only Node.js built-in modules (fs, path, crypto, os) and explicitly avoids network access, external APIs, and shell execution, as documented in the provided SECURITY.md and SCANNER_APPEAL.md files. All operations are confined to the user's vault and OpenClaw workspace, with no evidence of malicious intent, data exfiltration, or unauthorized execution.
能力标签
cryptorequires-walletrequires-sensitive-credentials
能力评估
Purpose & Capability
The local note CRUD, search, capture, and sync features match the stated purpose, but the implementation gives high-impact read/write/delete authority over user-supplied paths without enforcing that they remain inside the vault.
Instruction Scope
Commands are documented as vault-focused, but the note path resolver accepts traversal-style paths and the delete implementation removes files immediately without an implemented confirmation gate.
Install Mechanism
The artifacts show a manual local copy/chmod/alias setup with readable JavaScript and no remote installer, package install, or download-to-run flow.
Credentials
Reading and writing Obsidian notes and OpenClaw memory is purpose-aligned, but the missing containment check makes local filesystem authority broader than the described vault scope.
Persistence & Privilege
The skill does not show startup persistence, but it does intentionally persist sync state and append vault content into OpenClaw memory for later reuse.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install forge-obsidian-brain
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /forge-obsidian-brain 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.2
- Internal code improvements in note CRUD, search, sync, and vault management scripts. - No user-facing command or documentation changes in this release.
v1.0.1
- Added SECURITY.md detailing the local-only security model; skill now explicitly documents that it uses no network access. - Updated documentation (SKILL.md) to clarify local-only operation and reference new security documentation. - Added README.md and SCANNER_APPEAL.md for improved onboarding and policy visibility. - No functional changes to code, but documentation and security positioning significantly improved.
v1.0.0
Initial release of forge-obsidian-brain: a powerful CLI tool for AI-driven Obsidian vault management. - Provides note CRUD, bidirectional sync, and fast, intelligent search (case-insensitive, fuzzy, regex). - Auto-discovers vault location across common configurations. - Adds quick capture commands for thoughts, research, and conversations to structured folders. - Features tools to resurface neglected or relevant notes by topic or staleness. - Multi-platform, easy setup, supports YAML frontmatter, and bidirectional sync with OpenClaw memory.
元数据
Slug forge-obsidian-brain
版本 1.0.2
许可证 MIT-0
累计安装 0
当前安装数 0
历史版本数 3
常见问题

Forge Obsidian Brain 是什么?

CLI tool for managing an AI's Obsidian vault with note CRUD, bidirectional sync, capture commands, and intelligent resurface. Local-only — no network access.... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 73 次。

如何安装 Forge Obsidian Brain?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install forge-obsidian-brain」即可一键安装,无需额外配置。

Forge Obsidian Brain 是免费的吗?

是的,Forge Obsidian Brain 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。

Forge Obsidian Brain 支持哪些平台?

Forge Obsidian Brain 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 Forge Obsidian Brain?

由 LukeAustin13(@lukeaustin13)开发并维护,当前版本 v1.0.2。

💬 留言讨论