npx skills add https://github.com/heyitsnoah/claudesidian --skill obsidian-bases使用 CLI 安装这个技能,并在你的工作区中直接复用对应的 SKILL.md 工作流。
Turn your Obsidian vault into an AI-powered second brain using Claude Code.
This is a pre-configured Obsidian vault structure designed to work seamlessly
with Claude Code, enabling you to:
Option A: Clone with Git
# Clone with your preferred folder name (replace 'my-vault' with any name you like)
git clone https://github.com/heyitsnoah/claudesidian.git my-vault
cd my-vault
# Examples:
# git clone https://github.com/heyitsnoah/claudesidian.git obsidian-notes
# git clone https://github.com/heyitsnoah/claudesidian.git knowledge-base
# git clone https://github.com/heyitsnoah/claudesidian.git second-brain
Option B: Download ZIP (no Git required)
# Start Claude Code in the directory
claude
# Run the interactive setup wizard (in Claude Code)
/init-bootstrap
This will:
Tell Claude Code:
I'm starting a new project about [topic].
I'm in thinking mode, not writing mode.
Please search my vault for any relevant existing notes,
then help me explore this topic by asking questions.
Or use one of the pre-configured commands (in Claude Code):
/thinking-partner # For collaborative exploration
/daily-review # For end-of-day reflection
/research-assistant # For deep dives into topics
claudesidian/
├── 00_Inbox/ # Temporary capture point for new ideas
├── 01_Projects/ # Active, time-bound initiatives
├── 02_Areas/ # Ongoing responsibilities
├── 03_Resources/ # Reference materials and knowledge base
├── 04_Archive/ # Completed projects and inactive items
├── 05_Attachments/ # Images, PDFs, and other files
├── 06_Metadata/ # Vault configuration and templates
│ ├── Reference/ # Documentation and guides
│ └── Templates/ # Reusable note templates
└── .scripts/ # Helper scripts for automation
Thinking Mode (Research & Exploration):
Writing Mode (Content Creation):
Projects: Have a deadline and specific outcome
01_Projects/Areas: Ongoing without an end date
02_Areas/Resources: Topics of ongoing interest
03_Resources/Archive: Inactive items
Claudesidian ships with agent skills that auto-discover when you describe a
task. Skills work in Claude Code, OpenCode, Codex, Cursor, and Pi — they live
in .agents/skills/<name>/SKILL.md (canonical) with symlinks in
.claude/skills/ and .pi/skills/.
thinking-partner - Explore ideas through questionsinbox-processor - Organize your capturesresearch-assistant - Deep dive into topicsdaily-review - End of day reflectionweekly-synthesis - Find patterns in your weekde-ai-ify - Remove AI writing patterns from textadd-frontmatter - Add YAML properties to notesdownload-attachment - Save URLs to your attachments folderpragmatic-review - YAGNI/KISS code reviewpull-request - Open a PR from your changesrelease - Cut a new claudesidian releaseupgrade - Update to the latest claudesidian versioninit-bootstrap - Re-run the setup wizardinstall-claudesidian-command - Install shell command to launch vault fromSkills trigger automatically when you describe what you want — e.g. "wrap up
my day" loads daily-review, "open a PR for this" loads pull-request. No
slash command needed.
upgradeClaudesidian automatically checks for updates when you start Claude Code and
will remind you to run the upgrade skill when new features are available.
The upgrade command intelligently merges new features while preserving your
customizations:
# Preview what would be updated (recommended first)
/upgrade check
# Run the interactive upgrade
/upgrade
# Skip confirmations for safe updates (advanced)
/upgrade force
What the upgrade does:
Safety features:
.backup/upgrade-[timestamp]/.upgrade-checklist.mdWith Google Gemini MCP configured, Claude Code can
process your attachments directly without having to describe them. This means:
Why this matters: Instead of describing "a screenshot showing an error
message", Claude Code directly sees and reads the error. Perfect for debugging
UI issues, analyzing charts, or processing scanned documents.
Getting a Gemini API key:
export GEMINI_API_KEY="your-key-here"See .claude/mcp-servers/README.md for full setup instructions
With Firecrawl configured, our helper scripts
fetch and save full web content directly to your vault. This means:
firecrawl-batch.shWhy this matters: Instead of Claude reading a webpage and summarizing it
(losing detail), the scripts save the FULL text. Claude can then search and
analyze thousands of saved articles without hitting context limits. Perfect for
research projects, documentation archives, or building a knowledge base.
Example workflow:
# Save a single article
npm run firecrawl:scrape -- "https://example.com/article" "03_Resources/Articles"
# Batch save multiple URLs
npm run firecrawl:batch -- urls.txt "03_Resources/Research"
Getting a Firecrawl API key:
fc-xxxxx...)export FIRECRAWL_API_KEY="fc-your-key-here"Run these with pnpm:
attachments:list - Show unprocessed attachmentsattachments:organized - Count organized filesattachments:sizes - Find large filesattachments:orphans - Find unreferenced attachmentsvault:stats - Show vault statisticsInstall a shell command to launch your vault from any directory:
# In Claude Code, run:
/install-claudesidian-command
This creates a claudesidian alias that:
Usage:
# From anywhere in your terminal:
claudesidian
# It will automatically resume your last session or start a new one
The command is added to your shell config (~/.zshrc, ~/.bashrc, etc.) so it
persists across terminal sessions.
Initialize Git for version control:
git init
git add .
git commit -m "Initial vault setup"
git remote add origin your-repo-url
git push -u origin main
Best practices:
Create specialized commands by saving instructions in .claude/commands/:
Research Assistant (06_Metadata/Agents/research-assistant.md):
You are a research assistant.
- Search the vault for relevant information
- Synthesize findings from multiple sources
- Identify gaps in knowledge
- Suggest areas for further exploration
.md extensionnpm run attachments:create-organized to set up foldersThis setup is based on key principles:
We welcome contributions from the community! This is a living template that gets
better with everyone's input.
git checkout -b feature/amazing-feature)git commit -m 'Add amazing feature')git push origin feature/amazing-feature)When new features are contributed and merged, users can easily get them with:
/upgrade
The upgrade command intelligently merges new features while preserving your
personal customizations, making it easy to benefit from community contributions
without losing your work.
Remember: best practices emerge from use, not theory. Your real-world experience
makes this better for everyone!
This starter kit was inspired by the workflows discussed in:
MIT - Use this however you want. Make it your own.
Remember: The bicycle feels wobbly at first, then you forget it was ever hard.