Initial commit: Complete Obsidian + Claude Code PKM Starter Kit

- Core structure with README, LICENSE, and .gitignore
- Complete vault template with Goals, Daily Notes, Projects, and Templates
- Cascading goal system (3-year → yearly → monthly → weekly)
- Claude Code integration with custom slash commands
- GitHub Actions workflow for mobile integration
- Comprehensive documentation (setup, customization, workflows, troubleshooting)
- Automation scripts for setup (Unix/Mac and Windows)
- Example content showing system usage
- Self-documenting templates with inline instructions

Ready for users to clone and customize for their personal knowledge management needs.
This commit is contained in:
Bill Allred
2025-08-07 17:11:26 -07:00
commit 3877057f7c
28 changed files with 6178 additions and 0 deletions

549
docs/CUSTOMIZATION.md Normal file
View File

@@ -0,0 +1,549 @@
# Customization Guide
Make this PKM system truly yours. This guide covers everything from simple tweaks to advanced modifications.
## Table of Contents
1. [Quick Customizations](#quick-customizations)
2. [Template Modifications](#template-modifications)
3. [Folder Structure](#folder-structure)
4. [Tag System](#tag-system)
5. [Claude Commands](#claude-commands)
6. [Workflow Automation](#workflow-automation)
7. [Theme and Appearance](#theme-and-appearance)
8. [Advanced Configurations](#advanced-configurations)
## Quick Customizations
### Personal Mission Statement
Location: `CLAUDE.md` and `Templates/Daily Template.md`
Replace the placeholder with your actual mission:
```markdown
_"Your personal mission or daily affirmation here"_
```
Examples:
- "Build with purpose, live with intention, grow with courage"
- "Create value, nurture relationships, embrace learning"
- "Simplify complexity, amplify impact, multiply joy"
### Time Blocks
Location: `Templates/Daily Template.md`
Adjust to your schedule:
```markdown
## ⏰ Time Blocks
- **Early Morning (5-7am):** Meditation & Exercise
- **Morning (7-10am):** Deep work
- **Midday (10am-1pm):** Meetings & Collaboration
- **Afternoon (1-4pm):** Administrative tasks
- **Late Afternoon (4-6pm):** Learning & Development
- **Evening (6-9pm):** Family & Personal time
```
### Goal Percentages
Location: `Goals/1. Yearly Goals.md`
Adjust effort allocation:
```markdown
### 💼 Career (40% of effort) <!-- Increase if career-focused -->
### 🏃 Health (30% of effort) <!-- Increase if health is priority -->
### ❤️ Relationships (20% of effort)
### 🌱 Personal Growth (10% of effort)
```
## Template Modifications
### Daily Template Variations
#### Minimalist Version
```markdown
# {{date:dddd, MMMM DD, YYYY}}
## Focus
-
## Tasks
- [ ]
- [ ]
- [ ]
## Notes
## Reflection
- Win:
- Learn:
- Tomorrow:
```
#### Detailed Version
```markdown
# {{date:dddd, MMMM DD, YYYY}}
## Morning Intention
### Gratitude
### Affirmation
### Priority
## Schedule
### Time Blocks
### Meetings
### Deadlines
## Tasks by Context
### @Office
### @Home
### @Computer
### @Phone
## Project Updates
### [Project 1]
### [Project 2]
## Learning Log
### What I Learned
### Resources Consumed
### Questions Raised
## Health Tracking
### Exercise
### Nutrition
### Sleep
### Mood
## Detailed Reflection
### Successes
### Challenges
### Insights
### Improvements
```
### Weekly Review Variations
#### Sprint-Based Review
```markdown
# Sprint Review - Sprint {{sprint_number}}
## Sprint Goals
- [ ] Goal 1
- [ ] Goal 2
## Velocity
- Points Planned:
- Points Completed:
- Carry Over:
## Retrospective
### What Went Well
### What Didn't Work
### Action Items
```
#### OKR-Based Review
```markdown
# Weekly OKR Check-in
## Objective 1: [Title]
### Key Result 1: [Metric]
- Progress: [X]%
- This Week's Contribution:
### Key Result 2: [Metric]
- Progress: [X]%
- This Week's Contribution:
```
## Folder Structure
### Alternative Structures
#### GTD-Based
```
vault/
├── Inbox/ # Capture everything
├── Next Actions/ # Immediate tasks
├── Projects/ # Multi-step outcomes
├── Someday Maybe/ # Future possibilities
├── Reference/ # Information storage
└── Contexts/ # @home, @office, @errands
```
#### PARA Method
```
vault/
├── Projects/ # Things with deadlines
├── Areas/ # Ongoing responsibilities
├── Resources/ # Future reference
└── Archives/ # Inactive items
```
#### Zettelkasten-Inspired
```
vault/
├── Permanent Notes/ # Atomic ideas
├── Literature Notes/ # From sources
├── Daily Notes/ # Journal entries
├── Index/ # Entry points
└── References/ # Sources
```
### Adding Custom Folders
Create specialized folders for your needs:
```
vault/
├── Finances/ # Budget, investments
├── Learning/ # Courses, books, skills
├── Health/ # Medical, fitness, nutrition
├── Creative/ # Writing, art, music
└── Relationships/ # People, interactions
```
## Tag System
### Creating Your Tag Taxonomy
#### Hierarchical Tags
```markdown
#work/project/clientA
#work/project/clientB
#work/admin/expenses
#work/admin/planning
#personal/health/exercise
#personal/health/nutrition
#personal/finance/budget
#personal/finance/investing
```
#### Status-Based Tags
```markdown
#status/active
#status/waiting
#status/delegated
#status/complete
#status/cancelled
```
#### Energy-Based Tags
```markdown
#energy/high # Requires focus
#energy/medium
#energy/low # Can do when tired
```
#### Context Tags
```markdown
#context/home
#context/office
#context/online
#context/phone
#context/errands
```
### Tag Combinations
Use multiple tags for powerful filtering:
```markdown
#work #priority/high #energy/high #context/office
```
## Claude Commands
### Creating Custom Commands
#### Example: Book Notes Command
Create `.claude/commands/book.md`:
```markdown
# Book Notes Creator
Creates a new book note with metadata and structure.
## Usage
claude code /book "Book Title" "Author"
## What it does
1. Creates note in Resources/Books/
2. Adds metadata (title, author, date started)
3. Includes template for notes
4. Links to reading list
```
#### Example: Meeting Notes Command
Create `.claude/commands/meeting.md`:
```markdown
# Meeting Notes
Creates formatted meeting notes with action items.
## Usage
claude code /meeting "Meeting Title"
## Template
- Date/Time
- Attendees
- Agenda
- Discussion
- Action Items
- Follow-up
```
### Modifying Existing Commands
#### Daily Command for Different Schedules
Edit `.claude/commands/daily.md`:
```javascript
// For night shift workers
const DAILY_NOTES_TIME = "18:00"; // 6 PM start
// For early risers
const MORNING_ROUTINE_START = "05:00";
// For parents
const INCLUDE_FAMILY_SECTION = true;
```
## Workflow Automation
### Morning Routine Automation
Create `.claude/commands/morning.md`:
```markdown
# Morning Routine
Executes complete morning workflow.
## Steps
1. Create daily note
2. Review yesterday's uncomplete tasks
3. Check calendar for today
4. Pull priority from weekly goals
5. Set time blocks
6. Generate motivation quote
```
### End-of-Day Automation
Create `.claude/commands/evening.md`:
```markdown
# Evening Shutdown
Complete end-of-day routine.
## Steps
1. Mark task completion
2. Write reflection
3. Move incomplete tasks
4. Set tomorrow's priority
5. Commit to git
6. Generate daily summary
```
### Project Kickoff Automation
Create `.claude/commands/kickoff.md`:
```markdown
# Project Kickoff
Initialize new project with structure.
## Steps
1. Create project folder
2. Add CLAUDE.md with template
3. Create project plan
4. Set up project board
5. Add to active projects list
6. Create first milestone
```
## Theme and Appearance
### Obsidian Theme Customization
#### CSS Snippets
Create `.obsidian/snippets/custom.css`:
```css
/* Custom colors */
.theme-dark {
--text-accent: #7c3aed; /* Purple accent */
--interactive-accent: #7c3aed;
}
/* Larger headings */
.markdown-preview-view h1 {
font-size: 2.5em;
color: var(--text-accent);
}
/* Checkbox styling */
input[type=checkbox]:checked {
background-color: #10b981; /* Green */
}
/* Tag colors */
.tag[href="#priority/high"] {
background-color: #ef4444;
color: white;
}
.tag[href="#energy/low"] {
background-color: #3b82f6;
color: white;
}
```
### Daily Note Styling
Add to your daily template:
```markdown
<div style="background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); padding: 20px; border-radius: 10px; color: white; margin-bottom: 20px;">
<h2 style="margin: 0;">{{date:dddd, MMMM DD, YYYY}}</h2>
<p style="margin: 5px 0; font-style: italic;">Your daily mission statement here</p>
</div>
```
## Advanced Configurations
### Dataview Queries
If using Dataview plugin:
#### Task Dashboard
````markdown
```dataview
TABLE
file.link AS "Note",
filter(file.tasks, (t) => !t.completed) AS "Open Tasks"
FROM "Daily Notes"
WHERE file.day >= date(today) - dur(7 days)
SORT file.day DESC
```
````
#### Habit Tracker
````markdown
```dataview
TABLE
exercise AS "🏃",
meditation AS "🧘",
reading AS "📚",
water AS "💧"
FROM "Daily Notes"
WHERE file.day >= date(today) - dur(30 days)
```
````
### Templater Scripts
If using Templater plugin:
#### Auto-weather
```javascript
<%*
const response = await fetch('http://wttr.in/?format=3');
const weather = await response.text();
tR += weather;
%>
```
#### Random Quote
```javascript
<%*
const quotes = [
"The way to get started is to quit talking and begin doing.",
"The future belongs to those who believe in the beauty of their dreams.",
"It is during our darkest moments that we must focus to see the light."
];
const randomQuote = quotes[Math.floor(Math.random() * quotes.length)];
tR += randomQuote;
%>
```
### Git Hooks
Create `.git/hooks/pre-commit`:
```bash
#!/bin/bash
# Auto-format markdown files before commit
# Format all markdown files
find . -name "*.md" -type f -exec prettier --write {} \;
# Add formatted files back
git add -A
```
### Mobile Shortcuts
#### iOS Shortcuts
Create Siri Shortcuts for:
- "Create daily note" → Opens GitHub app to issue creation
- "Add task" → Creates issue with 'task' label
- "Weekly review" → Triggers GitHub Action
#### Android Automation
Use Tasker or Automate for:
- Morning notification to create daily note
- Evening reminder for reflection
- Location-based project reminders
## Integration Examples
### Calendar Integration
```markdown
## Today's Events
<!-- Embed calendar events -->
![[calendar-sync/{{date}}.md]]
```
### Email Integration
```markdown
## Inbox Processing
- [ ] Email from: [sender] Re: [subject]
- Action: [Reply/Archive/Delegate]
```
### Task Manager Sync
```markdown
## External Tasks
<!-- Pulled from Todoist/Things/etc -->
- [ ] [Task from external system]
```
## Best Practices
### Start Simple
1. Begin with minimal customization
2. Add complexity as patterns emerge
3. Review and refine monthly
### Document Your System
Create `vault/System Documentation.md`:
```markdown
# My PKM System Rules
## File Naming
- Daily notes: YYYY-MM-DD.md
- Projects: PascalCase
- Resources: lowercase-with-dashes
## My Workflows
- Morning: ...
- Weekly: ...
- Monthly: ...
## My Conventions
- Tags: ...
- Links: ...
- Templates: ...
```
### Regular Reviews
- Weekly: Adjust templates based on use
- Monthly: Review folder structure
- Quarterly: Major system updates
- Yearly: Complete system overhaul
---
Remember: The goal is a system that works for YOU. Don't copy others blindly - adapt and evolve based on your actual needs and patterns.

334
docs/SETUP_GUIDE.md Normal file
View File

@@ -0,0 +1,334 @@
# Complete Setup Guide
This guide will walk you through setting up your Obsidian + Claude Code PKM system step by step. Total time: ~30 minutes.
## Prerequisites Checklist
Before starting, ensure you have:
- [ ] **Obsidian** installed ([Download here](https://obsidian.md/))
- [ ] **Git** installed ([Download here](https://git-scm.com/))
- [ ] **Claude Code CLI** installed ([Instructions](https://docs.anthropic.com/en/docs/claude-code))
- [ ] **GitHub account** (optional, for sync) ([Sign up](https://github.com))
- [ ] **Text editor** (for configuration files)
### Verify Prerequisites
Open terminal/command prompt and run:
```bash
# Check Git
git --version
# Check Claude Code
claude --version
```
## Phase 1: Initial Setup (5 minutes)
### Step 1: Clone the Repository
```bash
# Option A: If you have git
git clone https://github.com/yourusername/obsidian-claude-pkm.git
cd obsidian-claude-pkm
# Option B: Download ZIP
# 1. Download from GitHub
# 2. Extract to your desired location
```
### Step 2: Run Setup Script
```bash
# Make script executable (Mac/Linux)
chmod +x scripts/setup.sh
# Run setup
./scripts/setup.sh
# For Windows, use:
# scripts\setup.bat
```
The setup script will:
1. Ask for your vault location preference
2. Copy the vault template
3. Set up Claude commands
4. Initialize git (if desired)
### Step 3: Manual Setup (if script fails)
```bash
# Copy vault template to your preferred location
cp -r vault-template ~/Documents/MyPKM
# The .claude/commands directory is already included in the template
# Verify commands are present
ls ~/Documents/MyPKM/.claude/commands/
# Initialize git
cd ~/Documents/MyPKM
git init
```
## Phase 2: Open in Obsidian (5 minutes)
### Step 1: Open Obsidian
1. Launch Obsidian
2. Click "Open folder as vault"
3. Navigate to your vault folder
4. Click "Select"
### Step 2: Trust and Enable
When prompted:
- Click "Trust author and enable plugins" (if you added community plugins)
- This is safe for the template vault
### Step 3: Initial Exploration
1. Open `CLAUDE.md` in the root
2. Read through the structure
3. Explore the Goals folder
4. Check out the example daily note
### Step 4: Basic Settings (Optional)
1. Settings → Appearance → Choose theme
2. Settings → Editor → Set your preferences
3. Settings → Files & Links → Confirm settings:
- Default location for new notes: "Daily Notes"
- New link format: "Relative path to file"
## Phase 3: Claude Code Integration (10 minutes)
### Step 1: Configure Claude Code
```bash
# Navigate to your vault
cd ~/Documents/MyPKM
# Initialize Claude Code
claude init
# Test the connection
claude "Hello, I'm setting up my PKM system"
```
### Step 2: Set Up Commands
```bash
# The commands should already be in .claude/commands/
# Verify they exist:
ls .claude/commands/
# You should see:
# daily.md weekly.md push.md onboard.md
```
### Step 3: Test Commands
```bash
# Load your context
claude code /onboard
# Create your first daily note
claude code /daily
# You should see a new file in Daily Notes/
```
### Step 4: Customize Context
Edit `CLAUDE.md` in your vault root:
1. Add your personal mission statement
2. Define your working preferences
3. Set your current focus areas
4. Add any specific instructions for Claude
## Phase 4: Git Setup (5 minutes)
### Step 1: Initialize Repository
```bash
# If not already initialized
git init
# Configure git
git config user.name "Your Name"
git config user.email "your.email@example.com"
# Add all files
git add .
# First commit
git commit -m "Initial PKM setup"
```
### Step 2: Create GitHub Repository
```bash
# Using GitHub CLI (if installed)
gh repo create my-pkm --private
# Or create manually on GitHub.com
# Then add remote:
git remote add origin https://github.com/yourusername/my-pkm.git
# Push to GitHub
git push -u origin main
```
### Step 3: Set Up GitHub Action (Optional)
1. Copy the workflow file:
```bash
mkdir -p .github/workflows
cp github-actions/claude.yml .github/workflows/
```
2. Get Claude Code OAuth token:
- Visit: https://docs.anthropic.com/en/docs/claude-code/github-actions
- Follow instructions to get token
3. Add token to GitHub:
- Go to your repository on GitHub
- Settings → Secrets and variables → Actions
- New repository secret
- Name: `CLAUDE_CODE_OAUTH_TOKEN`
- Value: [Your token]
## Phase 5: Personalization (10 minutes)
### Step 1: Customize Your Mission
Edit `vault-template/CLAUDE.md`:
```markdown
## 🎯 System Purpose
[Replace with your personal mission]
```
### Step 2: Set Your Goals
1. Open `Goals/0. Three Year Goals.md`
2. Replace placeholder goals with your actual 3-year vision
3. Open `Goals/1. Yearly Goals.md`
4. Set your annual objectives
5. Open `Goals/2. Monthly Goals.md`
6. Define this month's priorities
### Step 3: Customize Daily Template
Edit `Templates/Daily Template.md`:
1. Add your personal mission statement at the top
2. Adjust time blocks to match your schedule
3. Modify task categories to fit your life
4. Add/remove sections as needed
### Step 4: Create Your First Project
```bash
# Using Claude
claude code "Create a new project folder for [Your Project Name]"
# Or manually
1. Create folder in Projects/
2. Copy CLAUDE.md template
3. Define project goals
```
## Verification Checklist
Run through this checklist to ensure everything is working:
- [ ] Obsidian opens your vault without errors
- [ ] CLAUDE.md has your personalized content
- [ ] `/daily` command creates today's note
- [ ] `/onboard` command loads your context
- [ ] Git commits work locally
- [ ] GitHub remote is connected (if using)
- [ ] Goals files have your objectives
- [ ] Daily template has your customizations
## Daily Workflow
### Morning Routine (5 minutes)
```bash
# Start your day
claude code /onboard
claude code /daily
# Claude will:
# - Create today's note
# - Review yesterday's tasks
# - Help plan your day
```
### Evening Routine (5 minutes)
```bash
# End of day
# Complete reflection in daily note
claude code /push
# This saves everything to git
```
### Weekly Review (30 minutes)
```bash
# Sunday evening or Monday morning
claude code /weekly
# Follow the guided review process
```
## Troubleshooting
### Obsidian Won't Open Vault
- Check folder permissions
- Ensure path has no special characters
- Try creating fresh vault and copying files
### Claude Commands Not Working
```bash
# Verify Claude Code installation
claude --version
# Check command files exist
ls -la .claude/commands/
# Try running directly
claude code < .claude/commands/daily.md
```
### Git Issues
```bash
# If push fails
git pull --rebase origin main
git push
# If large files cause issues
git lfs track "*.pdf"
git lfs track "*.png"
```
### Daily Note Not Created
- Check date format in template
- Verify Templates folder exists
- Ensure template file is named correctly
## Next Steps
1. **Read** [CUSTOMIZATION.md](CUSTOMIZATION.md) for advanced configuration
2. **Explore** [WORKFLOW_EXAMPLES.md](WORKFLOW_EXAMPLES.md) for usage patterns
3. **Join** the community (if available) for tips and support
4. **Iterate** on your system - it should evolve with you
## Getting Help
- **Documentation**: Check the docs/ folder
- **Claude Code Help**: `claude --help`
- **Obsidian Help**: [Obsidian Forum](https://forum.obsidian.md/)
- **Git Help**: [Git Documentation](https://git-scm.com/doc)
---
Congratulations! Your PKM system is now ready. Remember: the best system is the one you actually use. Start simple, be consistent, and evolve as needed.
**Pro Tip**: Spend the first week just using daily notes. Add complexity gradually as habits form.

509
docs/TROUBLESHOOTING.md Normal file
View File

@@ -0,0 +1,509 @@
# Troubleshooting Guide
Common issues and their solutions. If you can't find your issue here, check the community forums or documentation.
## Quick Fixes
### Before Anything Else, Try These:
1. **Restart Obsidian**
- Completely close and reopen
- Many issues resolve with a fresh start
2. **Check File Permissions**
```bash
ls -la ~/YourVault
# Should show your user as owner
```
3. **Verify Claude Code**
```bash
claude --version
# Should show version number
```
4. **Pull Latest Changes**
```bash
git pull origin main
# Get any updates
```
## Common Issues
### Obsidian Issues
#### "Cannot open vault" Error
**Problem**: Obsidian won't open your vault folder
**Solutions**:
1. Check folder exists:
```bash
cd ~/Documents/YourVault
ls -la
```
2. Reset Obsidian settings:
```bash
# Backup first
mv .obsidian .obsidian.backup
# Restart Obsidian
```
3. Check for corrupted files:
```bash
# Find files with issues
find . -name "*.md" -exec file {} \; | grep -v "ASCII text"
```
#### Templates Not Working
**Problem**: Daily template doesn't create properly
**Solutions**:
1. Verify template location:
```
Templates/Daily Template.md should exist
```
2. Check template settings:
- Settings → Templates
- Template folder location: "Templates"
3. Check date format:
```markdown
{{date}} and {{time}} should work
```
#### Links Not Working
**Problem**: [[Wiki links]] don't connect
**Solutions**:
1. Check link format in settings:
- Settings → Files & Links
- Use [[Wiki Links]]: ON
- New link format: Relative path
2. Verify file exists:
- Broken links appear faded
- Click to create missing file
### Claude Code Issues
#### "Command not found: claude"
**Problem**: Claude Code CLI not installed or not in PATH
**Solutions**:
1. Install Claude Code:
```bash
# Check installation guide
# https://docs.anthropic.com/en/docs/claude-code
```
2. Add to PATH:
```bash
# Add to ~/.bashrc or ~/.zshrc
export PATH="$PATH:/path/to/claude"
source ~/.bashrc
```
#### Commands Not Recognized
**Problem**: /daily, /weekly etc. not working
**Solutions**:
1. Check command files exist:
```bash
ls -la .claude/commands/
# Should show daily.md, weekly.md, etc.
```
2. Copy commands if missing:
```bash
cp claude-commands/* .claude/commands/
```
3. Check file permissions:
```bash
chmod 644 .claude/commands/*.md
```
#### "Context too long" Error
**Problem**: Too many files loaded with /onboard
**Solutions**:
1. Load specific context:
```bash
claude code /onboard Projects/CurrentProject
```
2. Clean up CLAUDE.md files:
- Remove outdated information
- Keep only essential context
3. Use selective loading:
```bash
# Skip old projects
claude code /onboard --exclude Archives
```
### Git Issues
#### "Failed to push" Error
**Problem**: Can't push to GitHub
**Solutions**:
1. Pull first:
```bash
git pull --rebase origin main
git push
```
2. Check remote:
```bash
git remote -v
# Should show origin URLs
```
3. Fix authentication:
```bash
# Use personal access token
git remote set-url origin https://TOKEN@github.com/user/repo.git
```
#### Merge Conflicts
**Problem**: Conflicts when pulling/pushing
**Solutions**:
1. View conflicts:
```bash
git status
# Shows conflicted files
```
2. Resolve manually:
- Open conflicted files
- Look for <<<<<<< markers
- Choose correct version
- Remove markers
3. Complete merge:
```bash
git add .
git commit -m "Resolved conflicts"
git push
```
#### Large File Issues
**Problem**: Git rejects large files
**Solutions**:
1. Use Git LFS:
```bash
git lfs track "*.pdf"
git lfs track "*.png"
git add .gitattributes
```
2. Add to .gitignore:
```
*.pdf
*.mov
*.zip
```
3. Remove from history:
```bash
git filter-branch --tree-filter 'rm -f path/to/large/file' HEAD
```
### Daily Note Issues
#### Wrong Date Format
**Problem**: Daily note has incorrect date
**Solutions**:
1. Check template variables:
```markdown
{{date:YYYY-MM-DD}} # Standard format
{{date:dddd, MMMM DD, YYYY}} # Long format
```
2. Verify system date:
```bash
date
# Should show correct date/time
```
3. Set timezone:
```bash
export TZ='America/New_York'
```
#### Duplicate Daily Notes
**Problem**: Multiple notes for same day
**Solutions**:
1. Check naming convention:
- Should be YYYY-MM-DD.md
- No spaces or special characters
2. Merge duplicates:
```bash
# Copy content from duplicate
# Paste into main note
# Delete duplicate
```
3. Prevent future duplicates:
- Always use /daily command
- Don't create manually
### GitHub Action Issues
#### Workflow Not Triggering
**Problem**: GitHub Action doesn't run
**Solutions**:
1. Check workflow file:
```yaml
# .github/workflows/claude.yml should exist
```
2. Verify triggers:
```yaml
on:
issues:
types: [opened, edited]
```
3. Check Actions enabled:
- Repository → Settings → Actions
- Actions permissions: Allow
#### OAuth Token Invalid
**Problem**: CLAUDE_CODE_OAUTH_TOKEN not working
**Solutions**:
1. Regenerate token:
- Visit Claude Code documentation
- Follow OAuth setup guide
2. Update secret:
- Repository → Settings → Secrets
- Update CLAUDE_CODE_OAUTH_TOKEN
3. Check token permissions:
- Needs repo access
- Needs workflow access
### Performance Issues
#### Obsidian Running Slowly
**Problem**: Vault takes long to load or respond
**Solutions**:
1. Reduce vault size:
```bash
# Archive old notes
mv "Daily Notes/2023*" Archives/2023/
```
2. Disable unused plugins:
- Settings → Community plugins
- Disable what you don't use
3. Clear cache:
```bash
rm -rf .obsidian/cache
```
4. Optimize images:
```bash
# Compress images
find . -name "*.png" -exec pngquant --ext .png --force {} \;
```
#### Search Not Working
**Problem**: Can't find notes with search
**Solutions**:
1. Rebuild search index:
- Settings → About → Reindex vault
2. Check search syntax:
```
"exact phrase"
tag:#daily
file:2024-01-15
```
3. Remove special characters from filenames
## Platform-Specific Issues
### macOS
#### "Operation not permitted"
```bash
# Grant Obsidian full disk access
System Preferences → Security & Privacy → Full Disk Access
```
#### iCloud Sync Issues
- Don't put vault in iCloud Drive
- Use Git for synchronization instead
- Or use Obsidian Sync service
### Windows
#### Path Too Long
```powershell
# Enable long paths
New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
```
#### Line Ending Issues
```bash
# Configure Git
git config --global core.autocrlf true
```
### Linux
#### Permission Denied
```bash
# Fix permissions
chmod -R 755 ~/YourVault
chown -R $USER:$USER ~/YourVault
```
#### Missing Dependencies
```bash
# Install required packages
sudo apt-get update
sudo apt-get install git curl
```
## Recovery Procedures
### Restore from Backup
#### Using Git
```bash
# View history
git log --oneline
# Restore to previous commit
git reset --hard COMMIT_HASH
# Or restore single file
git checkout COMMIT_HASH -- path/to/file.md
```
#### Using File System
```bash
# If you have Time Machine (macOS)
# Or File History (Windows)
# Or Backups (Linux)
```
### Rebuild Vault
If vault is corrupted:
```bash
# 1. Backup current vault
cp -r ~/YourVault ~/YourVault.backup
# 2. Create fresh vault
cp -r vault-template ~/NewVault
# 3. Copy your notes
cp -r ~/YourVault.backup/Daily\ Notes/* ~/NewVault/Daily\ Notes/
cp -r ~/YourVault.backup/Projects/* ~/NewVault/Projects/
# 4. Reinitialize Git
cd ~/NewVault
git init
git add .
git commit -m "Rebuilt vault"
```
### Emergency Access
When locked out:
1. Access via GitHub.com
2. Edit files in browser
3. Download as ZIP if needed
4. Use mobile app as backup
## Preventive Measures
### Regular Maintenance
#### Weekly
```bash
# Clean up
claude code "Archive completed tasks and old notes"
# Backup
git push origin main
```
#### Monthly
```bash
# Optimize
claude code "Identify and remove duplicate content"
# Update
git pull origin main
```
#### Quarterly
```bash
# Review system
claude code "Analyze vault structure and suggest improvements"
# Clean dependencies
rm -rf node_modules .obsidian/cache
```
### Backup Strategy
1. **Version Control**: Git commits daily
2. **Cloud Backup**: GitHub private repo
3. **Local Backup**: Time Machine/File History
4. **Export Backup**: Monthly markdown export
## Getting Help
### Resources
- [Obsidian Forum](https://forum.obsidian.md/)
- [Claude Code Docs](https://docs.anthropic.com/en/docs/claude-code)
- [GitHub Issues](https://github.com/yourusername/obsidian-claude-pkm/issues)
### Debug Information
When asking for help, provide:
```bash
# System info
uname -a
# Obsidian version
# (Check in Settings → About)
# Claude version
claude --version
# Git status
git status
git remote -v
# Vault structure
ls -la ~/YourVault
```
### Community Support
- Discord channels
- Reddit: r/ObsidianMD
- Twitter: #ObsidianMD
---
**Remember**: Most issues have simple solutions. Stay calm, check the basics, and work through systematically.

471
docs/WORKFLOW_EXAMPLES.md Normal file
View File

@@ -0,0 +1,471 @@
# Workflow Examples
Real-world scenarios showing how to use your PKM system effectively throughout your day, week, and projects.
## Daily Workflows
### Morning Routine (15 minutes)
#### 6:00 AM - Wake Up
```bash
# First, load your context
claude code /onboard
# Create today's daily note
claude code /daily
```
#### 6:05 AM - Review and Plan
Claude helps you:
1. Review yesterday's incomplete tasks
2. Check calendar for fixed commitments
3. Identify ONE big priority
4. Set realistic time blocks
#### 6:10 AM - Set Intentions
```markdown
## Today's Focus
**ONE Thing:** Complete project proposal
## Intentions
- Be present in meetings
- Take breaks every 90 minutes
- End work by 6 PM
```
#### 6:15 AM - Ready to Start
```bash
# Optional: Get motivation
claude code "Give me a motivational quote related to my current goals"
```
### Midday Check-in (5 minutes)
#### 12:00 PM - Progress Review
```markdown
## Midday Check
- ✅ Completed: 4/8 tasks
- 🔄 In Progress: Project proposal (70%)
- ⚡ Energy Level: 7/10
- 🎯 Afternoon Focus: Client meeting prep
```
### Evening Shutdown (10 minutes)
#### 5:30 PM - Wrap Up
1. Check off completed tasks
2. Note incomplete items and why
3. Capture any loose thoughts
#### 5:35 PM - Reflect
```markdown
## End of Day Reflection
### What Went Well?
- Finished proposal ahead of schedule
- Great breakthrough on design problem
### What Could Be Better?
- Too many context switches
- Skipped lunch break
### Tomorrow's #1 Priority
- Review proposal with team
```
#### 5:40 PM - Save and Sync
```bash
claude code /push "Daily work complete - {{date}}"
```
## Weekly Workflows
### Sunday Weekly Review (30 minutes)
#### Step 1: Create Review (5 min)
```bash
claude code /weekly
```
#### Step 2: Review Last Week (10 min)
Go through each daily note:
```bash
claude code "Summarize my accomplishments from the past week's daily notes"
```
Look for patterns:
- What times was I most productive?
- What derailed my plans?
- What victories can I celebrate?
#### Step 3: Plan Next Week (10 min)
```markdown
## Next Week's Plan
### ONE Big Thing
If nothing else, I will: [Complete Q1 report]
### Key Projects
1. **Project Alpha** - Milestone: Design review
2. **Learning Spanish** - Goal: Complete Chapter 4
3. **Health** - Target: 4 workouts
### Calendar Blocks
- Mon 9-11 AM: Deep work on report
- Wed 2-4 PM: Team planning
- Fri 3-5 PM: Weekly review & planning
```
#### Step 4: Clean Up (5 min)
```bash
# Archive old notes
claude code "Move daily notes older than 30 days to Archives"
# Update project statuses
claude code "Review all active projects and update their status"
# Commit everything
claude code /push "Weekly review complete - Week {{week_number}}"
```
### Monthly Review (1 hour)
#### First Sunday of Month
```bash
# Load full context
claude code /onboard all
# Create monthly review
claude code "Create a monthly review analyzing my progress toward yearly goals"
```
Review Process:
1. **Quantitative Analysis** (20 min)
- Count completed tasks
- Measure goal progress
- Track habit consistency
2. **Qualitative Reflection** (20 min)
- What themes emerged?
- What surprised you?
- What patterns need attention?
3. **Planning Adjustment** (20 min)
- Update monthly goals
- Revise project priorities
- Adjust daily routines
## Project Workflows
### Starting a New Project
#### Step 1: Create Structure
```bash
claude code "Create a new project called 'Website Redesign' with standard structure"
```
#### Step 2: Define Success
```markdown
# Project: Website Redesign
## Success Criteria
1. New design live by March 1
2. Page load time < 2 seconds
3. Mobile-first responsive design
4. Accessibility score > 95
## Milestones
- [ ] Week 1: Requirements gathered
- [ ] Week 2: Wireframes complete
- [ ] Week 3: Design approved
- [ ] Week 4: Development started
```
#### Step 3: Create Project CLAUDE.md
```markdown
# Context for Claude: Website Redesign
## Project Status
Currently in planning phase
## Key Decisions
- Using React + Next.js
- Hosting on Vercel
- Design system: Tailwind
## When Helping
- Remind me about accessibility
- Suggest performance optimizations
- Keep mobile-first in mind
```
### Daily Project Work
#### Starting Project Time
```bash
# Load project context
claude code /onboard Projects/WebsiteRedesign
# Get oriented
claude code "What should I focus on for this project today?"
```
#### During Work
```markdown
## Project Log - {{date}}
### What I Did
- Completed wireframes for homepage
- Reviewed competitor sites
- Met with stakeholder
### Decisions Made
- Go with single-page design
- Use system fonts for speed
### Next Steps
- Get design feedback
- Start component library
```
#### Project Check-in
```bash
claude code "Review my project progress and suggest next priorities"
```
### Completing a Project
#### Project Closure
```bash
# Generate project summary
claude code "Create a project completion summary with lessons learned"
# Archive project
claude code "Move 'Website Redesign' project to Archives with completion date"
# Update goals
claude code "Update my monthly and yearly goals to reflect project completion"
```
## Learning Workflows
### Daily Learning Routine
#### Morning Learning (30 min)
```markdown
## Today's Learning
### Topic: Spanish Subjunctive
### Resource: Chapter 4, pages 45-50
### Practice: 10 exercises
### Notes
- Subjunctive used for doubts/emotions
- Trigger phrases: "Es posible que..."
- Common mistake: Using indicative instead
### Anki Cards Created: 5
```
#### Evening Review (15 min)
```bash
claude code "Quiz me on what I learned today about Spanish subjunctive"
```
### Book Reading Workflow
#### Starting a Book
```bash
claude code "Create a literature note for 'Atomic Habits' by James Clear"
```
#### While Reading
```markdown
## Atomic Habits - Reading Notes
### Chapter 2: How Habits Shape Identity
**Key Idea**: Focus on who you want to become, not what you want to achieve
**Quote**: "Every action is a vote for the type of person you wish to become"
**Personal Application**: Instead of "I want to write", say "I am a writer"
**Questions**:
- How does this apply to my Spanish learning?
- What identity am I reinforcing with daily notes?
```
#### After Finishing
```bash
claude code "Create a book summary and extract actionable insights from my Atomic Habits notes"
```
## Mobile Workflows
### On-the-Go Task Capture
#### Via GitHub Issues
1. Open GitHub mobile app
2. Create issue with title: "Task: [Description]"
3. Add label: "task"
4. Claude automatically adds to daily note
#### Via Voice Note
1. Record voice memo
2. Share to GitHub as issue
3. Claude transcribes and processes
### Mobile Weekly Review
#### From Phone
1. Open GitHub mobile
2. Review recent commits
3. Create issue: "Weekly review needed"
4. Claude generates review template
### Emergency Access
#### When Desktop Unavailable
```
1. Access GitHub.com from any browser
2. Navigate to your vault repository
3. Edit files directly in browser
4. Changes sync when back at desktop
```
## Integration Workflows
### Email to Tasks
#### Morning Email Processing
```markdown
## Inbox Processing - {{time}}
- [ ] Reply: John re: Project timeline
- [ ] Action: Submit expense report (attachment)
- [ ] Read: Newsletter from industry blog
- [ ] Archive: 15 promotional emails
```
### Meeting Notes
#### Before Meeting
```bash
claude code "Create meeting note for 'Design Review' with standard agenda"
```
#### During Meeting
```markdown
## Design Review - {{date}} 2:00 PM
### Attendees
- Me, Sarah, Tom, Lisa
### Agenda
1. Review current designs ✅
2. Discuss feedback ✅
3. Next steps ⏸️
### Notes
- Sarah: Likes color scheme, worried about contrast
- Tom: Performance concerns with animations
- Lisa: Accessibility audit needed
### Action Items
- [ ] @Me: Update color contrast
- [ ] @Tom: Performance testing
- [ ] @Lisa: Schedule accessibility review
```
#### After Meeting
```bash
claude code "Extract action items from meeting notes and add to my task list"
```
## Advanced Workflows
### Goal Cascade Review
#### Quarterly Alignment
```bash
claude code "Analyze how my daily tasks over the past quarter aligned with my yearly goals"
```
Output shows:
- Time spent per goal area
- Progress metrics
- Misalignment areas
- Recommendations
### Habit Tracking Analysis
#### Monthly Habit Review
```bash
claude code "Analyze my habit completion rates and identify patterns"
```
Shows:
- Completion percentages
- Best/worst days
- Correlation with energy levels
- Suggested adjustments
### Knowledge Graph Building
#### Connecting Ideas
```bash
claude code "Find connections between my recent learning notes and suggest knowledge links"
```
Creates:
- Concept maps
- Related note suggestions
- Knowledge gaps identified
- Learning path recommendations
## Troubleshooting Workflows
### When Overwhelmed
```bash
claude code "I'm overwhelmed. Help me identify my top 3 priorities from all my commitments"
```
### When Stuck
```bash
claude code "I'm stuck on [problem]. Review my notes and suggest approaches"
```
### When Behind
```bash
claude code "I'm behind on my goals. Create a recovery plan for the next 2 weeks"
```
## Seasonal Workflows
### Year-End Review
```bash
# December 31
claude code "Generate comprehensive year in review from all my daily notes"
```
### New Year Planning
```bash
# January 1
claude code "Based on last year's patterns, help me set realistic goals for this year"
```
### Spring Cleaning
```bash
# Quarterly
claude code "Identify and archive inactive projects and outdated notes"
```
---
## Tips for Workflow Success
1. **Start Small**: Master daily notes before adding complexity
2. **Be Consistent**: Same time, same process, every day
3. **Iterate Weekly**: Adjust what's not working
4. **Track Patterns**: Notice what helps or hinders
5. **Automate Gradually**: Add automation as patterns stabilize
Remember: Workflows should reduce friction, not add it. If something feels heavy, simplify it.