Noah Brier 09de2078c3 fix: ensure release command creates GitHub release automatically
- Add step to use gh release create after pushing tags
- Prevents missing GitHub releases like v0.8.2-v0.8.5
- Extracts release notes from CHANGELOG.md automatically
2025-09-13 22:05:57 -04:00
2025-09-13 22:00:58 -04:00
2025-09-13 22:00:58 -04:00

Claudesidian: Claude Code + Obsidian Starter Kit

Turn your Obsidian vault into an AI-powered second brain using Claude Code.

What is this?

This is a pre-configured Obsidian vault structure designed to work seamlessly with Claude Code, enabling you to:

  • Use AI as a thinking partner, not just a writing assistant
  • Organize knowledge using the PARA method
  • Maintain version control with Git
  • Access your vault from anywhere (including mobile)

Quick Start

1. Get the Starter Kit

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)

  1. Click "Code" → "Download ZIP" on GitHub
  2. Extract to your desired location
  3. Open the folder in Claude Code

2. Run the Setup Wizard

# Start Claude Code in the directory
claude

# Run the interactive setup wizard (in Claude Code)
/init-bootstrap

This will:

  • Install dependencies automatically
  • Disconnect from the original claudesidian repository
  • Intelligently analyze your existing vault structure and patterns
  • Import your existing Obsidian vault safely to OLD_VAULT/ (if you have one)
  • Research your public work for personalized context (with your permission)
  • Ask you about your workflow preferences
  • Create a personalized CLAUDE.md configuration
  • Set up your folder structure
  • Optionally configure Gemini Vision for image/video analysis
  • Optionally configure Firecrawl for web research
  • Initialize Git for version control
  • Download Obsidian
  • Open vault from the claudesidian folder
  • This gives you a visual interface alongside Claude Code

4. Your First Session

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

Folder Structure

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

Key Concepts

Thinking Mode vs Writing Mode

Thinking Mode (Research & Exploration):

  • Claude asks questions to understand your goals
  • Searches existing notes for relevant content
  • Helps make connections between ideas
  • Maintains a log of insights and progress

Writing Mode (Content Creation):

  • Generates drafts based on your research
  • Helps structure and edit content
  • Creates final deliverables

The PARA Method

Projects: Have a deadline and specific outcome

  • Example: "Q4 2025 Marketing Strategy"
  • Create a folder in 01_Projects/

Areas: Ongoing without an end date

  • Example: "Health", "Finances", "Team Management"
  • Lives in 02_Areas/

Resources: Topics of ongoing interest

  • Example: "AI Research", "Writing Tips"
  • Store in 03_Resources/

Archive: Inactive items

  • Completed projects with their outputs
  • Old notes no longer relevant

Essential Workflows

Starting a Research Project

  1. Create project folder:
mkdir -p "01_Projects/My_New_Project/{Research,Chats,Daily_Progress}"
  1. Tell Claude Code:
I'm starting a project on [topic] in 01_Projects/My_New_Project.
I'm in thinking mode. Help me explore this topic.
  1. Let Claude search your vault and ask clarifying questions

Daily Capture

  1. Create a daily note in 00_Inbox/
  2. Dump thoughts, links, ideas throughout the day
  3. Weekly: Process inbox items to appropriate folders

Synthesizing Research

Ask Claude Code:

Can you review all notes in [project folder] 
and create a synthesis of the key themes and insights?

Claude Code Commands

Pre-configured AI assistants ready to use:

  • thinking-partner - Explore ideas through questions
  • inbox-processor - Organize your captures
  • research-assistant - Deep dive into topics
  • daily-review - End of day reflection
  • weekly-synthesis - Find patterns in your week
  • create-command - Build new custom commands
  • de-ai-ify - Remove AI writing patterns from text
  • upgrade - Update to the latest claudesidian version
  • init-bootstrap - Re-run the setup wizard

Run with: /[command-name] in Claude Code

Stay Updated: Claudesidian automatically checks for updates when you start Claude Code and will remind you to run /upgrade when new features are available.

Vision & Document Analysis (Optional)

With Gemini MCP configured, you can:

  • Analyze images and screenshots
  • Extract text from PDFs
  • Compare multiple images
  • Generate smart filenames
  • Process documents

See .claude/mcp-servers/README.md for setup

Web Research (Optional)

With Firecrawl configured, you can save web content directly to your vault:

  • Save entire articles as markdown
  • Preserve content permanently
  • Make web research searchable
  • Build a research library

Tell Claude: "Save this article to my vault: [URL]" and it's done!

Helper Scripts

Run these with pnpm:

  • attachments:list - Show unprocessed attachments
  • attachments:organized - Count organized files
  • attachments:sizes - Find large files
  • attachments:orphans - Find unreferenced attachments
  • vault:stats - Show vault statistics

Advanced Setup

Git Integration

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:

  • Commit after each work session
  • Use descriptive commit messages
  • Pull before starting work

Mobile Access

  1. Set up a small server (mini PC, cloud VPS, or home server)
  2. Install Tailscale for secure VPN access
  3. Clone your vault to the server
  4. Use Termius or similar SSH client on mobile
  5. Run Claude Code remotely

Custom Agents

Create specialized agents by saving instructions:

Thinking Partner (06_Metadata/Agents/thinking-partner.md):

You are a collaborative thinking partner.
- Ask clarifying questions
- Help explore connections
- Track insights in a running log
- Never jump to solutions too quickly

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

Tips & Best Practices

From Experience

  1. Start in thinking mode: Resist the urge to generate content immediately
  2. Be a token maximalist: More context = better results
  3. Save everything: Capture chats, fragments, partial thoughts
  4. Trust but verify: Always read AI-generated content
  5. Break your flow: AI helps you resume easily

Common Patterns

The Daily Review:

What new notes were created today?
What connections can you see between today's work and my existing notes?

The Weekly Synthesis:

Review all notes from this week.
What are the key themes and insights?
What questions remain unanswered?

The Project Retrospective:

This project is complete.
Create a summary of what was learned and accomplished.
What should be archived vs kept accessible?

Troubleshooting

Claude Code can't find my notes

  • Make sure you're running Claude Code from the vault root directory
  • Check file permissions
  • Verify markdown files have .md extension

Git conflicts

  • Always pull before starting work
  • Commit frequently with clear messages
  • Use branches for experimental changes

Attachment management

  • Run npm run attachments:create-organized to set up folders
  • Use helper scripts to find orphaned files
  • Keep attachments under 10MB for Git

Philosophy

This setup is based on key principles:

  1. AI amplifies thinking, not just writing
  2. Local files = full control
  3. Structure enables creativity
  4. Iteration beats perfection
  5. The goal is insight, not just information

Contributing

This is a living template. As you develop workflows that work for you:

  1. Document them in 06_Metadata/Reference/
  2. Share back with the community
  3. Remember: best practices emerge from use, not theory

Resources

Inspiration

This starter kit was inspired by the workflows discussed in:

License

MIT - Use this however you want. Make it your own.


Remember: The bicycle feels wobbly at first, then you forget it was ever hard.

S
Description
No description provided
Readme MIT
59 MiB
Languages
JavaScript 46.5%
Python 24.3%
PowerShell 15.4%
Shell 13.8%