Claude Code + Obsidian starter kit for AI-powered knowledge management. Features: - PARA method folder structure - Bootstrap initialization system - Pre-configured Claude Code commands and agents - Gemini Vision MCP server with video support - Helper scripts for vault management - Automated release management See README.md for setup instructions.
6.1 KiB
6.1 KiB
Obsidian Vault Guidelines - Bootstrap Template
Getting Started with Claude Code + Obsidian
Quick Setup
- Start every session: Run
git pullto sync latest changes - After changes: Commit and push to preserve your work
- Use built-in tools: Prefer WebSearch and WebFetch for web content
Version Control Best Practices
CRITICAL - START EVERY SESSION: Always run git pull at the beginning of each new Claude session to ensure you have the latest changes from the remote repository.
Commit workflow:
- After creating new notes:
git add .→git commit -m "message"→git push - After significant edits: Commit and push immediately
- Use
git statusto check for modifications - When agents modify files: Always commit those changes
Folder Structure (PARA Method)
vault/
├── 00_Inbox/ # Temporary capture point
├── 01_Projects/ # Time-bound initiatives
├── 02_Areas/ # Ongoing responsibilities
├── 03_Resources/ # Reference materials
├── 04_Archive/ # Completed/inactive items
├── 05_Attachments/ # Images, PDFs, etc.
│ └── Organized/ # Processed attachments
└── 06_Metadata/ # Documentation & templates
├── Reference/ # Guides and standards
├── Plans/ # Strategic documents
└── Templates/ # Reusable structures
PARA Method Details
Projects (01)
- Time-bound initiatives with clear completion criteria
- Examples: Writing a paper, developing a presentation
- Recommended subfolders: Research/, Drafts/, References/, Output/
Areas (02)
- Ongoing responsibilities without end dates
- Examples: Health, Finances, Professional Development
- Create dedicated notes with links to related resources
Resources (03)
- Topics of interest for reference
- Knowledge bases organized by subject
- Use for information not tied to specific projects
Archive (04)
- Completed or inactive items
- Maintain same folder structure as active sections
- Review periodically for reactivation
Inbox Management
Core Principles
- Inbox is temporary, not permanent storage
- Process weekly using Capture → Process → Organize workflow
- Maintain <20 items at any time
Files to Keep in Inbox
- CRITICAL: Files with number prefixes (00-06) stay permanently
- Recent daily/weekly summaries (last 3 months)
- Active notes being processed
Processing Workflow
- Delete obsolete information
- Move relevant material to PARA locations
- Convert actions into project tasks
- Tag items needing more processing with
#needs-processing
File Organization Guidelines
Naming Conventions
- Daily notes:
YYYY-MM-DD - Topic - Meeting notes:
Meeting - [Topic] - YYYY-MM-DD - Ideas:
Idea - [Brief Description] - Resources:
Resource - [Topic] - [Source]
Movement Rules
- Use
mvcommand (notcp) to avoid duplicates - Verify destination folders exist first
- Update internal links after moves
- Add YAML frontmatter when organizing
Attachments Management
Organization
- Store all non-text files in
05_Attachments/ - Processed files →
05_Attachments/Organized/ - Naming:
[RelatedNote]_[Description].[ext]
Helper Scripts
pnpm attachments:list # List unprocessed files
pnpm attachments:organized # Count organized files
pnpm attachments:orphans # Find unreferenced files
pnpm attachments:update-links # Update links after moving
Web Content Workflow
Built-in Tools (Preferred)
- WebSearch: For general web searches
- WebFetch: For specific URLs
- Save to appropriate folder based on content type
Custom Scripts (When Needed)
- Single URL:
pnpm firecrawl:scrape <url> <output> - Batch URLs:
pnpm firecrawl:batch <url1> <url2> - Saves to
00_Inbox/Clippings/with frontmatter
Writing Style Guidelines
Structure
- Use
[[WikiLinks]]for internal references - Include YAML frontmatter (dates, tags, status)
- Consistent Markdown formatting
- Specific, consistent tags
Style Preferences
- Direct and confident statements
- Avoid clichéd transitions
- Let statements stand on their own
- No unnecessary lead-ins
AI Assistant Guidelines
Before Any Organization
- Map complete folder structure:
find . -type d | sort - Document in
06_Metadata/STRUCTURE.md - Verify all destination folders exist
Working with Content
- Respect numbered core files (never move 00-06 prefixed files)
- Always use
mvnotcpwhen organizing - Preserve and update bidirectional links
- Add appropriate YAML frontmatter
Simple Commands Only
- REQUIRED: Direct, basic commands without filtering
- FORBIDDEN: Complex regex, piped commands, find with filters
- Example RIGHT:
ls -1then manually select files - Example WRONG:
ls | grep patternorfind . -name "*.png"
Daily Workflows
Start of Day
- Run
git pull - Check inbox for items to process
- Review active projects
End of Day
- Process new inbox items
- Commit and push changes
- Update project notes
Weekly Review
- Process entire inbox
- Archive completed projects
- Update area notes
- Review and consolidate resources
Project Lifecycle
Starting a Project
- Create folder in
01_Projects/[ProjectName] - Add subfolders: Research/, Drafts/, Output/
- Create README with objectives and timeline
During Project
- Keep all related materials in project folder
- Link to relevant resources and areas
- Regular commits to track progress
Completing a Project
- Create project summary note
- Move entire folder to
04_Archive/ - Update relevant area notes
- Commit with completion message
Best Practices
Organization
- Keep folder structure shallow (max 3 levels)
- Create subfolders only with 7+ related notes
- Use linking over deep nesting
- Include README in major folders
Content Creation
- Capture first, organize later
- One idea per note
- Link generously
- Tag consistently
Maintenance
- Weekly inbox processing
- Monthly project reviews
- Quarterly archive cleanup
- Regular git commits
This is a bootstrap template. Customize based on your workflow and needs.