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
33
.gitignore
vendored
Normal file
33
.gitignore
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
# macOS
|
||||
.DS_Store
|
||||
.AppleDouble
|
||||
.LSOverride
|
||||
|
||||
# Obsidian
|
||||
.obsidian/workspace*
|
||||
.obsidian/cache
|
||||
.obsidian/hotkeys.json
|
||||
.obsidian/plugins/*/data.json
|
||||
.obsidian/workspace.json
|
||||
.obsidian/workspace-mobile.json
|
||||
|
||||
# Trash
|
||||
.trash/
|
||||
|
||||
# Claude Code
|
||||
.conductor/
|
||||
.claude/cache/
|
||||
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# Logs
|
||||
*.log
|
||||
|
||||
# Personal notes (users should add their own patterns)
|
||||
# private/
|
||||
# personal/
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Obsidian Claude PKM Contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
73
README.md
Normal file
73
README.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# Obsidian + Claude Code PKM Starter Kit 🚀
|
||||
|
||||
A complete personal knowledge management system that combines Obsidian's powerful note-taking with Claude Code's AI assistance. Go from zero to a fully functional PKM in under 30 minutes.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- **🎯 Goal-Aligned System** - Cascading goals from 3-year vision to daily tasks
|
||||
- **🤖 AI-Powered Workflows** - Claude Code integration for intelligent note management
|
||||
- **📅 Daily Notes System** - Structured daily planning and reflection
|
||||
- **📱 Mobile Ready** - GitHub integration for notes on any device
|
||||
- **🔄 Version Controlled** - Never lose a thought with automatic Git backups
|
||||
- **⚡ Automated Commands** - Custom slash commands for common workflows
|
||||
- **🎨 Fully Customizable** - Adapt templates and structure to your needs
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Prerequisites
|
||||
- [Obsidian](https://obsidian.md/) installed
|
||||
- [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) installed
|
||||
- Git installed
|
||||
- GitHub account (optional, for mobile sync)
|
||||
|
||||
### Setup (5 minutes)
|
||||
```bash
|
||||
# Clone this repository
|
||||
git clone https://github.com/yourusername/obsidian-claude-pkm.git
|
||||
cd obsidian-claude-pkm
|
||||
|
||||
# Run the setup script
|
||||
./scripts/setup.sh
|
||||
|
||||
# Or manually copy the vault template
|
||||
cp -r vault-template ~/Documents/MyVault
|
||||
```
|
||||
|
||||
### Open in Obsidian
|
||||
1. Launch Obsidian
|
||||
2. Click "Open folder as vault"
|
||||
3. Select your vault folder
|
||||
4. Start with today's daily note!
|
||||
|
||||
## 📖 Documentation
|
||||
|
||||
- **[Setup Guide](docs/SETUP_GUIDE.md)** - Detailed installation instructions
|
||||
- **[Customization](docs/CUSTOMIZATION.md)** - Make it yours
|
||||
- **[Workflow Examples](docs/WORKFLOW_EXAMPLES.md)** - Daily routines and best practices
|
||||
- **[Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues and solutions
|
||||
|
||||
## 🗂️ Structure
|
||||
|
||||
```
|
||||
Your Vault/
|
||||
├── CLAUDE.md # AI context and navigation
|
||||
├── .claude/
|
||||
│ └── commands/ # Custom slash commands
|
||||
├── Daily Notes/ # Your daily journal
|
||||
├── Goals/ # Cascading goal system
|
||||
├── Projects/ # Active project folders
|
||||
├── Templates/ # Reusable note templates
|
||||
└── Archives/ # Historical content
|
||||
```
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Found a bug or have a feature idea? Please open an issue or submit a PR!
|
||||
|
||||
## 📄 License
|
||||
|
||||
MIT - Use this freely for your personal knowledge management journey.
|
||||
|
||||
---
|
||||
|
||||
**Ready to transform your note-taking?** Follow the [Setup Guide](docs/SETUP_GUIDE.md) to get started!
|
||||
549
docs/CUSTOMIZATION.md
Normal file
549
docs/CUSTOMIZATION.md
Normal 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
334
docs/SETUP_GUIDE.md
Normal 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
509
docs/TROUBLESHOOTING.md
Normal 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
471
docs/WORKFLOW_EXAMPLES.md
Normal 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.
|
||||
287
github-actions/claude.yml
Normal file
287
github-actions/claude.yml
Normal file
@@ -0,0 +1,287 @@
|
||||
# GitHub Action for Claude Code Integration
|
||||
#
|
||||
# This workflow enables Claude Code to automatically process GitHub issues
|
||||
# and pull requests, allowing you to manage your PKM from anywhere.
|
||||
#
|
||||
# SETUP INSTRUCTIONS:
|
||||
# 1. Copy this file to .github/workflows/claude.yml in your vault repository
|
||||
# 2. Get your Claude Code OAuth token from: https://docs.anthropic.com/en/docs/claude-code/github-actions
|
||||
# 3. Add the token as a secret in your repository:
|
||||
# - Go to Settings > Secrets and variables > Actions
|
||||
# - Click "New repository secret"
|
||||
# - Name: CLAUDE_CODE_OAUTH_TOKEN
|
||||
# - Value: [Your token from step 2]
|
||||
# 4. Configure the workflow triggers below as needed
|
||||
|
||||
name: Claude Code PKM Assistant
|
||||
|
||||
# When this workflow runs
|
||||
on:
|
||||
# Trigger when issues are opened or edited
|
||||
issues:
|
||||
types: [opened, edited]
|
||||
|
||||
# Trigger when issue comments are created
|
||||
issue_comment:
|
||||
types: [created]
|
||||
|
||||
# Trigger when pull requests are opened
|
||||
pull_request:
|
||||
types: [opened, edited]
|
||||
|
||||
# Allow manual trigger from GitHub Actions tab
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
command:
|
||||
description: 'Claude command to run'
|
||||
required: false
|
||||
default: '/daily'
|
||||
type: choice
|
||||
options:
|
||||
- '/daily'
|
||||
- '/weekly'
|
||||
- '/onboard'
|
||||
- '/push'
|
||||
|
||||
# Optional: Run on schedule (uncomment to enable)
|
||||
# schedule:
|
||||
# # Run daily at 6 AM UTC
|
||||
# - cron: '0 6 * * *'
|
||||
# # Run weekly review on Sundays at 8 PM UTC
|
||||
# - cron: '0 20 * * 0'
|
||||
|
||||
# Environment variables
|
||||
env:
|
||||
# Claude Code version to use
|
||||
CLAUDE_CODE_VERSION: 'latest'
|
||||
|
||||
# Default model for Claude to use
|
||||
# Options: claude-3-opus, claude-3-sonnet, claude-3-haiku
|
||||
CLAUDE_MODEL: 'claude-3-sonnet'
|
||||
|
||||
# Timezone for date/time operations (customize this)
|
||||
TZ: 'America/New_York'
|
||||
|
||||
jobs:
|
||||
# Job: Process GitHub Issues as Tasks
|
||||
process-issue:
|
||||
name: Process Issue with Claude
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
# Only run on issues with specific labels
|
||||
if: |
|
||||
github.event_name == 'issues' &&
|
||||
(contains(github.event.issue.labels.*.name, 'task') ||
|
||||
contains(github.event.issue.labels.*.name, 'idea') ||
|
||||
contains(github.event.issue.labels.*.name, 'claude'))
|
||||
|
||||
steps:
|
||||
# Check out the repository
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
# Set up Claude Code
|
||||
- name: Setup Claude Code
|
||||
uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
oauth-token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||
version: ${{ env.CLAUDE_CODE_VERSION }}
|
||||
|
||||
# Process the issue
|
||||
- name: Process Issue Content
|
||||
run: |
|
||||
# Extract issue details
|
||||
ISSUE_TITLE="${{ github.event.issue.title }}"
|
||||
ISSUE_BODY="${{ github.event.issue.body }}"
|
||||
ISSUE_NUMBER="${{ github.event.issue.number }}"
|
||||
|
||||
# Determine action based on labels
|
||||
if [[ "${{ contains(github.event.issue.labels.*.name, 'task') }}" == "true" ]]; then
|
||||
# Add task to today's daily note
|
||||
claude code "Add this task to today's daily note: $ISSUE_TITLE - $ISSUE_BODY"
|
||||
elif [[ "${{ contains(github.event.issue.labels.*.name, 'idea') }}" == "true" ]]; then
|
||||
# Capture idea in appropriate location
|
||||
claude code "Capture this idea in the appropriate project or notes: $ISSUE_TITLE - $ISSUE_BODY"
|
||||
fi
|
||||
|
||||
# Comment on issue to confirm processing
|
||||
gh issue comment $ISSUE_NUMBER --body "✅ Processed by Claude Code and added to vault"
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
# Commit and push changes
|
||||
- name: Commit Changes
|
||||
run: |
|
||||
git config --local user.email "claude-bot@example.com"
|
||||
git config --local user.name "Claude Assistant"
|
||||
git add .
|
||||
git diff --staged --quiet || git commit -m "Process issue #${{ github.event.issue.number }}: ${{ github.event.issue.title }}"
|
||||
git push
|
||||
|
||||
# Job: Daily Note Creation
|
||||
daily-note:
|
||||
name: Create Daily Note
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
# Run on schedule or manual trigger
|
||||
if: |
|
||||
github.event_name == 'workflow_dispatch' &&
|
||||
github.event.inputs.command == '/daily'
|
||||
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Setup Claude Code
|
||||
uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
oauth-token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||
|
||||
- name: Create Daily Note
|
||||
run: |
|
||||
# Load context
|
||||
claude code /onboard
|
||||
|
||||
# Create today's daily note
|
||||
claude code /daily
|
||||
|
||||
# Optional: Add weather, calendar events, etc.
|
||||
# claude code "Add today's weather forecast to the daily note"
|
||||
# claude code "Add calendar events for today"
|
||||
|
||||
- name: Commit Daily Note
|
||||
run: |
|
||||
git config --local user.email "claude-bot@example.com"
|
||||
git config --local user.name "Claude Assistant"
|
||||
git add .
|
||||
DATE=$(date +%Y-%m-%d)
|
||||
git diff --staged --quiet || git commit -m "Daily note for $DATE"
|
||||
git push
|
||||
|
||||
# Job: Weekly Review
|
||||
weekly-review:
|
||||
name: Run Weekly Review
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
# Run on Sundays or manual trigger
|
||||
if: |
|
||||
(github.event_name == 'schedule' && contains(github.event.schedule, '0 20 * * 0')) ||
|
||||
(github.event_name == 'workflow_dispatch' && github.event.inputs.command == '/weekly')
|
||||
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Setup Claude Code
|
||||
uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
oauth-token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||
|
||||
- name: Run Weekly Review
|
||||
run: |
|
||||
# Load full context
|
||||
claude code /onboard all
|
||||
|
||||
# Run weekly review
|
||||
claude code /weekly
|
||||
|
||||
# Generate summary
|
||||
claude code "Create a summary of this week's accomplishments and next week's priorities"
|
||||
|
||||
- name: Commit Weekly Review
|
||||
run: |
|
||||
git config --local user.email "claude-bot@example.com"
|
||||
git config --local user.name "Claude Assistant"
|
||||
git add .
|
||||
WEEK=$(date +%Y-W%V)
|
||||
git diff --staged --quiet || git commit -m "Weekly review for $WEEK"
|
||||
git push
|
||||
|
||||
# Job: Smart Assistance on Pull Requests
|
||||
assist-pr:
|
||||
name: Assist with Pull Request
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
if: github.event_name == 'pull_request'
|
||||
|
||||
steps:
|
||||
- name: Checkout PR Branch
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.sha }}
|
||||
|
||||
- name: Setup Claude Code
|
||||
uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
oauth-token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||
|
||||
- name: Review Changes
|
||||
run: |
|
||||
# Get changed files
|
||||
CHANGED_FILES=$(git diff --name-only origin/main..HEAD)
|
||||
|
||||
# Have Claude review the changes
|
||||
claude code "Review these changed files and provide feedback: $CHANGED_FILES"
|
||||
|
||||
# Post review as PR comment
|
||||
gh pr comment ${{ github.event.pull_request.number }} \
|
||||
--body "$(claude code 'Summarize your review findings')"
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
# Workflow Configuration Notes:
|
||||
#
|
||||
# CUSTOMIZATION OPTIONS:
|
||||
#
|
||||
# 1. **Triggers**: Adjust the 'on' section to control when the workflow runs
|
||||
# - Remove triggers you don't need
|
||||
# - Add schedule triggers for automation
|
||||
# - Customize issue labels that trigger processing
|
||||
#
|
||||
# 2. **Claude Model**: Change CLAUDE_MODEL in env section
|
||||
# - claude-3-opus: Most capable, best for complex tasks
|
||||
# - claude-3-sonnet: Balanced performance
|
||||
# - claude-3-haiku: Fastest, good for simple tasks
|
||||
#
|
||||
# 3. **Time Zone**: Update TZ in env section to your local timezone
|
||||
#
|
||||
# 4. **Custom Commands**: Add new jobs for your specific workflows
|
||||
#
|
||||
# SECURITY NOTES:
|
||||
#
|
||||
# - Keep CLAUDE_CODE_OAUTH_TOKEN secret and never commit it
|
||||
# - Use GitHub's built-in GITHUB_TOKEN when possible
|
||||
# - Review permissions before enabling workflow
|
||||
# - Consider using environment protection rules for sensitive operations
|
||||
#
|
||||
# USAGE EXAMPLES:
|
||||
#
|
||||
# 1. **Create task from mobile**:
|
||||
# - Open GitHub mobile app
|
||||
# - Create new issue with 'task' label
|
||||
# - Claude adds it to your daily note
|
||||
#
|
||||
# 2. **Capture ideas on the go**:
|
||||
# - Create issue with 'idea' label
|
||||
# - Claude files it in appropriate project
|
||||
#
|
||||
# 3. **Remote daily planning**:
|
||||
# - Manually trigger workflow
|
||||
# - Select '/daily' command
|
||||
# - Claude creates daily note
|
||||
#
|
||||
# TROUBLESHOOTING:
|
||||
#
|
||||
# - Check Actions tab for workflow runs and logs
|
||||
# - Verify CLAUDE_CODE_OAUTH_TOKEN is set correctly
|
||||
# - Ensure repository has Actions enabled
|
||||
# - Check file permissions and paths
|
||||
#
|
||||
# For more information:
|
||||
# https://docs.anthropic.com/en/docs/claude-code/github-actions
|
||||
631
scripts/customize.sh
Executable file
631
scripts/customize.sh
Executable file
@@ -0,0 +1,631 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Obsidian PKM Customization Helper
|
||||
# This script helps you customize your PKM system interactively
|
||||
|
||||
set -e
|
||||
|
||||
# Colors
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
MAGENTA='\033[0;35m'
|
||||
CYAN='\033[0;36m'
|
||||
NC='\033[0m'
|
||||
|
||||
# Banner
|
||||
echo -e "${MAGENTA}"
|
||||
echo "╔═══════════════════════════════════════════════════╗"
|
||||
echo "║ PKM Customization Assistant ║"
|
||||
echo "║ Personalize Your System ║"
|
||||
echo "╚═══════════════════════════════════════════════════╝"
|
||||
echo -e "${NC}"
|
||||
|
||||
# Find vault directory
|
||||
if [ -f ".setup_complete" ]; then
|
||||
VAULT_PATH="$(pwd)"
|
||||
else
|
||||
read -p "Enter path to your vault: " VAULT_PATH
|
||||
VAULT_PATH="${VAULT_PATH/#\~/$HOME}"
|
||||
fi
|
||||
|
||||
if [ ! -d "$VAULT_PATH" ]; then
|
||||
echo -e "${RED}Error: Vault not found at $VAULT_PATH${NC}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
cd "$VAULT_PATH"
|
||||
|
||||
# Function to show menu
|
||||
show_menu() {
|
||||
echo -e "\n${CYAN}What would you like to customize?${NC}"
|
||||
echo "=================================="
|
||||
echo "1. Personal Mission & Values"
|
||||
echo "2. Goal System (3-year, yearly, monthly)"
|
||||
echo "3. Daily Note Template"
|
||||
echo "4. Weekly Review Process"
|
||||
echo "5. Tag System"
|
||||
echo "6. Time Blocks & Schedule"
|
||||
echo "7. Project Templates"
|
||||
echo "8. Claude Context (CLAUDE.md)"
|
||||
echo "9. Folder Structure"
|
||||
echo "10. Create Custom Command"
|
||||
echo "0. Exit"
|
||||
echo ""
|
||||
read -p "Choose an option (0-10): " choice
|
||||
}
|
||||
|
||||
# Function 1: Customize Mission
|
||||
customize_mission() {
|
||||
echo -e "\n${BLUE}Personal Mission & Values${NC}"
|
||||
echo "=========================="
|
||||
|
||||
echo "Your personal mission statement guides your daily decisions."
|
||||
echo "Example: 'Create value through technology while nurturing relationships'"
|
||||
echo ""
|
||||
read -p "Enter your mission statement: " MISSION
|
||||
|
||||
if [ -n "$MISSION" ]; then
|
||||
# Update files with mission
|
||||
for file in "CLAUDE.md" "Templates/Daily Template.md"; do
|
||||
if [ -f "$file" ]; then
|
||||
# Backup original
|
||||
cp "$file" "$file.bak"
|
||||
# Update mission (handling both macOS and Linux)
|
||||
if [[ "$OSTYPE" == "darwin"* ]]; then
|
||||
sed -i '' "1s/.*/_$MISSION_/" "$file"
|
||||
else
|
||||
sed -i "1s/.*/_$MISSION_/" "$file"
|
||||
fi
|
||||
fi
|
||||
done
|
||||
echo -e "${GREEN}✓ Mission statement updated${NC}"
|
||||
fi
|
||||
|
||||
echo -e "\n${BLUE}Core Values${NC}"
|
||||
echo "What are your top 3 values?"
|
||||
read -p "Value 1: " VALUE1
|
||||
read -p "Value 2: " VALUE2
|
||||
read -p "Value 3: " VALUE3
|
||||
|
||||
# Create values file
|
||||
cat > "Values.md" << EOF
|
||||
# My Core Values
|
||||
|
||||
## 1. $VALUE1
|
||||
Why this matters to me:
|
||||
|
||||
## 2. $VALUE2
|
||||
Why this matters to me:
|
||||
|
||||
## 3. $VALUE3
|
||||
Why this matters to me:
|
||||
|
||||
---
|
||||
*These values guide my decisions and priorities.*
|
||||
EOF
|
||||
|
||||
echo -e "${GREEN}✓ Values documented${NC}"
|
||||
}
|
||||
|
||||
# Function 2: Customize Goals
|
||||
customize_goals() {
|
||||
echo -e "\n${BLUE}Goal System Setup${NC}"
|
||||
echo "=================="
|
||||
|
||||
echo "Let's set up your cascading goals..."
|
||||
echo ""
|
||||
|
||||
# 3-Year Vision
|
||||
echo -e "${CYAN}3-Year Vision${NC}"
|
||||
echo "Where do you want to be in 3 years?"
|
||||
read -p "Career: " CAREER_3Y
|
||||
read -p "Health: " HEALTH_3Y
|
||||
read -p "Relationships: " RELATIONSHIP_3Y
|
||||
read -p "Financial: " FINANCIAL_3Y
|
||||
|
||||
# Update 3-year goals file
|
||||
cat > "Goals/0. Three Year Goals.md" << EOF
|
||||
# Three Year Goals ($(date +%Y)-$(($(date +%Y)+3)))
|
||||
|
||||
## 🌟 Vision Statement
|
||||
In three years, I will have achieved:
|
||||
|
||||
### 💼 Career & Professional Development
|
||||
- $CAREER_3Y
|
||||
|
||||
### 🏃 Health & Wellness
|
||||
- $HEALTH_3Y
|
||||
|
||||
### ❤️ Relationships & Family
|
||||
- $RELATIONSHIP_3Y
|
||||
|
||||
### 💰 Financial Security
|
||||
- $FINANCIAL_3Y
|
||||
|
||||
---
|
||||
*Created: $(date +%Y-%m-%d)*
|
||||
EOF
|
||||
|
||||
echo -e "${GREEN}✓ 3-year goals set${NC}"
|
||||
|
||||
# This Year's Focus
|
||||
echo -e "\n${CYAN}This Year's Focus${NC}"
|
||||
read -p "What's your ONE metric that matters this year? " ONE_METRIC
|
||||
read -p "What's this year's theme word? " THEME
|
||||
|
||||
# Update yearly goals
|
||||
YEAR=$(date +%Y)
|
||||
sed -i.bak "s/\[CUSTOMIZE THIS:.*\]/$ONE_METRIC/" "Goals/1. Yearly Goals.md" 2>/dev/null || true
|
||||
|
||||
echo -e "${GREEN}✓ Yearly goals configured${NC}"
|
||||
}
|
||||
|
||||
# Function 3: Customize Daily Template
|
||||
customize_daily() {
|
||||
echo -e "\n${BLUE}Daily Note Customization${NC}"
|
||||
echo "========================"
|
||||
|
||||
echo "Let's customize your daily note structure..."
|
||||
echo ""
|
||||
|
||||
# Time preferences
|
||||
echo "When does your day typically start?"
|
||||
read -p "Wake time (e.g., 6:00 AM): " WAKE_TIME
|
||||
|
||||
echo "When does your workday start?"
|
||||
read -p "Work start (e.g., 9:00 AM): " WORK_START
|
||||
|
||||
echo "When does your workday end?"
|
||||
read -p "Work end (e.g., 5:00 PM): " WORK_END
|
||||
|
||||
# Categories
|
||||
echo -e "\n${CYAN}Task Categories${NC}"
|
||||
echo "What categories do you want to track? (comma-separated)"
|
||||
echo "Default: Work, Personal, Learning, Health"
|
||||
read -p "Your categories: " CATEGORIES
|
||||
CATEGORIES=${CATEGORIES:-"Work,Personal,Learning,Health"}
|
||||
|
||||
# Habits
|
||||
echo -e "\n${CYAN}Daily Habits${NC}"
|
||||
echo "What habits do you want to track? (comma-separated)"
|
||||
echo "Example: Exercise, Meditation, Reading, Journaling"
|
||||
read -p "Your habits: " HABITS
|
||||
|
||||
# Generate custom template
|
||||
cat > "Templates/Daily Template - Custom.md" << EOF
|
||||
---
|
||||
date: {{date}}
|
||||
tags: daily-note
|
||||
---
|
||||
|
||||
# {{date:dddd, MMMM DD, YYYY}}
|
||||
|
||||
## 🎯 Today's Focus
|
||||
**ONE Thing:**
|
||||
|
||||
## ⏰ Schedule
|
||||
- **$WAKE_TIME - Morning Routine**
|
||||
- **$WORK_START - Work Block**
|
||||
- **12:00 PM - Lunch Break**
|
||||
- **1:00 PM - Afternoon Work**
|
||||
- **$WORK_END - End of Work**
|
||||
- **Evening - Personal Time**
|
||||
|
||||
## ✅ Tasks
|
||||
EOF
|
||||
|
||||
# Add categories
|
||||
IFS=',' read -ra CATS <<< "$CATEGORIES"
|
||||
for cat in "${CATS[@]}"; do
|
||||
cat=$(echo "$cat" | xargs) # Trim whitespace
|
||||
echo -e "\n### $cat\n- [ ] " >> "Templates/Daily Template - Custom.md"
|
||||
done
|
||||
|
||||
# Add habits section
|
||||
echo -e "\n## 🧘 Habits" >> "Templates/Daily Template - Custom.md"
|
||||
IFS=',' read -ra HABS <<< "$HABITS"
|
||||
for hab in "${HABS[@]}"; do
|
||||
hab=$(echo "$hab" | xargs)
|
||||
echo "- [ ] $hab" >> "Templates/Daily Template - Custom.md"
|
||||
done
|
||||
|
||||
# Add reflection
|
||||
cat >> "Templates/Daily Template - Custom.md" << EOF
|
||||
|
||||
## 💭 Notes & Ideas
|
||||
|
||||
|
||||
## 🔍 End of Day Reflection
|
||||
### What went well?
|
||||
-
|
||||
|
||||
### What could be better?
|
||||
-
|
||||
|
||||
### Tomorrow's priority:
|
||||
-
|
||||
|
||||
---
|
||||
*Day {{date:D}} of 365*
|
||||
EOF
|
||||
|
||||
echo -e "${GREEN}✓ Custom daily template created${NC}"
|
||||
}
|
||||
|
||||
# Function 4: Customize Weekly Review
|
||||
customize_weekly() {
|
||||
echo -e "\n${BLUE}Weekly Review Customization${NC}"
|
||||
echo "============================"
|
||||
|
||||
echo "When do you prefer to do your weekly review?"
|
||||
echo "1. Sunday Evening"
|
||||
echo "2. Monday Morning"
|
||||
echo "3. Friday Afternoon"
|
||||
echo "4. Saturday Morning"
|
||||
read -p "Choose (1-4): " REVIEW_TIME
|
||||
|
||||
case $REVIEW_TIME in
|
||||
1) REVIEW_DAY="Sunday Evening" ;;
|
||||
2) REVIEW_DAY="Monday Morning" ;;
|
||||
3) REVIEW_DAY="Friday Afternoon" ;;
|
||||
4) REVIEW_DAY="Saturday Morning" ;;
|
||||
*) REVIEW_DAY="Sunday Evening" ;;
|
||||
esac
|
||||
|
||||
echo -e "\nHow long for your review?"
|
||||
read -p "Minutes (default 30): " REVIEW_DURATION
|
||||
REVIEW_DURATION=${REVIEW_DURATION:-30}
|
||||
|
||||
# Create custom weekly review
|
||||
cat > "Templates/Weekly Review - Custom.md" << EOF
|
||||
# Weekly Review - {{date:YYYY [Week] w}}
|
||||
**Review Time:** $REVIEW_DAY ($REVIEW_DURATION minutes)
|
||||
|
||||
## 📊 Quick Metrics
|
||||
- Tasks Completed: /
|
||||
- Goals Progress: %
|
||||
- Energy Average: /10
|
||||
|
||||
## 🔍 Last Week
|
||||
|
||||
### Top 3 Wins
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### Top 3 Challenges
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### Key Insight
|
||||
-
|
||||
|
||||
## 📅 Next Week
|
||||
|
||||
### ONE Big Thing
|
||||
If nothing else:
|
||||
|
||||
### Priority Projects
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### Scheduled Blocks
|
||||
- Deep Work:
|
||||
- Meetings:
|
||||
- Personal:
|
||||
|
||||
## 🧹 Cleanup
|
||||
- [ ] Process inbox
|
||||
- [ ] Review calendar
|
||||
- [ ] Update project status
|
||||
- [ ] Archive old notes
|
||||
- [ ] Plan time blocks
|
||||
|
||||
---
|
||||
*Review completed in: ___ minutes*
|
||||
EOF
|
||||
|
||||
echo -e "${GREEN}✓ Weekly review customized for $REVIEW_DAY${NC}"
|
||||
}
|
||||
|
||||
# Function 5: Customize Tags
|
||||
customize_tags() {
|
||||
echo -e "\n${BLUE}Tag System Setup${NC}"
|
||||
echo "================="
|
||||
|
||||
echo "Let's create your personalized tag system..."
|
||||
echo ""
|
||||
|
||||
echo "Choose tag style:"
|
||||
echo "1. Hierarchical (#area/subarea/specific)"
|
||||
echo "2. Flat (#area-specific)"
|
||||
echo "3. Prefix-based (#p-project, #a-area)"
|
||||
read -p "Style (1-3): " TAG_STYLE
|
||||
|
||||
echo -e "\nEnter your main life areas (comma-separated):"
|
||||
echo "Example: work, personal, health, finance, learning"
|
||||
read -p "Your areas: " AREAS
|
||||
|
||||
# Create tag reference
|
||||
cat > "Tag System.md" << EOF
|
||||
# My Tag System
|
||||
|
||||
## Structure
|
||||
EOF
|
||||
|
||||
case $TAG_STYLE in
|
||||
1)
|
||||
echo "Hierarchical tags:" >> "Tag System.md"
|
||||
IFS=',' read -ra AREA_ARRAY <<< "$AREAS"
|
||||
for area in "${AREA_ARRAY[@]}"; do
|
||||
area=$(echo "$area" | xargs)
|
||||
echo "- #$area/" >> "Tag System.md"
|
||||
echo " - #$area/active" >> "Tag System.md"
|
||||
echo " - #$area/waiting" >> "Tag System.md"
|
||||
echo " - #$area/someday" >> "Tag System.md"
|
||||
done
|
||||
;;
|
||||
2)
|
||||
echo "Flat tags:" >> "Tag System.md"
|
||||
IFS=',' read -ra AREA_ARRAY <<< "$AREAS"
|
||||
for area in "${AREA_ARRAY[@]}"; do
|
||||
area=$(echo "$area" | xargs)
|
||||
echo "- #$area" >> "Tag System.md"
|
||||
echo "- #${area}-active" >> "Tag System.md"
|
||||
echo "- #${area}-waiting" >> "Tag System.md"
|
||||
done
|
||||
;;
|
||||
3)
|
||||
echo "Prefix-based tags:" >> "Tag System.md"
|
||||
echo "- #p- (projects)" >> "Tag System.md"
|
||||
echo "- #a- (areas)" >> "Tag System.md"
|
||||
echo "- #t- (topics)" >> "Tag System.md"
|
||||
echo "- #s- (status)" >> "Tag System.md"
|
||||
;;
|
||||
esac
|
||||
|
||||
cat >> "Tag System.md" << EOF
|
||||
|
||||
## Status Tags
|
||||
- #active - Currently working on
|
||||
- #waiting - Blocked or waiting
|
||||
- #someday - Future consideration
|
||||
- #done - Completed
|
||||
- #cancelled - No longer relevant
|
||||
|
||||
## Priority Tags
|
||||
- #priority/high - Must do today
|
||||
- #priority/medium - This week
|
||||
- #priority/low - When possible
|
||||
|
||||
## Energy Tags
|
||||
- #energy/high - Requires focus
|
||||
- #energy/medium - Normal energy
|
||||
- #energy/low - Can do when tired
|
||||
|
||||
## Quick Search Queries
|
||||
- Find all active: tag:#active
|
||||
- Today's priorities: tag:#priority/high
|
||||
- Waiting items: tag:#waiting
|
||||
EOF
|
||||
|
||||
echo -e "${GREEN}✓ Tag system created${NC}"
|
||||
}
|
||||
|
||||
# Function 6: Customize Time Blocks
|
||||
customize_time_blocks() {
|
||||
echo -e "\n${BLUE}Time Block Customization${NC}"
|
||||
echo "========================"
|
||||
|
||||
echo "Let's set up your ideal time blocks..."
|
||||
echo ""
|
||||
|
||||
echo "What type of schedule do you follow?"
|
||||
echo "1. Traditional (9-5)"
|
||||
echo "2. Early Bird (5am start)"
|
||||
echo "3. Night Owl (work late)"
|
||||
echo "4. Flexible/Remote"
|
||||
echo "5. Shift Work"
|
||||
read -p "Choose (1-5): " SCHEDULE_TYPE
|
||||
|
||||
case $SCHEDULE_TYPE in
|
||||
1)
|
||||
BLOCKS="6-7 AM: Morning Routine
|
||||
7-8 AM: Planning & Email
|
||||
8-9 AM: Commute
|
||||
9-12 PM: Deep Work
|
||||
12-1 PM: Lunch
|
||||
1-3 PM: Meetings
|
||||
3-5 PM: Admin Tasks
|
||||
5-6 PM: Wrap Up
|
||||
6-9 PM: Personal Time"
|
||||
;;
|
||||
2)
|
||||
BLOCKS="5-6 AM: Morning Routine
|
||||
6-8 AM: Deep Work
|
||||
8-9 AM: Exercise
|
||||
9-12 PM: Focused Work
|
||||
12-1 PM: Lunch
|
||||
1-3 PM: Meetings
|
||||
3-5 PM: Project Time
|
||||
5-7 PM: Family Time
|
||||
7-9 PM: Personal Projects"
|
||||
;;
|
||||
3)
|
||||
BLOCKS="8-9 AM: Slow Morning
|
||||
9-10 AM: Exercise
|
||||
10-12 PM: Admin Tasks
|
||||
12-1 PM: Lunch
|
||||
1-4 PM: Meetings
|
||||
4-6 PM: Break/Personal
|
||||
6-8 PM: Dinner
|
||||
8-12 AM: Deep Work"
|
||||
;;
|
||||
4)
|
||||
BLOCKS="7-8 AM: Morning Routine
|
||||
8-10 AM: Deep Work Block 1
|
||||
10-12 PM: Communication Block
|
||||
12-1 PM: Lunch & Walk
|
||||
1-3 PM: Deep Work Block 2
|
||||
3-4 PM: Admin/Email
|
||||
4-5 PM: Planning Tomorrow
|
||||
5-7 PM: Personal Time
|
||||
7-9 PM: Learning/Side Projects"
|
||||
;;
|
||||
5)
|
||||
echo "Enter your shift schedule:"
|
||||
read -p "Shift start: " SHIFT_START
|
||||
read -p "Shift end: " SHIFT_END
|
||||
BLOCKS="Custom shift: $SHIFT_START - $SHIFT_END"
|
||||
;;
|
||||
esac
|
||||
|
||||
# Create time block template
|
||||
cat > "Time Blocks.md" << EOF
|
||||
# My Ideal Time Blocks
|
||||
|
||||
## Default Schedule
|
||||
$BLOCKS
|
||||
|
||||
## Deep Work Times
|
||||
Best focus: [CUSTOMIZE]
|
||||
Good focus: [CUSTOMIZE]
|
||||
Low focus: [CUSTOMIZE]
|
||||
|
||||
## Rules
|
||||
1. Protect deep work blocks
|
||||
2. Batch similar tasks
|
||||
3. Include breaks
|
||||
4. End day with planning
|
||||
|
||||
## Weekly Variations
|
||||
- Monday: Planning focus
|
||||
- Tuesday-Thursday: Execution
|
||||
- Friday: Review & wrap-up
|
||||
|
||||
---
|
||||
*Adjust based on energy and priorities*
|
||||
EOF
|
||||
|
||||
echo -e "${GREEN}✓ Time blocks configured${NC}"
|
||||
}
|
||||
|
||||
# Function 10: Create Custom Command
|
||||
create_custom_command() {
|
||||
echo -e "\n${BLUE}Create Custom Claude Command${NC}"
|
||||
echo "============================="
|
||||
|
||||
read -p "Command name (e.g., 'report'): " CMD_NAME
|
||||
read -p "Command description: " CMD_DESC
|
||||
|
||||
echo "What should this command do?"
|
||||
echo "1. Create a specific type of note"
|
||||
echo "2. Run a workflow/process"
|
||||
echo "3. Generate a report"
|
||||
echo "4. Perform maintenance"
|
||||
read -p "Choose (1-4): " CMD_TYPE
|
||||
|
||||
# Create command file
|
||||
cat > ".claude/commands/$CMD_NAME.md" << EOF
|
||||
# $CMD_NAME Command
|
||||
|
||||
$CMD_DESC
|
||||
|
||||
## Usage
|
||||
\`\`\`
|
||||
claude code /$CMD_NAME
|
||||
\`\`\`
|
||||
|
||||
## What This Command Does
|
||||
EOF
|
||||
|
||||
case $CMD_TYPE in
|
||||
1)
|
||||
read -p "Note template name: " TEMPLATE
|
||||
cat >> ".claude/commands/$CMD_NAME.md" << EOF
|
||||
1. Creates a new note from template
|
||||
2. Names it appropriately
|
||||
3. Places in correct folder
|
||||
|
||||
## Configuration
|
||||
const TEMPLATE_PATH = "Templates/$TEMPLATE.md";
|
||||
const OUTPUT_FOLDER = "[CUSTOMIZE]";
|
||||
EOF
|
||||
;;
|
||||
2)
|
||||
cat >> ".claude/commands/$CMD_NAME.md" << EOF
|
||||
1. Executes workflow steps
|
||||
2. Updates relevant files
|
||||
3. Generates output
|
||||
|
||||
## Workflow Steps
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
EOF
|
||||
;;
|
||||
3)
|
||||
cat >> ".claude/commands/$CMD_NAME.md" << EOF
|
||||
1. Analyzes specified data
|
||||
2. Generates formatted report
|
||||
3. Saves to designated location
|
||||
|
||||
## Report Sections
|
||||
- Summary
|
||||
- Details
|
||||
- Recommendations
|
||||
EOF
|
||||
;;
|
||||
4)
|
||||
cat >> ".claude/commands/$CMD_NAME.md" << EOF
|
||||
1. Performs maintenance tasks
|
||||
2. Cleans up files
|
||||
3. Optimizes structure
|
||||
|
||||
## Tasks
|
||||
- Archive old files
|
||||
- Update indices
|
||||
- Clean duplicates
|
||||
EOF
|
||||
;;
|
||||
esac
|
||||
|
||||
echo -e "${GREEN}✓ Custom command '/$CMD_NAME' created${NC}"
|
||||
}
|
||||
|
||||
# Main loop
|
||||
while true; do
|
||||
show_menu
|
||||
|
||||
case $choice in
|
||||
1) customize_mission ;;
|
||||
2) customize_goals ;;
|
||||
3) customize_daily ;;
|
||||
4) customize_weekly ;;
|
||||
5) customize_tags ;;
|
||||
6) customize_time_blocks ;;
|
||||
7) echo "Project template customization coming soon..." ;;
|
||||
8) echo "Edit CLAUDE.md directly for now..." ;;
|
||||
9) echo "Folder structure customization coming soon..." ;;
|
||||
10) create_custom_command ;;
|
||||
0)
|
||||
echo -e "\n${GREEN}Customization complete!${NC}"
|
||||
echo "Your PKM system has been personalized."
|
||||
|
||||
# Commit changes
|
||||
cd "$VAULT_PATH"
|
||||
git add .
|
||||
git commit -m "Customization updates - $(date +%Y-%m-%d)" 2>/dev/null || true
|
||||
|
||||
exit 0
|
||||
;;
|
||||
*) echo -e "${RED}Invalid option${NC}" ;;
|
||||
esac
|
||||
|
||||
echo -e "\n${CYAN}Press Enter to continue...${NC}"
|
||||
read
|
||||
done
|
||||
249
scripts/setup.bat
Normal file
249
scripts/setup.bat
Normal file
@@ -0,0 +1,249 @@
|
||||
@echo off
|
||||
REM Obsidian + Claude Code PKM Setup Script for Windows
|
||||
REM This script automates the initial setup of your PKM system
|
||||
|
||||
setlocal enabledelayedexpansion
|
||||
|
||||
REM Colors setup (Windows 10+)
|
||||
echo.
|
||||
|
||||
echo =====================================
|
||||
echo Obsidian + Claude Code PKM Setup
|
||||
echo Version 1.0 for Windows
|
||||
echo =====================================
|
||||
echo.
|
||||
|
||||
REM Step 1: Check Prerequisites
|
||||
echo Step 1: Checking Prerequisites
|
||||
echo ==============================
|
||||
|
||||
REM Check for Git
|
||||
where git >nul 2>nul
|
||||
if %errorlevel%==0 (
|
||||
echo [OK] Git is installed
|
||||
git --version
|
||||
) else (
|
||||
echo [ERROR] Git is not installed
|
||||
echo Please install Git from: https://git-scm.com/
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
REM Check for Claude Code
|
||||
where claude >nul 2>nul
|
||||
if %errorlevel%==0 (
|
||||
echo [OK] Claude Code is installed
|
||||
) else (
|
||||
echo [WARNING] Claude Code CLI not found
|
||||
echo Install from: https://docs.anthropic.com/en/docs/claude-code
|
||||
set /p CONTINUE="Continue without Claude Code? (y/n): "
|
||||
if /i not "!CONTINUE!"=="y" exit /b 1
|
||||
)
|
||||
|
||||
echo.
|
||||
|
||||
REM Step 2: Get Vault Location
|
||||
echo Step 2: Choose Vault Location
|
||||
echo ==============================
|
||||
|
||||
set DEFAULT_VAULT=%USERPROFILE%\Documents\ObsidianPKM
|
||||
set /p VAULT_PATH="Where should we create your vault? [%DEFAULT_VAULT%]: "
|
||||
if "%VAULT_PATH%"=="" set VAULT_PATH=%DEFAULT_VAULT%
|
||||
|
||||
REM Check if directory exists
|
||||
if exist "%VAULT_PATH%" (
|
||||
echo [WARNING] Directory already exists: %VAULT_PATH%
|
||||
set /p USE_EXISTING="Use existing directory? Files may be overwritten (y/n): "
|
||||
if /i not "!USE_EXISTING!"=="y" (
|
||||
echo Setup cancelled
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
) else (
|
||||
mkdir "%VAULT_PATH%"
|
||||
echo [OK] Created vault directory: %VAULT_PATH%
|
||||
)
|
||||
|
||||
echo.
|
||||
|
||||
REM Step 3: Copy Vault Template
|
||||
echo Step 3: Setting Up Vault Structure
|
||||
echo ===================================
|
||||
|
||||
set SCRIPT_DIR=%~dp0
|
||||
set TEMPLATE_DIR=%SCRIPT_DIR%..\vault-template
|
||||
|
||||
echo Copying template files...
|
||||
xcopy /E /I /Y "%TEMPLATE_DIR%\*" "%VAULT_PATH%\" >nul 2>nul
|
||||
echo [OK] Vault structure created
|
||||
|
||||
echo.
|
||||
|
||||
REM Step 4: Set Up Claude Commands
|
||||
echo Step 4: Setting Up Claude Commands
|
||||
echo ===================================
|
||||
|
||||
where claude >nul 2>nul
|
||||
if %errorlevel%==0 (
|
||||
REM Commands are already in vault-template\.claude\commands\
|
||||
REM Just need to initialize Claude
|
||||
cd /d "%VAULT_PATH%"
|
||||
|
||||
REM Check if commands were copied
|
||||
if exist "%VAULT_PATH%\.claude\commands" (
|
||||
echo [OK] Claude commands already in place
|
||||
) else (
|
||||
echo [WARNING] Claude commands directory not found
|
||||
)
|
||||
|
||||
REM Initialize Claude in vault
|
||||
claude init 2>nul
|
||||
echo [OK] Claude Code initialized in vault
|
||||
) else (
|
||||
echo [WARNING] Skipping Claude Code setup - not installed
|
||||
)
|
||||
|
||||
echo.
|
||||
|
||||
REM Step 5: Initialize Git
|
||||
echo Step 5: Git Repository Setup
|
||||
echo ============================
|
||||
|
||||
cd /d "%VAULT_PATH%"
|
||||
|
||||
if exist .git (
|
||||
echo [WARNING] Git repository already exists
|
||||
) else (
|
||||
git init >nul
|
||||
echo [OK] Git repository initialized
|
||||
)
|
||||
|
||||
REM Configure Git
|
||||
set /p GIT_NAME="Enter your name for Git commits: "
|
||||
set /p GIT_EMAIL="Enter your email for Git commits: "
|
||||
|
||||
if not "%GIT_NAME%"=="" (
|
||||
git config user.name "%GIT_NAME%"
|
||||
echo [OK] Git user name set
|
||||
)
|
||||
|
||||
if not "%GIT_EMAIL%"=="" (
|
||||
git config user.email "%GIT_EMAIL%"
|
||||
echo [OK] Git user email set
|
||||
)
|
||||
|
||||
REM Initial commit
|
||||
git add . >nul 2>nul
|
||||
git commit -m "Initial PKM setup" >nul 2>nul
|
||||
echo [OK] Initial commit created
|
||||
|
||||
echo.
|
||||
|
||||
REM Step 6: GitHub Setup (Optional)
|
||||
echo Step 6: GitHub Integration - Optional
|
||||
echo ======================================
|
||||
|
||||
set /p SETUP_GITHUB="Do you want to set up GitHub integration? (y/n): "
|
||||
if /i "%SETUP_GITHUB%"=="y" (
|
||||
set /p GITHUB_URL="Enter your GitHub repository URL (or press Enter to skip): "
|
||||
|
||||
if not "!GITHUB_URL!"=="" (
|
||||
git remote add origin "!GITHUB_URL!" 2>nul || git remote set-url origin "!GITHUB_URL!"
|
||||
echo [OK] GitHub remote configured
|
||||
|
||||
set /p PUSH_NOW="Push to GitHub now? (y/n): "
|
||||
if /i "!PUSH_NOW!"=="y" (
|
||||
git push -u origin main 2>nul || git push -u origin master
|
||||
echo [OK] Pushed to GitHub
|
||||
)
|
||||
|
||||
REM Set up GitHub Action
|
||||
mkdir "%VAULT_PATH%\.github\workflows" 2>nul
|
||||
copy "%SCRIPT_DIR%..\github-actions\claude.yml" "%VAULT_PATH%\.github\workflows\" >nul
|
||||
echo [OK] GitHub Action workflow copied
|
||||
echo [NOTE] Remember to add CLAUDE_CODE_OAUTH_TOKEN to repository secrets
|
||||
)
|
||||
)
|
||||
|
||||
echo.
|
||||
|
||||
REM Step 7: Personalization
|
||||
echo Step 7: Initial Personalization
|
||||
echo ================================
|
||||
|
||||
echo.
|
||||
echo What's your personal mission or life purpose?
|
||||
echo Example: Build meaningful technology while maintaining balance
|
||||
set /p MISSION="Your mission: "
|
||||
|
||||
if not "%MISSION%"=="" (
|
||||
REM This is simplified - proper text replacement in batch is complex
|
||||
echo [OK] Personal mission noted - please update CLAUDE.md manually
|
||||
)
|
||||
|
||||
echo.
|
||||
echo What's your main focus right now?
|
||||
set /p FOCUS="Current focus: "
|
||||
|
||||
REM Create first daily note
|
||||
for /f "tokens=1-3 delims=/ " %%a in ('date /t') do (
|
||||
set TODAY=%%c-%%a-%%b
|
||||
)
|
||||
set TODAY=%TODAY: =%
|
||||
set DAILY_NOTE=%VAULT_PATH%\Daily Notes\%TODAY%.md
|
||||
|
||||
if not exist "%DAILY_NOTE%" (
|
||||
echo Creating your first daily note...
|
||||
copy "%VAULT_PATH%\Templates\Daily Template.md" "%DAILY_NOTE%" >nul
|
||||
echo [OK] First daily note created: %TODAY%.md
|
||||
)
|
||||
|
||||
echo.
|
||||
|
||||
REM Step 8: Final Setup
|
||||
echo Step 8: Finalizing Setup
|
||||
echo ========================
|
||||
|
||||
REM Create a setup completion marker
|
||||
echo Setup completed on %date% %time% > "%VAULT_PATH%\.setup_complete"
|
||||
|
||||
REM Commit personalization
|
||||
cd /d "%VAULT_PATH%"
|
||||
git add . >nul 2>nul
|
||||
git commit -m "Personalized PKM setup" >nul 2>nul
|
||||
|
||||
echo.
|
||||
echo =============================================
|
||||
echo Setup Complete!
|
||||
echo =============================================
|
||||
echo.
|
||||
echo Your PKM system is ready at: %VAULT_PATH%
|
||||
echo.
|
||||
echo Next steps:
|
||||
echo 1. Open Obsidian and select your vault folder
|
||||
echo 2. Explore the Goals folder to set your objectives
|
||||
echo 3. Start using daily notes with: claude code /daily
|
||||
echo 4. Run weekly reviews with: claude code /weekly
|
||||
echo.
|
||||
echo Quick Commands:
|
||||
echo cd "%VAULT_PATH%" - Navigate to your vault
|
||||
echo claude code /onboard - Load context into Claude
|
||||
echo claude code /daily - Create today's note
|
||||
echo claude code /push - Save changes to Git
|
||||
echo.
|
||||
echo Read the documentation in docs\ for detailed guidance
|
||||
echo.
|
||||
|
||||
REM Offer to open Obsidian
|
||||
if exist "%LOCALAPPDATA%\Obsidian\Obsidian.exe" (
|
||||
set /p OPEN_OBSIDIAN="Open Obsidian now? (y/n): "
|
||||
if /i "!OPEN_OBSIDIAN!"=="y" (
|
||||
start "" "%LOCALAPPDATA%\Obsidian\Obsidian.exe"
|
||||
echo [OK] Obsidian launched
|
||||
)
|
||||
)
|
||||
|
||||
echo.
|
||||
echo Happy note-taking!
|
||||
echo.
|
||||
pause
|
||||
291
scripts/setup.sh
Executable file
291
scripts/setup.sh
Executable file
@@ -0,0 +1,291 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Obsidian + Claude Code PKM Setup Script
|
||||
# This script automates the initial setup of your PKM system
|
||||
|
||||
set -e # Exit on error
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Banner
|
||||
echo -e "${BLUE}"
|
||||
echo "╔═══════════════════════════════════════════════════╗"
|
||||
echo "║ Obsidian + Claude Code PKM Setup Wizard ║"
|
||||
echo "║ Version 1.0 ║"
|
||||
echo "╚═══════════════════════════════════════════════════╝"
|
||||
echo -e "${NC}"
|
||||
|
||||
# Function to print colored messages
|
||||
print_success() {
|
||||
echo -e "${GREEN}✓${NC} $1"
|
||||
}
|
||||
|
||||
print_error() {
|
||||
echo -e "${RED}✗${NC} $1"
|
||||
}
|
||||
|
||||
print_warning() {
|
||||
echo -e "${YELLOW}⚠${NC} $1"
|
||||
}
|
||||
|
||||
print_info() {
|
||||
echo -e "${BLUE}ℹ${NC} $1"
|
||||
}
|
||||
|
||||
# Function to check if command exists
|
||||
command_exists() {
|
||||
command -v "$1" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
# Step 1: Check Prerequisites
|
||||
echo -e "\n${BLUE}Step 1: Checking Prerequisites${NC}"
|
||||
echo "================================"
|
||||
|
||||
# Check for Git
|
||||
if command_exists git; then
|
||||
print_success "Git is installed ($(git --version))"
|
||||
else
|
||||
print_error "Git is not installed"
|
||||
echo "Please install Git from: https://git-scm.com/"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check for Claude Code
|
||||
if command_exists claude; then
|
||||
print_success "Claude Code is installed ($(claude --version 2>/dev/null || echo 'version check failed'))"
|
||||
else
|
||||
print_warning "Claude Code CLI not found"
|
||||
echo "Install from: https://docs.anthropic.com/en/docs/claude-code"
|
||||
read -p "Continue without Claude Code? (y/n): " -n 1 -r
|
||||
echo
|
||||
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Step 2: Get Vault Location
|
||||
echo -e "\n${BLUE}Step 2: Choose Vault Location${NC}"
|
||||
echo "================================"
|
||||
|
||||
# Default location
|
||||
DEFAULT_VAULT="$HOME/Documents/ObsidianPKM"
|
||||
read -p "Where should we create your vault? [$DEFAULT_VAULT]: " VAULT_PATH
|
||||
VAULT_PATH=${VAULT_PATH:-$DEFAULT_VAULT}
|
||||
|
||||
# Expand tilde if present
|
||||
VAULT_PATH="${VAULT_PATH/#\~/$HOME}"
|
||||
|
||||
# Check if directory exists
|
||||
if [ -d "$VAULT_PATH" ]; then
|
||||
print_warning "Directory already exists: $VAULT_PATH"
|
||||
read -p "Use existing directory? Files may be overwritten (y/n): " -n 1 -r
|
||||
echo
|
||||
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
|
||||
echo "Setup cancelled"
|
||||
exit 1
|
||||
fi
|
||||
else
|
||||
mkdir -p "$VAULT_PATH"
|
||||
print_success "Created vault directory: $VAULT_PATH"
|
||||
fi
|
||||
|
||||
# Step 3: Copy Vault Template
|
||||
echo -e "\n${BLUE}Step 3: Setting Up Vault Structure${NC}"
|
||||
echo "====================================="
|
||||
|
||||
# Get script directory
|
||||
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||
TEMPLATE_DIR="$SCRIPT_DIR/../vault-template"
|
||||
|
||||
# Copy template files
|
||||
print_info "Copying template files..."
|
||||
cp -r "$TEMPLATE_DIR"/* "$VAULT_PATH/" 2>/dev/null || true
|
||||
cp -r "$TEMPLATE_DIR"/.* "$VAULT_PATH/" 2>/dev/null || true
|
||||
print_success "Vault structure created"
|
||||
|
||||
# Step 4: Set Up Claude Commands
|
||||
echo -e "\n${BLUE}Step 4: Setting Up Claude Commands${NC}"
|
||||
echo "======================================"
|
||||
|
||||
if command_exists claude; then
|
||||
# Commands are already in vault-template/.claude/commands/
|
||||
# Just need to initialize Claude
|
||||
cd "$VAULT_PATH"
|
||||
|
||||
# Check if commands were copied
|
||||
if [ -d "$VAULT_PATH/.claude/commands" ]; then
|
||||
print_success "Claude commands already in place"
|
||||
else
|
||||
print_warning "Claude commands directory not found"
|
||||
fi
|
||||
|
||||
# Initialize Claude in vault
|
||||
claude init 2>/dev/null || true
|
||||
print_success "Claude Code initialized in vault"
|
||||
else
|
||||
print_warning "Skipping Claude Code setup (not installed)"
|
||||
fi
|
||||
|
||||
# Step 5: Initialize Git
|
||||
echo -e "\n${BLUE}Step 5: Git Repository Setup${NC}"
|
||||
echo "==============================="
|
||||
|
||||
cd "$VAULT_PATH"
|
||||
|
||||
if [ -d .git ]; then
|
||||
print_warning "Git repository already exists"
|
||||
else
|
||||
git init
|
||||
print_success "Git repository initialized"
|
||||
fi
|
||||
|
||||
# Configure Git
|
||||
read -p "Enter your name for Git commits: " GIT_NAME
|
||||
read -p "Enter your email for Git commits: " GIT_EMAIL
|
||||
|
||||
if [ -n "$GIT_NAME" ]; then
|
||||
git config user.name "$GIT_NAME"
|
||||
print_success "Git user name set"
|
||||
fi
|
||||
|
||||
if [ -n "$GIT_EMAIL" ]; then
|
||||
git config user.email "$GIT_EMAIL"
|
||||
print_success "Git user email set"
|
||||
fi
|
||||
|
||||
# Initial commit
|
||||
git add .
|
||||
git commit -m "Initial PKM setup" 2>/dev/null || print_warning "Nothing to commit"
|
||||
|
||||
# Step 6: GitHub Setup (Optional)
|
||||
echo -e "\n${BLUE}Step 6: GitHub Integration (Optional)${NC}"
|
||||
echo "========================================="
|
||||
|
||||
read -p "Do you want to set up GitHub integration? (y/n): " -n 1 -r
|
||||
echo
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||
read -p "Enter your GitHub repository URL (or press Enter to skip): " GITHUB_URL
|
||||
|
||||
if [ -n "$GITHUB_URL" ]; then
|
||||
git remote add origin "$GITHUB_URL" 2>/dev/null || git remote set-url origin "$GITHUB_URL"
|
||||
print_success "GitHub remote configured"
|
||||
|
||||
read -p "Push to GitHub now? (y/n): " -n 1 -r
|
||||
echo
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||
git push -u origin main 2>/dev/null || git push -u origin master
|
||||
print_success "Pushed to GitHub"
|
||||
fi
|
||||
|
||||
# Set up GitHub Action
|
||||
mkdir -p "$VAULT_PATH/.github/workflows"
|
||||
cp "$SCRIPT_DIR/../github-actions/claude.yml" "$VAULT_PATH/.github/workflows/"
|
||||
print_success "GitHub Action workflow copied"
|
||||
print_warning "Remember to add CLAUDE_CODE_OAUTH_TOKEN to repository secrets"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Step 7: Personalization
|
||||
echo -e "\n${BLUE}Step 7: Initial Personalization${NC}"
|
||||
echo "===================================="
|
||||
|
||||
print_info "Let's personalize your system..."
|
||||
|
||||
# Get personal mission
|
||||
echo -e "\nWhat's your personal mission or life purpose?"
|
||||
echo "(Example: 'Build meaningful technology while maintaining balance')"
|
||||
read -p "Your mission: " MISSION
|
||||
|
||||
if [ -n "$MISSION" ]; then
|
||||
# Update CLAUDE.md
|
||||
if [[ "$OSTYPE" == "darwin"* ]]; then
|
||||
# macOS
|
||||
sed -i '' "s/\[CUSTOMIZE THIS: Add your personal mission statement or life purpose here\]/$MISSION/" "$VAULT_PATH/CLAUDE.md"
|
||||
else
|
||||
# Linux
|
||||
sed -i "s/\[CUSTOMIZE THIS: Add your personal mission statement or life purpose here\]/$MISSION/" "$VAULT_PATH/CLAUDE.md"
|
||||
fi
|
||||
print_success "Personal mission added"
|
||||
fi
|
||||
|
||||
# Get current focus
|
||||
echo -e "\nWhat's your main focus right now?"
|
||||
read -p "Current focus: " FOCUS
|
||||
|
||||
# Create first daily note
|
||||
TODAY=$(date +%Y-%m-%d)
|
||||
DAILY_NOTE="$VAULT_PATH/Daily Notes/$TODAY.md"
|
||||
|
||||
if [ ! -f "$DAILY_NOTE" ]; then
|
||||
print_info "Creating your first daily note..."
|
||||
cp "$VAULT_PATH/Templates/Daily Template.md" "$DAILY_NOTE"
|
||||
|
||||
# Add focus to daily note
|
||||
if [ -n "$FOCUS" ]; then
|
||||
if [[ "$OSTYPE" == "darwin"* ]]; then
|
||||
sed -i '' "s/\*\*Today's Priority:\*\*/\*\*Today's Priority:\*\* $FOCUS/" "$DAILY_NOTE"
|
||||
else
|
||||
sed -i "s/\*\*Today's Priority:\*\*/\*\*Today's Priority:\*\* $FOCUS/" "$DAILY_NOTE"
|
||||
fi
|
||||
fi
|
||||
|
||||
print_success "First daily note created: $TODAY.md"
|
||||
fi
|
||||
|
||||
# Step 8: Final Setup
|
||||
echo -e "\n${BLUE}Step 8: Finalizing Setup${NC}"
|
||||
echo "==========================="
|
||||
|
||||
# Create a setup completion marker
|
||||
echo "Setup completed on $(date)" > "$VAULT_PATH/.setup_complete"
|
||||
|
||||
# Commit personalization
|
||||
cd "$VAULT_PATH"
|
||||
git add .
|
||||
git commit -m "Personalized PKM setup" 2>/dev/null || true
|
||||
|
||||
# Summary
|
||||
echo -e "\n${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
|
||||
echo -e "${GREEN}✨ Setup Complete!${NC}"
|
||||
echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}\n"
|
||||
|
||||
echo "Your PKM system is ready at: $VAULT_PATH"
|
||||
echo ""
|
||||
echo "Next steps:"
|
||||
echo "1. Open Obsidian and select your vault folder"
|
||||
echo "2. Explore the Goals folder to set your objectives"
|
||||
echo "3. Start using daily notes with: claude code /daily"
|
||||
echo "4. Run weekly reviews with: claude code /weekly"
|
||||
echo ""
|
||||
echo "Quick Commands:"
|
||||
echo " cd \"$VAULT_PATH\" # Navigate to your vault"
|
||||
echo " claude code /onboard # Load context into Claude"
|
||||
echo " claude code /daily # Create today's note"
|
||||
echo " claude code /push # Save changes to Git"
|
||||
echo ""
|
||||
print_info "Read the documentation in docs/ for detailed guidance"
|
||||
print_success "Happy note-taking! 🚀"
|
||||
|
||||
# Offer to open Obsidian
|
||||
if [[ "$OSTYPE" == "darwin"* ]]; then
|
||||
if [ -d "/Applications/Obsidian.app" ]; then
|
||||
read -p "Open Obsidian now? (y/n): " -n 1 -r
|
||||
echo
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||
open -a Obsidian
|
||||
print_success "Obsidian launched"
|
||||
fi
|
||||
fi
|
||||
elif command_exists obsidian; then
|
||||
read -p "Open Obsidian now? (y/n): " -n 1 -r
|
||||
echo
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||
obsidian &
|
||||
print_success "Obsidian launched"
|
||||
fi
|
||||
fi
|
||||
115
vault-template/.claude/commands/daily.md
Normal file
115
vault-template/.claude/commands/daily.md
Normal file
@@ -0,0 +1,115 @@
|
||||
# Daily Note Creator Command
|
||||
|
||||
Creates today's daily note from the template, or opens it if it already exists.
|
||||
|
||||
## Installation
|
||||
Copy this file to `.claude/commands/daily.md` in your vault root.
|
||||
|
||||
## Usage
|
||||
```
|
||||
claude code /daily
|
||||
```
|
||||
|
||||
## Configuration
|
||||
Customize these paths to match your vault structure:
|
||||
|
||||
```javascript
|
||||
// Path Configuration (customize these)
|
||||
const DAILY_NOTES_FOLDER = "Daily Notes";
|
||||
const TEMPLATE_PATH = "Templates/Daily Template.md";
|
||||
const DATE_FORMAT = "YYYY-MM-DD"; // Change if you prefer different format
|
||||
```
|
||||
|
||||
## What This Command Does
|
||||
|
||||
1. **Checks if today's note exists**
|
||||
- If yes: Opens the existing note
|
||||
- If no: Creates new note from template
|
||||
|
||||
2. **Template Processing**
|
||||
- Replaces `{{date}}` with today's date
|
||||
- Replaces `{{date:format}}` with formatted dates
|
||||
- Handles date arithmetic (e.g., `{{date-1}}` for yesterday)
|
||||
|
||||
3. **Automatic Organization**
|
||||
- Places note in correct folder
|
||||
- Names file with today's date
|
||||
- Preserves your template structure
|
||||
|
||||
## Template Variables
|
||||
|
||||
Your daily template can use these variables:
|
||||
|
||||
- `{{date}}` - Today's date in default format
|
||||
- `{{date:dddd}}` - Day name (e.g., Monday)
|
||||
- `{{date:MMMM DD, YYYY}}` - Formatted date
|
||||
- `{{date-1:YYYY-MM-DD}}` - Yesterday's date
|
||||
- `{{date+1:YYYY-MM-DD}}` - Tomorrow's date
|
||||
- `{{time}}` - Current time
|
||||
|
||||
## Example Workflow
|
||||
|
||||
1. Morning routine:
|
||||
```
|
||||
claude code /daily
|
||||
```
|
||||
Creates today's note with your template
|
||||
|
||||
2. Review yesterday:
|
||||
The template automatically links to yesterday's note
|
||||
|
||||
3. Plan tomorrow:
|
||||
End of day, set tomorrow's priority in the reflection
|
||||
|
||||
## Customization Ideas
|
||||
|
||||
### Different Date Formats
|
||||
Change `DATE_FORMAT` to:
|
||||
- `"YYYY-MM-DD"` - Standard ISO format (recommended)
|
||||
- `"MM-DD-YYYY"` - US format
|
||||
- `"DD-MM-YYYY"` - European format
|
||||
- `"YYYY-MM-DD-ddd"` - Include day abbreviation
|
||||
|
||||
### Folder Organization
|
||||
Organize by month/year:
|
||||
```javascript
|
||||
const year = new Date().getFullYear();
|
||||
const month = String(new Date().getMonth() + 1).padStart(2, '0');
|
||||
const DAILY_NOTES_FOLDER = `Daily Notes/${year}/${month}`;
|
||||
```
|
||||
|
||||
### Multiple Templates
|
||||
For different day types:
|
||||
```javascript
|
||||
const dayOfWeek = new Date().getDay();
|
||||
const TEMPLATE_PATH = dayOfWeek === 1
|
||||
? "Templates/Monday Template.md" // Special Monday template
|
||||
: "Templates/Daily Template.md"; // Regular template
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Note not created?
|
||||
- Check template path exists
|
||||
- Verify folder permissions
|
||||
- Ensure template file is readable
|
||||
|
||||
### Wrong date format?
|
||||
- Adjust `DATE_FORMAT` constant
|
||||
- Check system date settings
|
||||
|
||||
### Links not working?
|
||||
- Verify date format matches
|
||||
- Check file naming convention
|
||||
|
||||
## Related Commands
|
||||
- `/weekly` - Create weekly review
|
||||
- `/push` - Save changes to Git
|
||||
- `/onboard` - Load context
|
||||
|
||||
---
|
||||
|
||||
*Command Version: 1.0*
|
||||
*Compatible with: Claude Code CLI*
|
||||
|
||||
**Pro Tip:** Run this as part of your morning routine for consistency!
|
||||
302
vault-template/.claude/commands/onboard.md
Normal file
302
vault-template/.claude/commands/onboard.md
Normal file
@@ -0,0 +1,302 @@
|
||||
# Onboard Command
|
||||
|
||||
Loads all CLAUDE.md files from your vault to provide comprehensive context to Claude Code for intelligent assistance.
|
||||
|
||||
## Installation
|
||||
Copy this file to `.claude/commands/onboard.md` in your vault root.
|
||||
|
||||
## Usage
|
||||
```
|
||||
claude code /onboard
|
||||
```
|
||||
|
||||
For specific project context:
|
||||
```
|
||||
claude code /onboard Projects/MyProject
|
||||
```
|
||||
|
||||
## Configuration
|
||||
Customize context loading:
|
||||
|
||||
```javascript
|
||||
// Configuration
|
||||
const CLAUDE_FILE_NAME = "CLAUDE.md";
|
||||
const MAX_DEPTH = 5; // How deep to search for CLAUDE.md files
|
||||
const INCLUDE_TEMPLATES = false; // Load template files too
|
||||
const LOAD_RECENT_NOTES = true; // Include last 7 days of daily notes
|
||||
```
|
||||
|
||||
## What This Command Does
|
||||
|
||||
1. **Discovers Context Files**
|
||||
- Searches for all CLAUDE.md files
|
||||
- Traverses project directories
|
||||
- Respects depth limits
|
||||
|
||||
2. **Loads Hierarchical Context**
|
||||
- Root CLAUDE.md first (global context)
|
||||
- Project-specific CLAUDE.md files
|
||||
- Recent daily notes for current state
|
||||
|
||||
3. **Builds Understanding**
|
||||
- Your personal mission/goals
|
||||
- Project structures and status
|
||||
- Workflow preferences
|
||||
- Custom conventions
|
||||
|
||||
## Context Hierarchy
|
||||
|
||||
```
|
||||
vault/
|
||||
├── CLAUDE.md # [1] Global context - loaded first
|
||||
├── Projects/
|
||||
│ ├── Project A/
|
||||
│ │ └── CLAUDE.md # [2] Project context - loaded second
|
||||
│ └── Project B/
|
||||
│ └── CLAUDE.md # [3] Another project context
|
||||
└── Areas/
|
||||
└── Health/
|
||||
└── CLAUDE.md # [4] Area-specific context
|
||||
```
|
||||
|
||||
## CLAUDE.md File Structure
|
||||
|
||||
### Root CLAUDE.md Should Include
|
||||
```markdown
|
||||
# System Context for Claude
|
||||
|
||||
## Personal Mission
|
||||
[Your life mission/purpose]
|
||||
|
||||
## Current Focus
|
||||
[What you're working on now]
|
||||
|
||||
## Preferences
|
||||
- Writing style: [Formal/Casual/Technical]
|
||||
- Detail level: [High/Medium/Low]
|
||||
- Decision making: [Collaborative/Directive]
|
||||
|
||||
## Conventions
|
||||
- File naming: [Your patterns]
|
||||
- Tag system: [Your tags]
|
||||
- Workflow: [Your process]
|
||||
```
|
||||
|
||||
### Project CLAUDE.md Should Include
|
||||
```markdown
|
||||
# Project: [Name]
|
||||
|
||||
## Overview
|
||||
[What this project is about]
|
||||
|
||||
## Current Status
|
||||
[Where things stand]
|
||||
|
||||
## Key Decisions
|
||||
[Important choices made]
|
||||
|
||||
## Next Steps
|
||||
[What needs to happen]
|
||||
|
||||
## Context for Claude
|
||||
[Specific things Claude should know]
|
||||
```
|
||||
|
||||
## Smart Context Loading
|
||||
|
||||
### Recent Activity
|
||||
Automatically includes:
|
||||
```javascript
|
||||
// Last 7 days of daily notes
|
||||
const recentNotes = getDailyNotes(7);
|
||||
// Current week's review
|
||||
const weeklyReview = getCurrentWeekReview();
|
||||
// Active project updates
|
||||
const activeProjects = getModifiedProjects(3); // days
|
||||
```
|
||||
|
||||
### Selective Loading
|
||||
For focused assistance:
|
||||
```bash
|
||||
# Load only specific project
|
||||
claude code /onboard Projects/WebApp
|
||||
|
||||
# Load only certain areas
|
||||
claude code /onboard Areas/Health
|
||||
|
||||
# Full context load
|
||||
claude code /onboard all
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Project Work
|
||||
```bash
|
||||
claude code /onboard Projects/MyApp
|
||||
claude code "Help me refactor the authentication module"
|
||||
```
|
||||
|
||||
### Daily Planning
|
||||
```bash
|
||||
claude code /onboard
|
||||
claude code "Review my goals and suggest today's priorities"
|
||||
```
|
||||
|
||||
### Weekly Review
|
||||
```bash
|
||||
claude code /onboard Goals
|
||||
claude code "Analyze my week and suggest improvements"
|
||||
```
|
||||
|
||||
## Context Variables
|
||||
|
||||
Your CLAUDE.md files can include variables:
|
||||
|
||||
```markdown
|
||||
## Variables for Claude
|
||||
- DEFAULT_LANGUAGE: JavaScript
|
||||
- TIMEZONE: America/New_York
|
||||
- WORK_HOURS: 9am-5pm
|
||||
- PREFERRED_FRAMEWORKS: React, Node.js
|
||||
- COMMUNICATION_STYLE: Direct and concise
|
||||
```
|
||||
|
||||
Claude will use these for better assistance.
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Conditional Context
|
||||
```markdown
|
||||
## Context by Day
|
||||
<!-- IF: Monday -->
|
||||
Focus on weekly planning and goal setting
|
||||
<!-- IF: Friday -->
|
||||
Focus on review and closure
|
||||
<!-- ENDIF -->
|
||||
```
|
||||
|
||||
### Project Templates
|
||||
```markdown
|
||||
## When Creating New Projects
|
||||
Use this structure:
|
||||
1. Create project folder
|
||||
2. Add CLAUDE.md
|
||||
3. Set up initial files
|
||||
4. Create project note from template
|
||||
```
|
||||
|
||||
### Workflow Triggers
|
||||
```markdown
|
||||
## Automated Workflows
|
||||
When I say "morning routine":
|
||||
1. Create daily note
|
||||
2. Review yesterday's tasks
|
||||
3. Set today's priority
|
||||
4. Check calendar
|
||||
```
|
||||
|
||||
## Performance Optimization
|
||||
|
||||
### Large Vaults
|
||||
For vaults with many files:
|
||||
```javascript
|
||||
// Limit context loading
|
||||
const OPTIONS = {
|
||||
maxFiles: 10,
|
||||
maxSizePerFile: 50000, // characters
|
||||
prioritize: ["Goals", "Active Projects"]
|
||||
};
|
||||
```
|
||||
|
||||
### Caching
|
||||
Context is cached for session:
|
||||
```javascript
|
||||
// Cache duration
|
||||
const CACHE_DURATION = 3600000; // 1 hour
|
||||
// Force refresh
|
||||
claude code /onboard --refresh
|
||||
```
|
||||
|
||||
## Privacy & Security
|
||||
|
||||
### Sensitive Information
|
||||
Never include in CLAUDE.md:
|
||||
- Passwords or credentials
|
||||
- Personal identification numbers
|
||||
- Financial account details
|
||||
- Private personal information
|
||||
|
||||
### Safe Context Examples
|
||||
✅ "I work in healthcare technology"
|
||||
✅ "My projects involve web development"
|
||||
✅ "I prefer morning work sessions"
|
||||
|
||||
❌ "My SSN is..."
|
||||
❌ "My bank account..."
|
||||
❌ "My private API key..."
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Keep Context Updated
|
||||
- Review CLAUDE.md files monthly
|
||||
- Update after major decisions
|
||||
- Remove outdated information
|
||||
- Add new learnings
|
||||
|
||||
### Be Specific
|
||||
- Clear project descriptions
|
||||
- Specific preferences
|
||||
- Concrete examples
|
||||
- Defined conventions
|
||||
|
||||
### Hierarchical Information
|
||||
- Global → Area → Project → Task
|
||||
- General → Specific
|
||||
- Strategic → Tactical
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Context Not Loading?
|
||||
- Check file names (CLAUDE.md exactly)
|
||||
- Verify file permissions
|
||||
- Ensure valid markdown
|
||||
- Check file encoding (UTF-8)
|
||||
|
||||
### Too Much Context?
|
||||
- Use selective loading
|
||||
- Reduce MAX_DEPTH
|
||||
- Archive old projects
|
||||
- Clean up CLAUDE.md files
|
||||
|
||||
### Conflicting Instructions?
|
||||
- More specific overrides general
|
||||
- Project overrides global
|
||||
- Recent overrides old
|
||||
|
||||
## Integration Examples
|
||||
|
||||
### With Daily Command
|
||||
```bash
|
||||
claude code /onboard
|
||||
claude code /daily
|
||||
# Claude now knows your full context for the daily note
|
||||
```
|
||||
|
||||
### With Push Command
|
||||
```bash
|
||||
claude code /onboard
|
||||
# Make changes with Claude's help
|
||||
claude code /push "Changes guided by Claude"
|
||||
```
|
||||
|
||||
## Related Commands
|
||||
- `/daily` - Create daily note
|
||||
- `/weekly` - Run weekly review
|
||||
- `/push` - Save to Git
|
||||
|
||||
---
|
||||
|
||||
*Command Version: 1.0*
|
||||
*Optimized for: Quick context loading*
|
||||
|
||||
**Remember:** Good context leads to better assistance. Keep your CLAUDE.md files current!
|
||||
261
vault-template/.claude/commands/push.md
Normal file
261
vault-template/.claude/commands/push.md
Normal file
@@ -0,0 +1,261 @@
|
||||
# Git Push Command
|
||||
|
||||
Automates the Git workflow to save your notes with a meaningful commit message and push to remote repository.
|
||||
|
||||
## Installation
|
||||
Copy this file to `.claude/commands/push.md` in your vault root.
|
||||
|
||||
## Usage
|
||||
```
|
||||
claude code /push
|
||||
```
|
||||
|
||||
Or with a custom message:
|
||||
```
|
||||
claude code /push "Completed project planning"
|
||||
```
|
||||
|
||||
## Configuration
|
||||
Customize these settings:
|
||||
|
||||
```javascript
|
||||
// Configuration
|
||||
const DEFAULT_REMOTE = "origin";
|
||||
const DEFAULT_BRANCH = "main";
|
||||
const AUTO_PULL_FIRST = true; // Pull before pushing to avoid conflicts
|
||||
const INCLUDE_TIMESTAMP = true; // Add timestamp to commit message
|
||||
```
|
||||
|
||||
## What This Command Does
|
||||
|
||||
1. **Stages All Changes**
|
||||
- Adds all modified files
|
||||
- Includes new files
|
||||
- Removes deleted files
|
||||
|
||||
2. **Creates Smart Commit Message**
|
||||
- Uses provided message, or
|
||||
- Auto-generates from changes
|
||||
- Includes date/time stamp
|
||||
- Summarizes key modifications
|
||||
|
||||
3. **Syncs with Remote**
|
||||
- Pulls latest changes (if enabled)
|
||||
- Pushes to remote repository
|
||||
- Handles merge conflicts gracefully
|
||||
|
||||
## Commit Message Format
|
||||
|
||||
### Automatic Messages
|
||||
Based on your changes:
|
||||
```
|
||||
Daily note for 2024-01-15 + 3 project updates
|
||||
- Added: Daily Notes/2024-01-15.md
|
||||
- Modified: Projects/Learning Spanish/notes.md
|
||||
- Modified: Goals/2. Monthly Goals.md
|
||||
```
|
||||
|
||||
### With Timestamp
|
||||
```
|
||||
[2024-01-15 09:30] Completed weekly review
|
||||
```
|
||||
|
||||
### Manual Message
|
||||
```
|
||||
claude code /push "Major project milestone reached"
|
||||
```
|
||||
|
||||
## Smart Features
|
||||
|
||||
### Conflict Prevention
|
||||
```javascript
|
||||
// Always pull before push
|
||||
if (AUTO_PULL_FIRST) {
|
||||
git pull --rebase origin main
|
||||
}
|
||||
```
|
||||
|
||||
### Change Summary
|
||||
Analyzes your changes:
|
||||
- Daily notes added
|
||||
- Projects modified
|
||||
- Goals updated
|
||||
- Templates changed
|
||||
|
||||
### Safety Checks
|
||||
- Verifies Git repository exists
|
||||
- Checks for uncommitted changes
|
||||
- Ensures remote is configured
|
||||
- Validates branch exists
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
### Morning Routine
|
||||
```bash
|
||||
claude code /daily # Create daily note
|
||||
# ... work on notes ...
|
||||
claude code /push "Morning planning complete"
|
||||
```
|
||||
|
||||
### End of Day
|
||||
```bash
|
||||
# Complete daily reflection
|
||||
claude code /push # Auto-message with summary
|
||||
```
|
||||
|
||||
### After Weekly Review
|
||||
```bash
|
||||
claude code /weekly # Run weekly review
|
||||
claude code /push "Weekly review - Week 3"
|
||||
```
|
||||
|
||||
## Advanced Options
|
||||
|
||||
### Multiple Remotes
|
||||
```javascript
|
||||
// Push to multiple remotes
|
||||
const REMOTES = ["origin", "backup"];
|
||||
REMOTES.forEach(remote => {
|
||||
git push remote main
|
||||
});
|
||||
```
|
||||
|
||||
### Branch-Based Workflow
|
||||
```javascript
|
||||
// Create feature branches for projects
|
||||
const project = "new-feature";
|
||||
git checkout -b project
|
||||
git add .
|
||||
git commit -m message
|
||||
git push -u origin project
|
||||
```
|
||||
|
||||
### Automated Backups
|
||||
```javascript
|
||||
// Schedule automatic pushes
|
||||
const BACKUP_INTERVAL = 3600000; // 1 hour
|
||||
setInterval(() => {
|
||||
git add .
|
||||
git commit -m "Automated backup"
|
||||
git push
|
||||
}, BACKUP_INTERVAL);
|
||||
```
|
||||
|
||||
## Git Configuration
|
||||
|
||||
### Initial Setup
|
||||
```bash
|
||||
# Initialize repository
|
||||
git init
|
||||
|
||||
# Add remote
|
||||
git remote add origin https://github.com/username/vault.git
|
||||
|
||||
# Set user info
|
||||
git config user.name "Your Name"
|
||||
git config user.email "your.email@example.com"
|
||||
```
|
||||
|
||||
### Recommended .gitignore
|
||||
```
|
||||
.obsidian/workspace*
|
||||
.obsidian/cache
|
||||
.trash/
|
||||
.DS_Store
|
||||
```
|
||||
|
||||
## Commit Message Best Practices
|
||||
|
||||
### Good Messages
|
||||
- ✅ "Completed Q1 planning and project kickoff"
|
||||
- ✅ "Daily note: Fixed bug in authentication"
|
||||
- ✅ "Weekly review - adjusted monthly goals"
|
||||
|
||||
### Avoid
|
||||
- ❌ "Updates"
|
||||
- ❌ "Changes"
|
||||
- ❌ "WIP"
|
||||
|
||||
## Handling Conflicts
|
||||
|
||||
If conflicts occur:
|
||||
|
||||
1. **Auto-resolve attempts**
|
||||
- Favors local changes for notes
|
||||
- Merges both versions when possible
|
||||
|
||||
2. **Manual resolution needed**
|
||||
- Opens conflict markers
|
||||
- Prompts for resolution
|
||||
- Guides through process
|
||||
|
||||
## Mobile Sync via GitHub
|
||||
|
||||
This enables:
|
||||
- View notes on GitHub mobile app
|
||||
- Create issues for tasks
|
||||
- Review changes on any device
|
||||
- Emergency access from any browser
|
||||
|
||||
## Security Considerations
|
||||
|
||||
### Private Repository
|
||||
Always use private repos for personal notes:
|
||||
```bash
|
||||
# GitHub CLI
|
||||
gh repo create vault --private
|
||||
|
||||
# Or via settings
|
||||
# Repository Settings > Make Private
|
||||
```
|
||||
|
||||
### Sensitive Information
|
||||
Never commit:
|
||||
- Passwords
|
||||
- API keys
|
||||
- Personal identification
|
||||
- Financial information
|
||||
|
||||
Use `.gitignore` for sensitive files:
|
||||
```
|
||||
private/
|
||||
credentials.md
|
||||
.env
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Push Rejected?
|
||||
```bash
|
||||
# Pull first
|
||||
git pull --rebase origin main
|
||||
# Then push again
|
||||
git push origin main
|
||||
```
|
||||
|
||||
### Not a Git Repository?
|
||||
```bash
|
||||
# Initialize
|
||||
git init
|
||||
# Add remote
|
||||
git remote add origin [URL]
|
||||
```
|
||||
|
||||
### Large Files Issue?
|
||||
```bash
|
||||
# Use Git LFS for images/attachments
|
||||
git lfs track "*.png"
|
||||
git lfs track "*.pdf"
|
||||
```
|
||||
|
||||
## Related Commands
|
||||
- `/daily` - Create daily note
|
||||
- `/weekly` - Run weekly review
|
||||
- `/onboard` - Load context
|
||||
|
||||
---
|
||||
|
||||
*Command Version: 1.0*
|
||||
*Requires: Git installed and configured*
|
||||
|
||||
**Pro Tip:** Commit early and often - your future self will thank you!
|
||||
201
vault-template/.claude/commands/weekly.md
Normal file
201
vault-template/.claude/commands/weekly.md
Normal file
@@ -0,0 +1,201 @@
|
||||
# Weekly Review Command
|
||||
|
||||
Facilitates your weekly review process by creating a new review note and helping you reflect on the past week while planning the next.
|
||||
|
||||
## Installation
|
||||
Copy this file to `.claude/commands/weekly.md` in your vault root.
|
||||
|
||||
## Usage
|
||||
```
|
||||
claude code /weekly
|
||||
```
|
||||
|
||||
## Configuration
|
||||
Customize these settings for your workflow:
|
||||
|
||||
```javascript
|
||||
// Configuration (customize these)
|
||||
const WEEKLY_FOLDER = "Goals";
|
||||
const WEEKLY_TEMPLATE = "Templates/Weekly Review Template.md";
|
||||
const REVIEW_DAY = 0; // 0=Sunday, 1=Monday, etc.
|
||||
const TIME_INVESTMENT_TARGET = 30; // minutes for review
|
||||
```
|
||||
|
||||
## What This Command Does
|
||||
|
||||
1. **Creates Weekly Review Note**
|
||||
- Uses weekly review template
|
||||
- Names it with current week's date
|
||||
- Places in Goals folder
|
||||
|
||||
2. **Guides Review Process**
|
||||
- Reviews last week's accomplishments
|
||||
- Identifies incomplete tasks
|
||||
- Plans upcoming week
|
||||
- Aligns with monthly goals
|
||||
|
||||
3. **Automates Housekeeping**
|
||||
- Archives old daily notes
|
||||
- Updates project statuses
|
||||
- Cleans up completed tasks
|
||||
|
||||
## Review Process Steps
|
||||
|
||||
### Step 1: Reflection (10 minutes)
|
||||
- Review daily notes from past week
|
||||
- Identify wins and challenges
|
||||
- Capture lessons learned
|
||||
|
||||
### Step 2: Goal Alignment (10 minutes)
|
||||
- Check monthly goal progress
|
||||
- Adjust weekly priorities
|
||||
- Ensure alignment with yearly goals
|
||||
|
||||
### Step 3: Planning (10 minutes)
|
||||
- Set ONE big thing for the week
|
||||
- Schedule important tasks
|
||||
- Block time for deep work
|
||||
|
||||
## Interactive Prompts
|
||||
|
||||
The command will guide you through:
|
||||
|
||||
1. **"What were your top 3 wins this week?"**
|
||||
- Celebrates progress
|
||||
- Builds momentum
|
||||
- Documents achievements
|
||||
|
||||
2. **"What were your main challenges?"**
|
||||
- Identifies obstacles
|
||||
- Plans solutions
|
||||
- Learns from difficulties
|
||||
|
||||
3. **"What's your ONE big thing next week?"**
|
||||
- Forces prioritization
|
||||
- Creates focus
|
||||
- Drives meaningful progress
|
||||
|
||||
## Weekly Review Checklist
|
||||
|
||||
The command helps you:
|
||||
- [ ] Review all daily notes
|
||||
- [ ] Process inbox items
|
||||
- [ ] Update project statuses
|
||||
- [ ] Check upcoming calendar
|
||||
- [ ] Review monthly goals
|
||||
- [ ] Plan next week's priorities
|
||||
- [ ] Block time for important work
|
||||
- [ ] Clean digital workspace
|
||||
- [ ] Archive completed items
|
||||
- [ ] Commit changes to Git
|
||||
|
||||
## Automation Features
|
||||
|
||||
### Auto-Archive
|
||||
Moves daily notes older than 30 days to Archives:
|
||||
```javascript
|
||||
const ARCHIVE_AFTER_DAYS = 30;
|
||||
// Automatically moves old notes to Archives/YYYY/MM/
|
||||
```
|
||||
|
||||
### Project Status Update
|
||||
Prompts for each active project:
|
||||
```javascript
|
||||
// For each project folder:
|
||||
// - Update completion percentage
|
||||
// - Note blockers
|
||||
// - Set next actions
|
||||
```
|
||||
|
||||
### Habit Tracking
|
||||
Calculates habit success rates:
|
||||
```javascript
|
||||
// Counts habit checkboxes from daily notes
|
||||
// Shows completion percentage
|
||||
// Identifies patterns
|
||||
```
|
||||
|
||||
## Customization Options
|
||||
|
||||
### Different Review Days
|
||||
```javascript
|
||||
// For Monday reviews:
|
||||
const REVIEW_DAY = 1;
|
||||
|
||||
// For Friday reviews:
|
||||
const REVIEW_DAY = 5;
|
||||
```
|
||||
|
||||
### Monthly Reviews
|
||||
Add monthly review trigger:
|
||||
```javascript
|
||||
const today = new Date();
|
||||
const lastDayOfMonth = new Date(today.getFullYear(), today.getMonth() + 1, 0).getDate();
|
||||
if (today.getDate() === lastDayOfMonth) {
|
||||
// Trigger monthly review too
|
||||
}
|
||||
```
|
||||
|
||||
### Sprint-Based Reviews
|
||||
For agile workflows:
|
||||
```javascript
|
||||
const SPRINT_LENGTH = 14; // days
|
||||
const SPRINT_START = new Date('2024-01-01');
|
||||
// Calculate sprint number and adjust review
|
||||
```
|
||||
|
||||
## Integration with Goals
|
||||
|
||||
The command automatically:
|
||||
- Links to [[2. Monthly Goals]]
|
||||
- Updates [[1. Yearly Goals]] progress
|
||||
- Creates new week entry in review log
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Consistent Timing
|
||||
- Same day each week
|
||||
- Same time if possible
|
||||
- Block calendar time
|
||||
- Treat as non-negotiable
|
||||
|
||||
### Preparation
|
||||
- Clean inbox before review
|
||||
- Have calendar ready
|
||||
- Gather project updates
|
||||
- Review any feedback
|
||||
|
||||
### Follow-through
|
||||
- Share highlights with team/family
|
||||
- Update external systems
|
||||
- Communicate changes
|
||||
- Celebrate wins
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Review not created?
|
||||
- Check template exists
|
||||
- Verify folder structure
|
||||
- Ensure write permissions
|
||||
|
||||
### Links broken?
|
||||
- Verify file naming
|
||||
- Check date formats
|
||||
- Update link syntax
|
||||
|
||||
### Too time-consuming?
|
||||
- Use timer for each section
|
||||
- Prepare throughout week
|
||||
- Simplify template
|
||||
|
||||
## Related Commands
|
||||
- `/daily` - Create daily note
|
||||
- `/push` - Commit to Git
|
||||
- `/onboard` - Load all context
|
||||
|
||||
---
|
||||
|
||||
*Command Version: 1.0*
|
||||
*Optimal Time: Sunday evening or Monday morning*
|
||||
|
||||
**Remember:** The best review is the one you actually do. Keep it simple and consistent!
|
||||
0
vault-template/Archives/.gitkeep
Normal file
0
vault-template/Archives/.gitkeep
Normal file
158
vault-template/CLAUDE.md
Normal file
158
vault-template/CLAUDE.md
Normal file
@@ -0,0 +1,158 @@
|
||||
# Navigation & Context Guide for Claude Code
|
||||
|
||||
## 🎯 System Purpose
|
||||
[CUSTOMIZE THIS: Add your personal mission statement or life purpose here]
|
||||
*Example: "Build meaningful technology that improves people's lives while maintaining balance and growth in all life areas."*
|
||||
|
||||
## 📁 Directory Structure & Purpose
|
||||
|
||||
### Core Directories
|
||||
- **Daily Notes/** - Daily journal entries and task management
|
||||
- Named as `YYYY-MM-DD.md` format
|
||||
- Contains daily planning, tasks, and reflections
|
||||
|
||||
- **Goals/** - Cascading goal system (3-year → yearly → monthly → weekly)
|
||||
- Start with `0. Three Year Goals.md` for vision
|
||||
- Break down into actionable items in `3. Weekly Review.md`
|
||||
|
||||
- **Projects/** - Active project folders
|
||||
- Each project gets its own folder
|
||||
- Include project-specific `CLAUDE.md` for context
|
||||
|
||||
- **Templates/** - Reusable note structures
|
||||
- `Daily Template.md` - For daily notes
|
||||
- `Weekly Review Template.md` - For weekly planning
|
||||
- `Project Template.md` - For new projects
|
||||
|
||||
- **Archives/** - Completed or inactive content
|
||||
- Move completed projects here
|
||||
- Store old daily notes after monthly review
|
||||
|
||||
## 🏷️ Key Tags to Use
|
||||
|
||||
### Priority Tags
|
||||
- `#priority/high` - Must do today
|
||||
- `#priority/medium` - Should do this week
|
||||
- `#priority/low` - Nice to have
|
||||
|
||||
### Context Tags
|
||||
- `#work` - Professional tasks
|
||||
- `#personal` - Personal development
|
||||
- `#health` - Wellness activities
|
||||
- `#family` - Relationships
|
||||
- `#learning` - Skill development
|
||||
|
||||
### Status Tags
|
||||
- `#active` - Currently working on
|
||||
- `#waiting` - Blocked or waiting
|
||||
- `#completed` - Done
|
||||
- `#archived` - No longer relevant
|
||||
|
||||
[CUSTOMIZE THIS: Add your own tag system based on your workflow]
|
||||
|
||||
## 🔄 Workflow Instructions
|
||||
|
||||
### Daily Workflow
|
||||
1. **Morning (5 min)**
|
||||
- Run `claude code /daily` to create today's note
|
||||
- Review yesterday's unfinished tasks
|
||||
- Set ONE main focus for today
|
||||
- Plan your time blocks
|
||||
|
||||
2. **Throughout the Day**
|
||||
- Check off completed tasks
|
||||
- Add thoughts and insights
|
||||
- Capture new ideas in appropriate sections
|
||||
|
||||
3. **Evening (5 min)**
|
||||
- Complete reflection section
|
||||
- Move unfinished tasks to tomorrow
|
||||
- Run `claude code /push` to save changes
|
||||
|
||||
### Weekly Workflow
|
||||
1. **Weekly Review (30 min)**
|
||||
- Run `claude code /weekly` on Sunday
|
||||
- Review past week's accomplishments
|
||||
- Align next week with monthly goals
|
||||
- Clean up and archive old notes
|
||||
|
||||
### Project Management
|
||||
1. **Starting a Project**
|
||||
- Create folder in `Projects/`
|
||||
- Add project-specific `CLAUDE.md`
|
||||
- Define success criteria
|
||||
- Break into actionable tasks
|
||||
|
||||
2. **During Project**
|
||||
- Keep all related notes in project folder
|
||||
- Update project CLAUDE.md with progress
|
||||
- Link to relevant daily notes
|
||||
|
||||
3. **Completing Project**
|
||||
- Create summary document
|
||||
- Move to `Archives/`
|
||||
- Extract lessons learned
|
||||
|
||||
## 🤖 Claude Code Integration
|
||||
|
||||
### Available Commands
|
||||
- `/daily` - Creates today's daily note from template
|
||||
- `/weekly` - Runs weekly review process
|
||||
- `/push` - Commits and pushes changes to Git
|
||||
- `/onboard` - Reads all CLAUDE.md files for context
|
||||
|
||||
### Best Practices with Claude
|
||||
1. **Be Specific** - Give clear context about what you need
|
||||
2. **Use Project Context** - Reference project CLAUDE.md files
|
||||
3. **Iterate** - Claude can help refine and improve your notes
|
||||
4. **Review Suggestions** - Claude's suggestions are starting points
|
||||
|
||||
## 📱 Mobile Access (via GitHub)
|
||||
|
||||
### Setup
|
||||
1. Initialize git in your vault
|
||||
2. Create private GitHub repository
|
||||
3. Set up GitHub Action (see `github-actions/claude.yml`)
|
||||
4. Access notes via GitHub mobile app
|
||||
|
||||
### Mobile Workflow
|
||||
1. View notes on GitHub mobile
|
||||
2. Create issues for tasks/ideas
|
||||
3. Claude processes issues automatically
|
||||
4. Sync when back at desktop
|
||||
|
||||
## 🎨 Customization Points
|
||||
|
||||
[CUSTOMIZE THIS SECTION: Add your specific preferences]
|
||||
|
||||
### My Preferences
|
||||
- **Daily Note Time**: [Morning/Evening]
|
||||
- **Review Day**: [Sunday/Monday]
|
||||
- **Time Blocking**: [Yes/No]
|
||||
- **Task Management Style**: [GTD/Simple/Custom]
|
||||
|
||||
### Custom Shortcuts
|
||||
- [Add your frequently used searches]
|
||||
- [Add your common templates]
|
||||
- [Add your workflow triggers]
|
||||
|
||||
## 📚 Resources & References
|
||||
|
||||
### Internal Links
|
||||
- [[0. Three Year Goals]] - Long-term vision
|
||||
- [[1. Yearly Goals]] - Current year focus
|
||||
- [[2. Monthly Goals]] - This month's objectives
|
||||
- [[3. Weekly Review]] - Weekly planning
|
||||
|
||||
### External Resources
|
||||
[CUSTOMIZE THIS: Add your favorite references]
|
||||
- [Resource 1]
|
||||
- [Resource 2]
|
||||
- [Resource 3]
|
||||
|
||||
---
|
||||
|
||||
*Last Updated: [DATE]*
|
||||
*System Version: 1.0*
|
||||
|
||||
**Remember**: This system is meant to serve you, not constrain you. Adapt it as needed!
|
||||
0
vault-template/Daily Notes/.gitkeep
Normal file
0
vault-template/Daily Notes/.gitkeep
Normal file
158
vault-template/Daily Notes/2024-01-15-EXAMPLE.md
Normal file
158
vault-template/Daily Notes/2024-01-15-EXAMPLE.md
Normal file
@@ -0,0 +1,158 @@
|
||||
---
|
||||
date: 2024-01-15
|
||||
tags: daily-note
|
||||
---
|
||||
|
||||
# Monday, January 15, 2024
|
||||
|
||||
_"Every day, I choose to grow, contribute, and live with intention."_
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Today's Focus
|
||||
*What's the ONE thing that would make today a win?*
|
||||
|
||||
**Today's Priority:** Complete Spanish Chapter 3 exercises and have successful conversation practice session
|
||||
|
||||
---
|
||||
|
||||
## ⏰ Time Blocks
|
||||
*Plan your day with intentional time allocation*
|
||||
|
||||
- **Morning (6-9am):** Morning routine + Spanish vocabulary review
|
||||
- **Mid-Morning (9-12pm):** Deep work on Q1 project proposal
|
||||
- **Afternoon (12-3pm):** Team meetings + client call
|
||||
- **Late Afternoon (3-6pm):** Spanish tutoring session + exercises
|
||||
- **Evening (6-9pm):** Family dinner + reading time
|
||||
|
||||
---
|
||||
|
||||
## ✅ Tasks
|
||||
|
||||
### 🔴 Must Do Today
|
||||
- [x] Complete project proposal draft
|
||||
- [x] Spanish tutoring session at 4 PM
|
||||
- [ ] Review and respond to urgent emails
|
||||
|
||||
### 💼 Work
|
||||
- [x] Team standup at 9:30 AM
|
||||
- [x] Client presentation prep
|
||||
- [ ] Update project timeline
|
||||
- [x] Submit expense report
|
||||
|
||||
### 🏠 Personal
|
||||
- [x] Grocery shopping for dinner
|
||||
- [ ] Call mom for her birthday
|
||||
- [x] Pay utility bills
|
||||
|
||||
### 📚 Learning/Growth
|
||||
- [x] Spanish Chapter 3 exercises (completed 8/10)
|
||||
- [x] Read 20 pages of "Atomic Habits"
|
||||
- [x] Watch one Spanish podcast episode
|
||||
|
||||
### 🏃 Health/Wellness
|
||||
- [x] Morning routine completed
|
||||
- [x] Exercise: 30-minute run
|
||||
- [x] Meditation: 10 minutes
|
||||
- [x] Water intake: 6/8 glasses
|
||||
|
||||
---
|
||||
|
||||
## 💡 Ideas & Thoughts
|
||||
*Capture anything that comes to mind*
|
||||
|
||||
- Consider creating a Spanish immersion weekend next month
|
||||
- Project proposal needs more concrete metrics - add by tomorrow
|
||||
- New coffee shop on Main St. looks interesting for remote work
|
||||
- Should we plan a family trip for spring break?
|
||||
|
||||
---
|
||||
|
||||
## 📝 Notes from Today
|
||||
|
||||
### Meetings
|
||||
- **Team Standup:**
|
||||
- Key points: Q1 priorities aligned, need to hire new developer
|
||||
- Action items: Post job listing by Wednesday
|
||||
|
||||
- **Client Call (ABC Corp):**
|
||||
- They want to expand scope
|
||||
- Budget increase approved
|
||||
- Follow-up meeting scheduled for Thursday
|
||||
|
||||
### Important Info
|
||||
- Spanish tutor recommended "Cien Años de Soledad" for reading practice
|
||||
- Colleague shared useful project management template
|
||||
- Reminder: Team lunch scheduled for Friday
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Gratitude
|
||||
*Three things I'm grateful for today*
|
||||
|
||||
1. Productive morning with no interruptions
|
||||
2. Progress in Spanish - understood most of the podcast!
|
||||
3. Beautiful weather for evening walk with family
|
||||
|
||||
---
|
||||
|
||||
## 🔍 End of Day Reflection
|
||||
*Complete before bed*
|
||||
|
||||
### What Went Well?
|
||||
- Completed project proposal ahead of deadline
|
||||
- Spanish conversation practice was best yet - spoke for 20 minutes!
|
||||
- Maintained energy throughout the day
|
||||
|
||||
### What Could Be Better?
|
||||
- Started work emails before morning routine - avoid this
|
||||
- Didn't take proper lunch break
|
||||
- Forgot to call mom - do it first thing tomorrow
|
||||
|
||||
### What Did I Learn?
|
||||
- Batching similar tasks (all emails at once) saves significant time
|
||||
- Spanish subjunctive finally clicking after tutor's explanation
|
||||
- Need buffer time between meetings for context switching
|
||||
|
||||
### Tomorrow's #1 Priority
|
||||
- Finalize and submit project proposal with client feedback incorporated
|
||||
|
||||
### Energy Level Today
|
||||
- Physical: 8/10
|
||||
- Mental: 7/10
|
||||
- Emotional: 9/10
|
||||
|
||||
---
|
||||
|
||||
## 📊 Daily Metrics
|
||||
- Deep Work Time: 3.5 hours
|
||||
- Shallow Work Time: 2 hours
|
||||
- Tasks Completed: 14/17
|
||||
- Inbox Zero: Yes
|
||||
- Screen Time: 6 hours
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related
|
||||
- [[3. Weekly Review|This Week's Plan]]
|
||||
- [[2. Monthly Goals|This Month's Focus]]
|
||||
- Yesterday: [[2024-01-14]]
|
||||
- Tomorrow: [[2024-01-16]]
|
||||
|
||||
---
|
||||
|
||||
*Day 15 of 365*
|
||||
*Week 3 of 52*
|
||||
|
||||
**Today's Affirmation:** "I am capable of learning and growing every single day."
|
||||
|
||||
---
|
||||
|
||||
**Note:** This is an example daily note showing how the template is used in practice. Notice how it:
|
||||
- Started with a clear focus
|
||||
- Tracked progress throughout the day
|
||||
- Captured ideas and thoughts as they arose
|
||||
- Included honest reflection at day's end
|
||||
- Connected to the larger goal system
|
||||
|
||||
Your daily notes will reflect your unique life, priorities, and style!
|
||||
122
vault-template/Goals/0. Three Year Goals.md
Normal file
122
vault-template/Goals/0. Three Year Goals.md
Normal file
@@ -0,0 +1,122 @@
|
||||
# Three Year Goals (2024-2027)
|
||||
|
||||
## 🌟 Vision Statement
|
||||
*[CUSTOMIZE THIS: What do you want your life to look like in 3 years? Be specific and inspiring.]*
|
||||
|
||||
Example: "In three years, I will be leading a balanced life where I'm making meaningful contributions through my work, maintaining excellent health, nurturing deep relationships, and continuously growing as a person."
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Key Life Areas
|
||||
|
||||
### 💼 Career & Professional Development
|
||||
*Where do you want to be professionally?*
|
||||
|
||||
- [ ] [CUSTOMIZE: Major career milestone]
|
||||
- *Example: "Reach senior/leadership position in my field"*
|
||||
- [ ] [CUSTOMIZE: Skill development goal]
|
||||
- *Example: "Master 3 new technologies/skills relevant to my industry"*
|
||||
- [ ] [CUSTOMIZE: Income/financial goal]
|
||||
- *Example: "Increase income by X% or reach specific salary target"*
|
||||
- [ ] [CUSTOMIZE: Impact/contribution goal]
|
||||
- *Example: "Lead a project that impacts 10,000+ users"*
|
||||
|
||||
### 🏃 Health & Wellness
|
||||
*What does optimal health look like for you?*
|
||||
|
||||
- [ ] [CUSTOMIZE: Fitness goal]
|
||||
- *Example: "Complete a marathon/triathlon"*
|
||||
- [ ] [CUSTOMIZE: Health metric goal]
|
||||
- *Example: "Maintain healthy BMI and blood markers"*
|
||||
- [ ] [CUSTOMIZE: Mental health goal]
|
||||
- *Example: "Develop consistent meditation practice"*
|
||||
- [ ] [CUSTOMIZE: Energy/vitality goal]
|
||||
- *Example: "Have energy for both work and play every day"*
|
||||
|
||||
### ❤️ Relationships & Family
|
||||
*How do you want your relationships to evolve?*
|
||||
|
||||
- [ ] [CUSTOMIZE: Family goal]
|
||||
- *Example: "Spend quality time with family weekly"*
|
||||
- [ ] [CUSTOMIZE: Partnership goal]
|
||||
- *Example: "Deepen relationship with partner/find life partner"*
|
||||
- [ ] [CUSTOMIZE: Friendship goal]
|
||||
- *Example: "Maintain close friendships despite busy life"*
|
||||
- [ ] [CUSTOMIZE: Community goal]
|
||||
- *Example: "Be actively involved in local community"*
|
||||
|
||||
### 🌱 Personal Growth & Learning
|
||||
*Who do you want to become?*
|
||||
|
||||
- [ ] [CUSTOMIZE: Knowledge goal]
|
||||
- *Example: "Read 50 books per year"*
|
||||
- [ ] [CUSTOMIZE: Skill goal]
|
||||
- *Example: "Become fluent in a new language"*
|
||||
- [ ] [CUSTOMIZE: Habit goal]
|
||||
- *Example: "Establish morning routine that sets up successful days"*
|
||||
- [ ] [CUSTOMIZE: Character goal]
|
||||
- *Example: "Develop greater patience and emotional intelligence"*
|
||||
|
||||
### 💰 Financial Security
|
||||
*What does financial success mean to you?*
|
||||
|
||||
- [ ] [CUSTOMIZE: Savings goal]
|
||||
- *Example: "Build 12-month emergency fund"*
|
||||
- [ ] [CUSTOMIZE: Investment goal]
|
||||
- *Example: "Grow investment portfolio to $X"*
|
||||
- [ ] [CUSTOMIZE: Debt goal]
|
||||
- *Example: "Eliminate all high-interest debt"*
|
||||
- [ ] [CUSTOMIZE: Asset goal]
|
||||
- *Example: "Own home/investment property"*
|
||||
|
||||
### 🎨 Creativity & Hobbies
|
||||
*What brings you joy and fulfillment?*
|
||||
|
||||
- [ ] [CUSTOMIZE: Creative project]
|
||||
- *Example: "Complete novel/album/art series"*
|
||||
- [ ] [CUSTOMIZE: Hobby mastery]
|
||||
- *Example: "Achieve expertise level in hobby"*
|
||||
- [ ] [CUSTOMIZE: Experience goal]
|
||||
- *Example: "Travel to 10 new countries"*
|
||||
- [ ] [CUSTOMIZE: Fun goal]
|
||||
- *Example: "Try 50 new experiences"*
|
||||
|
||||
---
|
||||
|
||||
## 📊 Success Metrics
|
||||
*How will you know you're on track?*
|
||||
|
||||
### Year 1 Milestones
|
||||
- [CUSTOMIZE: What needs to happen in the first year?]
|
||||
|
||||
### Year 2 Milestones
|
||||
- [CUSTOMIZE: What builds on year 1?]
|
||||
|
||||
### Year 3 Milestones
|
||||
- [CUSTOMIZE: What completes the vision?]
|
||||
|
||||
---
|
||||
|
||||
## 💭 Reflection Questions
|
||||
*Review these quarterly:*
|
||||
|
||||
1. Which goals still resonate with my values?
|
||||
2. What has changed in my life that affects these goals?
|
||||
3. What goals need to be adjusted or replaced?
|
||||
4. What am I willing to sacrifice to achieve these?
|
||||
5. Who can help me achieve these goals?
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related Documents
|
||||
- [[1. Yearly Goals]] - Current year breakdown
|
||||
- [[2. Monthly Goals]] - Current month focus
|
||||
- [[3. Weekly Review]] - Weekly execution
|
||||
|
||||
---
|
||||
|
||||
*Created: [DATE]*
|
||||
*Last Review: [DATE]*
|
||||
*Next Review: [QUARTERLY DATE]*
|
||||
|
||||
**Remember**: These goals should inspire you to action, not overwhelm you. Adjust as life evolves!
|
||||
153
vault-template/Goals/1. Yearly Goals.md
Normal file
153
vault-template/Goals/1. Yearly Goals.md
Normal file
@@ -0,0 +1,153 @@
|
||||
# Yearly Goals - 2024
|
||||
|
||||
## 🎯 ONE METRIC THAT MATTERS
|
||||
*[CUSTOMIZE THIS: What single metric would indicate a successful year?]*
|
||||
|
||||
Example: "Complete 3 major projects that directly impact 1000+ people"
|
||||
|
||||
Current Status: `[0/3 projects]` - Updated: [DATE]
|
||||
|
||||
---
|
||||
|
||||
## 📍 Annual Theme
|
||||
*[CUSTOMIZE THIS: Give your year a theme/focus word]*
|
||||
|
||||
Examples: "Foundation" / "Growth" / "Balance" / "Execution" / "Learning"
|
||||
|
||||
**My 2024 Theme:** [YOUR THEME]
|
||||
|
||||
*Why this theme?* [Brief explanation of why this resonates]
|
||||
|
||||
---
|
||||
|
||||
## 🗓️ Quarterly Breakdown
|
||||
|
||||
### Q1 (Jan-Mar) - Foundation
|
||||
**Focus:** [CUSTOMIZE: Main focus for Q1]
|
||||
|
||||
Key Outcomes:
|
||||
- [ ] [Specific measurable outcome]
|
||||
- [ ] [Specific measurable outcome]
|
||||
- [ ] [Specific measurable outcome]
|
||||
|
||||
### Q2 (Apr-Jun) - Building
|
||||
**Focus:** [CUSTOMIZE: Main focus for Q2]
|
||||
|
||||
Key Outcomes:
|
||||
- [ ] [Specific measurable outcome]
|
||||
- [ ] [Specific measurable outcome]
|
||||
- [ ] [Specific measurable outcome]
|
||||
|
||||
### Q3 (Jul-Sep) - Acceleration
|
||||
**Focus:** [CUSTOMIZE: Main focus for Q3]
|
||||
|
||||
Key Outcomes:
|
||||
- [ ] [Specific measurable outcome]
|
||||
- [ ] [Specific measurable outcome]
|
||||
- [ ] [Specific measurable outcome]
|
||||
|
||||
### Q4 (Oct-Dec) - Completion
|
||||
**Focus:** [CUSTOMIZE: Main focus for Q4]
|
||||
|
||||
Key Outcomes:
|
||||
- [ ] [Specific measurable outcome]
|
||||
- [ ] [Specific measurable outcome]
|
||||
- [ ] [Specific measurable outcome]
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Annual Goals by Life Area
|
||||
*Derived from [[0. Three Year Goals]]*
|
||||
|
||||
### 💼 Career & Professional (25% of effort)
|
||||
- [ ] **Goal 1:** [CUSTOMIZE: Specific measurable goal]
|
||||
- Q1: [Milestone]
|
||||
- Q2: [Milestone]
|
||||
- Q3: [Milestone]
|
||||
- Q4: [Milestone]
|
||||
- [ ] **Goal 2:** [CUSTOMIZE: Specific measurable goal]
|
||||
- [ ] **Goal 3:** [CUSTOMIZE: Specific measurable goal]
|
||||
|
||||
### 🏃 Health & Wellness (20% of effort)
|
||||
- [ ] **Goal 1:** [CUSTOMIZE: Specific measurable goal]
|
||||
- Habit to build: [Daily/weekly action]
|
||||
- Success metric: [How to measure]
|
||||
- [ ] **Goal 2:** [CUSTOMIZE: Specific measurable goal]
|
||||
|
||||
### ❤️ Relationships (20% of effort)
|
||||
- [ ] **Goal 1:** [CUSTOMIZE: Specific measurable goal]
|
||||
- Monthly commitment: [Specific action]
|
||||
- [ ] **Goal 2:** [CUSTOMIZE: Specific measurable goal]
|
||||
|
||||
### 🌱 Personal Growth (20% of effort)
|
||||
- [ ] **Goal 1:** [CUSTOMIZE: Specific measurable goal]
|
||||
- Resources needed: [Books/courses/mentors]
|
||||
- [ ] **Goal 2:** [CUSTOMIZE: Specific measurable goal]
|
||||
|
||||
### 💰 Financial (10% of effort)
|
||||
- [ ] **Goal 1:** [CUSTOMIZE: Specific measurable goal]
|
||||
- Monthly target: [$X]
|
||||
- [ ] **Goal 2:** [CUSTOMIZE: Specific measurable goal]
|
||||
|
||||
### 🎨 Creativity & Fun (5% of effort)
|
||||
- [ ] **Goal 1:** [CUSTOMIZE: Specific measurable goal]
|
||||
- Fun factor: [Why this matters]
|
||||
|
||||
---
|
||||
|
||||
## 📅 Key Dates & Deadlines
|
||||
|
||||
### Fixed Commitments
|
||||
- [DATE]: [CUSTOMIZE: Important deadline/event]
|
||||
- [DATE]: [CUSTOMIZE: Important deadline/event]
|
||||
|
||||
### Target Completion Dates
|
||||
- [DATE]: Complete [specific goal]
|
||||
- [DATE]: Launch [specific project]
|
||||
- [DATE]: Achieve [specific milestone]
|
||||
|
||||
---
|
||||
|
||||
## 🚫 NOT Doing This Year
|
||||
*Equally important - what are you saying NO to?*
|
||||
|
||||
1. [CUSTOMIZE: Thing you're deliberately not pursuing]
|
||||
2. [CUSTOMIZE: Time-waster you're eliminating]
|
||||
3. [CUSTOMIZE: Commitment you're avoiding]
|
||||
|
||||
---
|
||||
|
||||
## 📊 Monthly Check-in Template
|
||||
|
||||
### Status Check (Copy for each month)
|
||||
**Month: [MONTH]**
|
||||
- One Metric Progress: [X/target]
|
||||
- Energy Level: [1-10]
|
||||
- On Track? [Yes/No/Adjust]
|
||||
- Key Win: [What went well]
|
||||
- Key Learning: [What to improve]
|
||||
- Next Month Focus: [Single priority]
|
||||
|
||||
---
|
||||
|
||||
## 🏆 Year-End Vision
|
||||
*Write this as if it's December 31st, 2024*
|
||||
|
||||
[CUSTOMIZE: Write 3-5 sentences describing your ideal year-end state. How do you feel? What have you accomplished? What has changed?]
|
||||
|
||||
Example: "It's December 31st, 2024, and I'm reflecting on an incredible year. I successfully launched three projects that are now helping thousands of people. My health is the best it's been in years, with consistent exercise and meditation habits. My relationships are deeper and more meaningful. I feel proud, energized, and ready for even bigger challenges in 2025."
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Supporting Documents
|
||||
- [[0. Three Year Goals]] - Long-term vision
|
||||
- [[2. Monthly Goals]] - Current month execution
|
||||
- [[3. Weekly Review]] - Weekly planning
|
||||
|
||||
---
|
||||
|
||||
*Created: [DATE]*
|
||||
*Last Monthly Review: [DATE]*
|
||||
*Next Review: [First of next month]*
|
||||
|
||||
**Reminder**: Progress > Perfection. Adjust goals as you learn!
|
||||
191
vault-template/Goals/2. Monthly Goals.md
Normal file
191
vault-template/Goals/2. Monthly Goals.md
Normal file
@@ -0,0 +1,191 @@
|
||||
# Monthly Goals - [MONTH YEAR]
|
||||
|
||||
## 🎯 Monthly Focus
|
||||
*[CUSTOMIZE: What's the ONE thing that would make this month a success?]*
|
||||
|
||||
**This Month's Priority:** [Clear, specific objective]
|
||||
|
||||
---
|
||||
|
||||
## 📊 Month at a Glance
|
||||
|
||||
### Key Metrics
|
||||
- **One Metric Progress:** [Current]/[Target] (from [[1. Yearly Goals]])
|
||||
- **Week 1 Focus:** [Main objective]
|
||||
- **Week 2 Focus:** [Main objective]
|
||||
- **Week 3 Focus:** [Main objective]
|
||||
- **Week 4 Focus:** [Main objective]
|
||||
|
||||
### Important Dates
|
||||
- [DATE]: [Event/Deadline]
|
||||
- [DATE]: [Event/Deadline]
|
||||
- [DATE]: [Event/Deadline]
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Monthly Goals
|
||||
*Derived from quarterly goals in [[1. Yearly Goals]]*
|
||||
|
||||
### 🔴 Must Complete (Non-negotiable)
|
||||
- [ ] **Goal 1:** [CUSTOMIZE: Specific, measurable goal]
|
||||
- Success criteria: [How you'll know it's done]
|
||||
- Due: [Week of month]
|
||||
- [ ] **Goal 2:** [CUSTOMIZE: Specific, measurable goal]
|
||||
- Success criteria: [How you'll know it's done]
|
||||
- Due: [Week of month]
|
||||
- [ ] **Goal 3:** [CUSTOMIZE: Specific, measurable goal]
|
||||
- Success criteria: [How you'll know it's done]
|
||||
- Due: [Week of month]
|
||||
|
||||
### 🟡 Should Complete (Important but flexible)
|
||||
- [ ] **Goal 4:** [CUSTOMIZE: Goal with some flexibility]
|
||||
- Why it matters: [Connection to yearly goals]
|
||||
- [ ] **Goal 5:** [CUSTOMIZE: Goal with some flexibility]
|
||||
- Why it matters: [Connection to yearly goals]
|
||||
|
||||
### 🟢 Nice to Complete (Bonus)
|
||||
- [ ] **Goal 6:** [CUSTOMIZE: Stretch goal]
|
||||
- [ ] **Goal 7:** [CUSTOMIZE: Stretch goal]
|
||||
|
||||
---
|
||||
|
||||
## 📝 Projects & Initiatives
|
||||
|
||||
### Active Projects
|
||||
1. **[PROJECT NAME]**
|
||||
- This month's milestone: [Specific deliverable]
|
||||
- Time allocated: [X hours/week]
|
||||
- Status: [On track/Behind/Ahead]
|
||||
|
||||
2. **[PROJECT NAME]**
|
||||
- This month's milestone: [Specific deliverable]
|
||||
- Time allocated: [X hours/week]
|
||||
- Status: [On track/Behind/Ahead]
|
||||
|
||||
### Habits to Build/Maintain
|
||||
- [ ] **Daily:** [CUSTOMIZE: Daily habit]
|
||||
- Streak: [X days]
|
||||
- [ ] **Weekly:** [CUSTOMIZE: Weekly habit]
|
||||
- Completed: [X/4 weeks]
|
||||
- [ ] **Monthly:** [CUSTOMIZE: Monthly habit]
|
||||
- Scheduled for: [DATE]
|
||||
|
||||
---
|
||||
|
||||
## 🗓️ Weekly Planning
|
||||
|
||||
### Week 1 ([DATE RANGE])
|
||||
**Theme:** [Focus area]
|
||||
- [ ] [Key task 1]
|
||||
- [ ] [Key task 2]
|
||||
- [ ] [Key task 3]
|
||||
- **Weekly Review Date:** [DATE]
|
||||
|
||||
### Week 2 ([DATE RANGE])
|
||||
**Theme:** [Focus area]
|
||||
- [ ] [Key task 1]
|
||||
- [ ] [Key task 2]
|
||||
- [ ] [Key task 3]
|
||||
- **Weekly Review Date:** [DATE]
|
||||
|
||||
### Week 3 ([DATE RANGE])
|
||||
**Theme:** [Focus area]
|
||||
- [ ] [Key task 1]
|
||||
- [ ] [Key task 2]
|
||||
- [ ] [Key task 3]
|
||||
- **Weekly Review Date:** [DATE]
|
||||
|
||||
### Week 4 ([DATE RANGE])
|
||||
**Theme:** [Focus area]
|
||||
- [ ] [Key task 1]
|
||||
- [ ] [Key task 2]
|
||||
- [ ] [Key task 3]
|
||||
- **Monthly Review Date:** [DATE]
|
||||
|
||||
---
|
||||
|
||||
## 💡 Learning & Development
|
||||
|
||||
### This Month I'm Learning
|
||||
- **Primary Focus:** [CUSTOMIZE: Main learning goal]
|
||||
- Resource: [Book/Course/Mentor]
|
||||
- Time commitment: [X hours/week]
|
||||
- Success metric: [How you'll measure learning]
|
||||
|
||||
### Books/Content to Consume
|
||||
- [ ] Book: [Title - Author]
|
||||
- [ ] Course: [Course name - Platform]
|
||||
- [ ] Article/Video: [Title - Source]
|
||||
|
||||
---
|
||||
|
||||
## 🚫 Not This Month
|
||||
*Protect your focus - what are you intentionally NOT doing?*
|
||||
|
||||
1. [CUSTOMIZE: Project/commitment you're postponing]
|
||||
2. [CUSTOMIZE: Distraction you're avoiding]
|
||||
3. [CUSTOMIZE: Request you're declining]
|
||||
|
||||
---
|
||||
|
||||
## 📈 Progress Tracking
|
||||
|
||||
### Week 1 Review
|
||||
- **Completed:** [X/Y tasks]
|
||||
- **Key Win:** [Best accomplishment]
|
||||
- **Key Challenge:** [Main obstacle]
|
||||
- **Next Week Adjustment:** [What to change]
|
||||
|
||||
### Week 2 Review
|
||||
- **Completed:** [X/Y tasks]
|
||||
- **Key Win:** [Best accomplishment]
|
||||
- **Key Challenge:** [Main obstacle]
|
||||
- **Next Week Adjustment:** [What to change]
|
||||
|
||||
### Week 3 Review
|
||||
- **Completed:** [X/Y tasks]
|
||||
- **Key Win:** [Best accomplishment]
|
||||
- **Key Challenge:** [Main obstacle]
|
||||
- **Next Week Adjustment:** [What to change]
|
||||
|
||||
### Week 4 Review
|
||||
- **Completed:** [X/Y tasks]
|
||||
- **Key Win:** [Best accomplishment]
|
||||
- **Key Challenge:** [Main obstacle]
|
||||
- **Next Month Focus:** [Main priority]
|
||||
|
||||
---
|
||||
|
||||
## 🎯 End of Month Review
|
||||
|
||||
### Accomplishments
|
||||
- [COMPLETE AT MONTH END: List major wins]
|
||||
|
||||
### Lessons Learned
|
||||
- [COMPLETE AT MONTH END: Key insights]
|
||||
|
||||
### To Carry Forward
|
||||
- [COMPLETE AT MONTH END: Incomplete items for next month]
|
||||
|
||||
### Energy & Wellbeing Score
|
||||
- Physical Health: [1-10]
|
||||
- Mental Health: [1-10]
|
||||
- Relationships: [1-10]
|
||||
- Work Satisfaction: [1-10]
|
||||
- Overall Life Satisfaction: [1-10]
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related Documents
|
||||
- [[1. Yearly Goals]] - Annual objectives
|
||||
- [[3. Weekly Review]] - Weekly execution
|
||||
- Previous Month: [[2. Monthly Goals - [PREVIOUS MONTH]]]
|
||||
- Next Month: [[2. Monthly Goals - [NEXT MONTH]]]
|
||||
|
||||
---
|
||||
|
||||
*Created: [First day of month]*
|
||||
*Last Updated: [DATE]*
|
||||
*Month End Review: [Last day of month]*
|
||||
|
||||
**Remember**: This month is just one chapter in your yearly story. Focus on progress, not perfection!
|
||||
224
vault-template/Goals/3. Weekly Review.md
Normal file
224
vault-template/Goals/3. Weekly Review.md
Normal file
@@ -0,0 +1,224 @@
|
||||
# Weekly Review - Week of [DATE]
|
||||
|
||||
## 🎯 Week at a Glance
|
||||
**Week Number:** [Week X of 52]
|
||||
**Theme/Focus:** [CUSTOMIZE: This week's primary focus area]
|
||||
**Energy Available:** [High/Medium/Low]
|
||||
|
||||
---
|
||||
|
||||
## 📊 Quick Stats
|
||||
- **Tasks Completed:** [X/Y]
|
||||
- **Projects Advanced:** [List]
|
||||
- **Habits Maintained:** [X/Y days]
|
||||
- **One Metric Progress:** [Update from yearly goal]
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Last Week Review
|
||||
|
||||
### What Went Well? (Wins)
|
||||
1. [CUSTOMIZE: Significant accomplishment]
|
||||
2. [CUSTOMIZE: Positive development]
|
||||
3. [CUSTOMIZE: Something you're proud of]
|
||||
|
||||
### What Didn't Go Well? (Challenges)
|
||||
1. [CUSTOMIZE: Main obstacle faced]
|
||||
2. [CUSTOMIZE: What got in the way]
|
||||
3. [CUSTOMIZE: What needs improvement]
|
||||
|
||||
### Key Lessons Learned
|
||||
- [CUSTOMIZE: Important insight from the week]
|
||||
- [CUSTOMIZE: What you'd do differently]
|
||||
|
||||
### Incomplete Tasks (Why?)
|
||||
- [ ] [Task] - Reason: [Why it wasn't completed]
|
||||
- [ ] [Task] - Reason: [Why it wasn't completed]
|
||||
- Action: [Reschedule/Delegate/Delete]
|
||||
|
||||
---
|
||||
|
||||
## 📅 This Week's Plan
|
||||
|
||||
### 🎯 ONE Big Thing
|
||||
**If I accomplish nothing else, I will:** [CUSTOMIZE: Single most important outcome]
|
||||
|
||||
### 🔴 Priority Tasks (Must Do)
|
||||
*These align with monthly goals from [[2. Monthly Goals]]*
|
||||
|
||||
Monday:
|
||||
- [ ] [High-priority task]
|
||||
- [ ] [Time-blocked task]
|
||||
|
||||
Tuesday:
|
||||
- [ ] [High-priority task]
|
||||
- [ ] [Time-blocked task]
|
||||
|
||||
Wednesday:
|
||||
- [ ] [High-priority task]
|
||||
- [ ] [Time-blocked task]
|
||||
|
||||
Thursday:
|
||||
- [ ] [High-priority task]
|
||||
- [ ] [Time-blocked task]
|
||||
|
||||
Friday:
|
||||
- [ ] [High-priority task]
|
||||
- [ ] [Time-blocked task]
|
||||
|
||||
Weekend:
|
||||
- [ ] [Personal/Family priority]
|
||||
- [ ] [Self-care activity]
|
||||
|
||||
### 🟡 Important Tasks (Should Do)
|
||||
- [ ] [Important but flexible task]
|
||||
- [ ] [Important but flexible task]
|
||||
- [ ] [Important but flexible task]
|
||||
|
||||
### 🟢 Nice to Have (Could Do)
|
||||
- [ ] [Bonus task if time permits]
|
||||
- [ ] [Bonus task if time permits]
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Project Progress
|
||||
|
||||
### Project 1: [PROJECT NAME]
|
||||
- **Goal this week:** [Specific deliverable]
|
||||
- **Time allocated:** [X hours]
|
||||
- **Key tasks:**
|
||||
- [ ] [Subtask 1]
|
||||
- [ ] [Subtask 2]
|
||||
|
||||
### Project 2: [PROJECT NAME]
|
||||
- **Goal this week:** [Specific deliverable]
|
||||
- **Time allocated:** [X hours]
|
||||
- **Key tasks:**
|
||||
- [ ] [Subtask 1]
|
||||
- [ ] [Subtask 2]
|
||||
|
||||
---
|
||||
|
||||
## 🧘 Habits & Routines
|
||||
|
||||
### Daily Habits Tracker
|
||||
- [ ] Mon - Morning routine
|
||||
- [ ] Tue - Morning routine
|
||||
- [ ] Wed - Morning routine
|
||||
- [ ] Thu - Morning routine
|
||||
- [ ] Fri - Morning routine
|
||||
- [ ] Sat - Morning routine
|
||||
- [ ] Sun - Morning routine
|
||||
|
||||
### Weekly Habits
|
||||
- [ ] Exercise sessions (Target: 3x)
|
||||
- [ ] Deep work blocks (Target: 5x)
|
||||
- [ ] Family time (Target: 2x)
|
||||
- [ ] Learning time (Target: 3 hours)
|
||||
|
||||
---
|
||||
|
||||
## 📚 Learning & Input
|
||||
|
||||
### This Week's Learning Focus
|
||||
**Topic:** [CUSTOMIZE: What you're studying]
|
||||
**Resource:** [Book/Course/Article]
|
||||
**Time Commitment:** [X hours]
|
||||
**Key Question:** [What you want to understand]
|
||||
|
||||
### Content to Consume
|
||||
- [ ] Read: [Article/Chapter]
|
||||
- [ ] Watch: [Video/Course lesson]
|
||||
- [ ] Listen: [Podcast/Audiobook]
|
||||
|
||||
---
|
||||
|
||||
## 🗓️ Calendar Review
|
||||
|
||||
### Fixed Commitments
|
||||
- [Day]: [Meeting/Appointment] @ [Time]
|
||||
- [Day]: [Meeting/Appointment] @ [Time]
|
||||
|
||||
### Time Blocks
|
||||
- **Deep Work:** [Day] [Time-Time]
|
||||
- **Admin Time:** [Day] [Time-Time]
|
||||
- **Buffer Time:** [Day] [Time-Time]
|
||||
|
||||
### Key Deadlines
|
||||
- [DATE]: [What's due]
|
||||
- [DATE]: [What's due]
|
||||
|
||||
---
|
||||
|
||||
## 💭 Reflection & Intention
|
||||
|
||||
### Energy Management
|
||||
**Physical Energy:** [1-10] - [What affects this?]
|
||||
**Mental Energy:** [1-10] - [What affects this?]
|
||||
**Emotional Energy:** [1-10] - [What affects this?]
|
||||
|
||||
### This Week's Intention
|
||||
[CUSTOMIZE: How do you want to show up this week? What kind of person do you want to be?]
|
||||
|
||||
Example: "This week I will be focused and present, saying no to distractions and yes to what matters most."
|
||||
|
||||
### Potential Obstacles
|
||||
1. **Obstacle:** [What might get in the way]
|
||||
- **Strategy:** [How you'll handle it]
|
||||
2. **Obstacle:** [What might get in the way]
|
||||
- **Strategy:** [How you'll handle it]
|
||||
|
||||
---
|
||||
|
||||
## 📝 Notes & Ideas
|
||||
|
||||
### Captured This Week
|
||||
*Brain dump - to be processed*
|
||||
- [Idea/thought/task]
|
||||
- [Idea/thought/task]
|
||||
- [Idea/thought/task]
|
||||
|
||||
### For Future Consideration
|
||||
- [Something to explore later]
|
||||
- [Project idea for next quarter]
|
||||
|
||||
---
|
||||
|
||||
## ✅ Weekly Review Checklist
|
||||
|
||||
### Review Process
|
||||
- [ ] Review last week's goals and tasks
|
||||
- [ ] Check calendar for next week
|
||||
- [ ] Update project status
|
||||
- [ ] Review [[2. Monthly Goals]]
|
||||
- [ ] Plan this week's priorities
|
||||
- [ ] Block time for important work
|
||||
- [ ] Clear email inbox
|
||||
- [ ] Process notes and ideas
|
||||
- [ ] Update habit trackers
|
||||
- [ ] Commit to ONE big thing
|
||||
|
||||
### Clean-up Tasks
|
||||
- [ ] Archive completed daily notes
|
||||
- [ ] Update project files
|
||||
- [ ] Clear desktop/downloads
|
||||
- [ ] Backup important files
|
||||
- [ ] Push changes to Git
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Links
|
||||
- [[2. Monthly Goals]] - Current month's objectives
|
||||
- [[1. Yearly Goals]] - Annual targets
|
||||
- Last Week: [[3. Weekly Review - [PREVIOUS WEEK]]]
|
||||
- Next Week: [[3. Weekly Review - [NEXT WEEK]]]
|
||||
|
||||
---
|
||||
|
||||
*Review Started: [TIME]*
|
||||
*Review Completed: [TIME]*
|
||||
*Time Invested: [X minutes]*
|
||||
|
||||
**Weekly Mantra:** [CUSTOMIZE: Inspirational quote or reminder]
|
||||
|
||||
**Remember:** You don't have to be perfect, just consistent. Small progress compounds!
|
||||
76
vault-template/Projects/Example Project/CLAUDE.md
Normal file
76
vault-template/Projects/Example Project/CLAUDE.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Project Context: Learning Spanish
|
||||
|
||||
## Project Overview
|
||||
This is an example project showing how to structure a learning project in your PKM system. Replace this with your actual project details.
|
||||
|
||||
**Goal:** Achieve conversational fluency in Spanish within 12 months
|
||||
**Started:** January 1, 2024
|
||||
**Target Completion:** December 31, 2024
|
||||
**Status:** Active - 25% Complete
|
||||
|
||||
## Current Focus
|
||||
- Working through Chapter 3 of textbook
|
||||
- Practicing daily conversations with language partner
|
||||
- Building vocabulary (currently at ~500 words)
|
||||
|
||||
## Key Decisions Made
|
||||
1. **Learning Method:** Combination of self-study + tutoring + immersion
|
||||
2. **Daily Commitment:** 30 minutes minimum, 1 hour target
|
||||
3. **Success Metric:** Pass DELE B2 exam by year end
|
||||
|
||||
## Resources Being Used
|
||||
- **Primary Textbook:** "Complete Spanish" by DK
|
||||
- **App:** Anki for spaced repetition (500+ cards created)
|
||||
- **Tutor:** Weekly 1-hour sessions on italki
|
||||
- **Practice Partner:** Language exchange twice weekly
|
||||
|
||||
## Weekly Routine
|
||||
- **Monday:** Grammar study (30 min)
|
||||
- **Tuesday:** Conversation practice (1 hour)
|
||||
- **Wednesday:** Vocabulary building (30 min)
|
||||
- **Thursday:** Listening practice with podcasts (30 min)
|
||||
- **Friday:** Writing practice (30 min)
|
||||
- **Weekend:** Review and cultural immersion (movies/music)
|
||||
|
||||
## Milestones Completed
|
||||
- [x] Complete Spanish alphabet and pronunciation
|
||||
- [x] Master present tense conjugations
|
||||
- [x] Build 250-word core vocabulary
|
||||
- [ ] Hold 5-minute conversation
|
||||
- [ ] Read first Spanish novel
|
||||
- [ ] Pass DELE B1 practice exam
|
||||
|
||||
## Current Challenges
|
||||
1. **Subjunctive mood** - Still confusing, need more practice
|
||||
2. **Listening comprehension** - Native speakers talk too fast
|
||||
3. **Time management** - Struggling to maintain daily practice
|
||||
|
||||
## Next Actions
|
||||
- [ ] Complete Chapter 3 exercises
|
||||
- [ ] Schedule extra tutoring for subjunctive
|
||||
- [ ] Find Spanish conversation group locally
|
||||
- [ ] Create Anki deck for irregular verbs
|
||||
|
||||
## Notes for Claude
|
||||
When helping with this project:
|
||||
- Remind me to do daily practice if I haven't logged it
|
||||
- Help create example sentences for new vocabulary
|
||||
- Suggest immersion activities based on my interests
|
||||
- Track my streak and celebrate milestones
|
||||
- Provide encouragement when I'm struggling
|
||||
|
||||
## Success Metrics
|
||||
- **Words learned:** 500/3000 target
|
||||
- **Conversation time:** 15 hours logged
|
||||
- **Chapters completed:** 3/12
|
||||
- **Practice streak:** 14 days
|
||||
|
||||
## Project-Specific Tags
|
||||
- `#spanish/vocabulary`
|
||||
- `#spanish/grammar`
|
||||
- `#spanish/practice`
|
||||
- `#spanish/resources`
|
||||
|
||||
---
|
||||
|
||||
*This is an example project. Replace with your own project details, maintaining this structure for consistency across all projects.*
|
||||
194
vault-template/Projects/Example Project/project-notes.md
Normal file
194
vault-template/Projects/Example Project/project-notes.md
Normal file
@@ -0,0 +1,194 @@
|
||||
# Learning Spanish - Project Notes
|
||||
|
||||
## Study Log
|
||||
|
||||
### Week 1 - Getting Started
|
||||
**Date:** January 1-7, 2024
|
||||
|
||||
**What I Learned:**
|
||||
- Spanish alphabet pronunciation differs from English
|
||||
- Rolled R's are harder than expected
|
||||
- Basic greetings and introductions
|
||||
- Numbers 1-100
|
||||
|
||||
**Practice Completed:**
|
||||
- 3.5 hours total study time
|
||||
- Created first 50 Anki cards
|
||||
- Had first tutoring session
|
||||
|
||||
**Reflections:**
|
||||
- Morning practice works better than evening
|
||||
- Need to practice speaking out loud more
|
||||
- Anki reviews are effective for memorization
|
||||
|
||||
---
|
||||
|
||||
### Week 2 - Building Foundations
|
||||
**Date:** January 8-14, 2024
|
||||
|
||||
**What I Learned:**
|
||||
- Present tense conjugations for regular verbs
|
||||
- Basic question words (qué, quién, dónde, etc.)
|
||||
- Days of the week and months
|
||||
- Common phrases for shopping
|
||||
|
||||
**Practice Completed:**
|
||||
- 5 hours total study time
|
||||
- Added 75 new vocabulary words
|
||||
- First conversation exchange (struggled but succeeded!)
|
||||
|
||||
**Challenges:**
|
||||
- Mixing up ser vs estar
|
||||
- Forgetting to match adjective gender
|
||||
- Speaking anxiety in conversation practice
|
||||
|
||||
**Breakthrough Moment:**
|
||||
Successfully ordered coffee in Spanish at local café!
|
||||
|
||||
---
|
||||
|
||||
## Vocabulary Lists
|
||||
|
||||
### Essential Verbs
|
||||
- ser/estar - to be
|
||||
- tener - to have
|
||||
- hacer - to do/make
|
||||
- poder - can/to be able
|
||||
- querer - to want
|
||||
- ir - to go
|
||||
- venir - to come
|
||||
- decir - to say
|
||||
- dar - to give
|
||||
- ver - to see
|
||||
|
||||
### Daily Routine Vocabulary
|
||||
- despertarse - to wake up
|
||||
- levantarse - to get up
|
||||
- desayunar - to have breakfast
|
||||
- trabajar - to work
|
||||
- almorzar - to have lunch
|
||||
- estudiar - to study
|
||||
- cenar - to have dinner
|
||||
- acostarse - to go to bed
|
||||
|
||||
---
|
||||
|
||||
## Grammar Notes
|
||||
|
||||
### Ser vs Estar
|
||||
**SER** - Permanent characteristics
|
||||
- Description: Ella es alta (She is tall)
|
||||
- Occupation: Soy profesor (I am a teacher)
|
||||
- Characteristics: El libro es interesante (The book is interesting)
|
||||
- Time: Son las tres (It's 3 o'clock)
|
||||
- Origin: Somos de México (We're from Mexico)
|
||||
|
||||
**ESTAR** - Temporary states/locations
|
||||
- Location: Estoy en casa (I'm at home)
|
||||
- Emotions: Está feliz (He is happy)
|
||||
- Temporary conditions: La comida está fría (The food is cold)
|
||||
- Progressive: Estoy estudiando (I am studying)
|
||||
|
||||
---
|
||||
|
||||
## Useful Resources Found
|
||||
|
||||
### Podcasts
|
||||
1. **SpanishPod101** - Great for beginners
|
||||
2. **Coffee Break Spanish** - 15-minute daily lessons
|
||||
3. **Duolingo Spanish Podcast** - Stories for intermediate
|
||||
|
||||
### YouTube Channels
|
||||
1. **SpanishDict** - Grammar explanations
|
||||
2. **Butterfly Spanish** - Fun and engaging
|
||||
3. **Spanish with Paul** - Structured lessons
|
||||
|
||||
### Practice Websites
|
||||
- **Conjuguemos** - Grammar practice
|
||||
- **News in Slow Spanish** - Listening practice
|
||||
- **HelloTalk** - Find conversation partners
|
||||
|
||||
---
|
||||
|
||||
## Conversation Practice Templates
|
||||
|
||||
### Introducing Yourself
|
||||
```
|
||||
Hola, me llamo [name].
|
||||
Soy de [country/city].
|
||||
Tengo [age] años.
|
||||
Soy [occupation].
|
||||
Me gusta [hobby/interest].
|
||||
Estoy aprendiendo español porque [reason].
|
||||
```
|
||||
|
||||
### Ordering at Restaurant
|
||||
```
|
||||
Waiter: ¿Qué desea?
|
||||
You: Quisiera [dish], por favor.
|
||||
Waiter: ¿Algo de beber?
|
||||
You: Sí, [beverage], por favor.
|
||||
Waiter: ¿Algo más?
|
||||
You: No, eso es todo. Gracias.
|
||||
[Later]
|
||||
You: La cuenta, por favor.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Monthly Progress Review
|
||||
|
||||
### January 2024
|
||||
**Goals Set:** ✅
|
||||
- Complete textbook chapters 1-2
|
||||
- Learn 200 vocabulary words
|
||||
- Have 4 tutoring sessions
|
||||
- Practice daily for 30 minutes
|
||||
|
||||
**Goals Achieved:**
|
||||
- ✅ Completed chapters 1-2
|
||||
- ⚠️ Learned 175 words (87.5%)
|
||||
- ✅ Had 4 tutoring sessions
|
||||
- ⚠️ Practiced 25/31 days (80%)
|
||||
|
||||
**Key Wins:**
|
||||
- Established daily practice routine
|
||||
- Found good language exchange partner
|
||||
- Can introduce myself confidently
|
||||
|
||||
**Areas for Improvement:**
|
||||
- Need more listening practice
|
||||
- Should speak out loud more
|
||||
- Grammar exercises need more time
|
||||
|
||||
**February Goals:**
|
||||
- Complete chapters 3-4
|
||||
- Add 200 more vocabulary words
|
||||
- Increase speaking practice to 2x per week
|
||||
- Maintain 30-minute daily minimum
|
||||
|
||||
---
|
||||
|
||||
## Project Reflections
|
||||
|
||||
### What's Working Well
|
||||
- Anki for vocabulary retention
|
||||
- Morning study sessions
|
||||
- Weekly tutor accountability
|
||||
- Immersion through Spanish music
|
||||
|
||||
### What Needs Adjustment
|
||||
- Need structured grammar practice
|
||||
- Should record myself speaking
|
||||
- Find more opportunities for real conversation
|
||||
- Add more writing practice
|
||||
|
||||
### Motivation Reminders
|
||||
- Why I started: Want to travel South America
|
||||
- Dream scenario: Having deep conversations with native speakers
|
||||
- Milestone celebration planned: Spanish movie marathon at 6 months
|
||||
- End goal: Pass DELE B2 and travel to Spain
|
||||
|
||||
---
|
||||
|
||||
*This is an example project note. Your actual project notes would contain your specific learning journey, challenges, and victories.*
|
||||
129
vault-template/Templates/Daily Template.md
Normal file
129
vault-template/Templates/Daily Template.md
Normal file
@@ -0,0 +1,129 @@
|
||||
---
|
||||
date: {{date}}
|
||||
tags: daily-note
|
||||
---
|
||||
|
||||
# {{date:dddd, MMMM DD, YYYY}}
|
||||
|
||||
_[CUSTOMIZE THIS: Add your personal mission statement or daily reminder here]_
|
||||
*Example: "Every day, I choose to grow, contribute, and live with intention."*
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Today's Focus
|
||||
*What's the ONE thing that would make today a win?*
|
||||
|
||||
**Today's Priority:**
|
||||
|
||||
---
|
||||
|
||||
## ⏰ Time Blocks
|
||||
*Plan your day with intentional time allocation*
|
||||
|
||||
- **Morning (6-9am):** [Morning routine/Deep work]
|
||||
- **Mid-Morning (9-12pm):** [Primary work block]
|
||||
- **Afternoon (12-3pm):** [Meetings/Collaboration]
|
||||
- **Late Afternoon (3-6pm):** [Secondary work block]
|
||||
- **Evening (6-9pm):** [Personal/Family time]
|
||||
|
||||
---
|
||||
|
||||
## ✅ Tasks
|
||||
|
||||
### 🔴 Must Do Today
|
||||
- [ ] [PRIORITY: Task that must be completed]
|
||||
- [ ] [PRIORITY: Critical deadline or commitment]
|
||||
|
||||
### 💼 Work
|
||||
- [ ] [Work task 1]
|
||||
- [ ] [Work task 2]
|
||||
- [ ] [Work task 3]
|
||||
|
||||
### 🏠 Personal
|
||||
- [ ] [Personal task 1]
|
||||
- [ ] [Personal task 2]
|
||||
|
||||
### 📚 Learning/Growth
|
||||
- [ ] [Learning activity]
|
||||
- [ ] [Reading/Course progress]
|
||||
|
||||
### 🏃 Health/Wellness
|
||||
- [ ] Morning routine completed
|
||||
- [ ] Exercise: [Type and duration]
|
||||
- [ ] Meditation: [X minutes]
|
||||
- [ ] Water intake: [X glasses]
|
||||
|
||||
---
|
||||
|
||||
## 💡 Ideas & Thoughts
|
||||
*Capture anything that comes to mind*
|
||||
|
||||
-
|
||||
|
||||
---
|
||||
|
||||
## 📝 Notes from Today
|
||||
*Meeting notes, important information, key decisions*
|
||||
|
||||
### Meetings
|
||||
- **[Meeting Name]:**
|
||||
- Key points:
|
||||
- Action items:
|
||||
|
||||
### Important Info
|
||||
-
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Gratitude
|
||||
*Three things I'm grateful for today*
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
---
|
||||
|
||||
## 🔍 End of Day Reflection
|
||||
*Complete before bed*
|
||||
|
||||
### What Went Well?
|
||||
-
|
||||
|
||||
### What Could Be Better?
|
||||
-
|
||||
|
||||
### What Did I Learn?
|
||||
-
|
||||
|
||||
### Tomorrow's #1 Priority
|
||||
-
|
||||
|
||||
### Energy Level Today
|
||||
- Physical: [1-10]
|
||||
- Mental: [1-10]
|
||||
- Emotional: [1-10]
|
||||
|
||||
---
|
||||
|
||||
## 📊 Daily Metrics
|
||||
- Deep Work Time: [X hours]
|
||||
- Shallow Work Time: [X hours]
|
||||
- Tasks Completed: [X/Y]
|
||||
- Inbox Zero: [Y/N]
|
||||
- Screen Time: [X hours]
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related
|
||||
- [[3. Weekly Review|This Week's Plan]]
|
||||
- [[2. Monthly Goals|This Month's Focus]]
|
||||
- Yesterday: [[{{date-1:YYYY-MM-DD}}]]
|
||||
- Tomorrow: [[{{date+1:YYYY-MM-DD}}]]
|
||||
|
||||
---
|
||||
|
||||
*Day [X] of 365*
|
||||
*Week [X] of 52*
|
||||
|
||||
**Today's Affirmation:** [CUSTOMIZE: Add a daily affirmation or quote]
|
||||
259
vault-template/Templates/Project Template.md
Normal file
259
vault-template/Templates/Project Template.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# Project: [PROJECT NAME]
|
||||
|
||||
## 📋 Project Overview
|
||||
|
||||
### Purpose
|
||||
*Why does this project exist? What problem does it solve?*
|
||||
|
||||
[CUSTOMIZE: Clear statement of project purpose]
|
||||
|
||||
### Success Criteria
|
||||
*How will we know when this project is complete and successful?*
|
||||
|
||||
1. [Specific, measurable outcome]
|
||||
2. [Specific, measurable outcome]
|
||||
3. [Specific, measurable outcome]
|
||||
|
||||
### Timeline
|
||||
- **Start Date:** {{date:YYYY-MM-DD}}
|
||||
- **Target Completion:** [DATE]
|
||||
- **Actual Completion:** [To be filled]
|
||||
|
||||
### Priority Level
|
||||
- [ ] 🔴 Critical - Business/Life Essential
|
||||
- [ ] 🟡 Important - Significant Impact
|
||||
- [ ] 🟢 Nice to Have - Improvement/Enhancement
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Goals & Objectives
|
||||
|
||||
### Primary Goal
|
||||
[CUSTOMIZE: Main goal this project achieves]
|
||||
|
||||
### Supporting Objectives
|
||||
1. [Objective that supports the goal]
|
||||
2. [Objective that supports the goal]
|
||||
3. [Objective that supports the goal]
|
||||
|
||||
### Link to Annual Goals
|
||||
*How does this connect to [[1. Yearly Goals]]?*
|
||||
|
||||
[Explain connection]
|
||||
|
||||
---
|
||||
|
||||
## 👥 Stakeholders
|
||||
|
||||
### Project Owner
|
||||
- **Name:** [Your name or responsible party]
|
||||
- **Role:** [Decision maker]
|
||||
|
||||
### Team Members / Collaborators
|
||||
- **[Name]:** [Role/Responsibility]
|
||||
- **[Name]:** [Role/Responsibility]
|
||||
|
||||
### External Dependencies
|
||||
- **[Person/Team]:** [What they provide]
|
||||
- **[Person/Team]:** [What they provide]
|
||||
|
||||
---
|
||||
|
||||
## 📊 Scope
|
||||
|
||||
### In Scope
|
||||
*What this project WILL include*
|
||||
- ✅ [Included deliverable/feature]
|
||||
- ✅ [Included deliverable/feature]
|
||||
- ✅ [Included deliverable/feature]
|
||||
|
||||
### Out of Scope
|
||||
*What this project WILL NOT include*
|
||||
- ❌ [Excluded item - save for later]
|
||||
- ❌ [Excluded item - save for later]
|
||||
- ❌ [Excluded item - save for later]
|
||||
|
||||
### Constraints
|
||||
- **Budget:** [If applicable]
|
||||
- **Time:** [Hard deadlines]
|
||||
- **Resources:** [Limitations]
|
||||
|
||||
---
|
||||
|
||||
## 🗺️ Milestones & Phases
|
||||
|
||||
### Phase 1: [PHASE NAME]
|
||||
**Target Date:** [DATE]
|
||||
**Status:** [Not Started/In Progress/Complete]
|
||||
|
||||
Key Deliverables:
|
||||
- [ ] [Deliverable 1]
|
||||
- [ ] [Deliverable 2]
|
||||
- [ ] [Deliverable 3]
|
||||
|
||||
### Phase 2: [PHASE NAME]
|
||||
**Target Date:** [DATE]
|
||||
**Status:** [Not Started/In Progress/Complete]
|
||||
|
||||
Key Deliverables:
|
||||
- [ ] [Deliverable 1]
|
||||
- [ ] [Deliverable 2]
|
||||
- [ ] [Deliverable 3]
|
||||
|
||||
### Phase 3: [PHASE NAME]
|
||||
**Target Date:** [DATE]
|
||||
**Status:** [Not Started/In Progress/Complete]
|
||||
|
||||
Key Deliverables:
|
||||
- [ ] [Deliverable 1]
|
||||
- [ ] [Deliverable 2]
|
||||
- [ ] [Deliverable 3]
|
||||
|
||||
---
|
||||
|
||||
## ✅ Task List
|
||||
|
||||
### Current Sprint/Week
|
||||
- [ ] **Priority 1:** [Task] - Due: [DATE]
|
||||
- [ ] **Priority 2:** [Task] - Due: [DATE]
|
||||
- [ ] **Priority 3:** [Task] - Due: [DATE]
|
||||
|
||||
### Backlog
|
||||
- [ ] [Future task]
|
||||
- [ ] [Future task]
|
||||
- [ ] [Future task]
|
||||
|
||||
### Completed
|
||||
- [x] [Completed task] - [DATE]
|
||||
- [x] [Completed task] - [DATE]
|
||||
|
||||
---
|
||||
|
||||
## 📝 Project Log
|
||||
|
||||
### [DATE] - [TITLE]
|
||||
**What happened:** [Brief description]
|
||||
**Decision made:** [If applicable]
|
||||
**Next steps:** [Action items]
|
||||
|
||||
### [DATE] - [TITLE]
|
||||
**What happened:** [Brief description]
|
||||
**Decision made:** [If applicable]
|
||||
**Next steps:** [Action items]
|
||||
|
||||
---
|
||||
|
||||
## 🚧 Risks & Issues
|
||||
|
||||
### Active Risks
|
||||
1. **Risk:** [Description]
|
||||
- **Impact:** [High/Medium/Low]
|
||||
- **Mitigation:** [How to prevent/handle]
|
||||
|
||||
2. **Risk:** [Description]
|
||||
- **Impact:** [High/Medium/Low]
|
||||
- **Mitigation:** [How to prevent/handle]
|
||||
|
||||
### Current Issues
|
||||
1. **Issue:** [Description]
|
||||
- **Status:** [Investigating/Resolving/Blocked]
|
||||
- **Owner:** [Who's handling]
|
||||
- **Resolution:** [Plan to fix]
|
||||
|
||||
---
|
||||
|
||||
## 💰 Resources & Budget
|
||||
|
||||
### Time Investment
|
||||
- **Estimated Hours:** [X hours]
|
||||
- **Actual Hours:** [Track as you go]
|
||||
|
||||
### Financial Investment
|
||||
- **Budget:** $[Amount]
|
||||
- **Spent:** $[Amount]
|
||||
- **Remaining:** $[Amount]
|
||||
|
||||
### Tools & Resources Needed
|
||||
- [Tool/Resource 1]
|
||||
- [Tool/Resource 2]
|
||||
- [Tool/Resource 3]
|
||||
|
||||
---
|
||||
|
||||
## 📚 Reference Materials
|
||||
|
||||
### Documentation
|
||||
- [Link to important doc]
|
||||
- [Link to important doc]
|
||||
|
||||
### Research & Inspiration
|
||||
- [Article/Resource]
|
||||
- [Article/Resource]
|
||||
|
||||
### Related Projects
|
||||
- [[Project Name]] - [How it relates]
|
||||
- [[Project Name]] - [How it relates]
|
||||
|
||||
---
|
||||
|
||||
## 🎉 Success Metrics
|
||||
|
||||
### Quantitative Metrics
|
||||
- **Metric 1:** [Target] vs [Actual]
|
||||
- **Metric 2:** [Target] vs [Actual]
|
||||
- **Metric 3:** [Target] vs [Actual]
|
||||
|
||||
### Qualitative Outcomes
|
||||
- [Describe quality improvement]
|
||||
- [Describe satisfaction measure]
|
||||
- [Describe learning outcome]
|
||||
|
||||
---
|
||||
|
||||
## 📤 Deliverables
|
||||
|
||||
### Final Deliverables
|
||||
1. **[Deliverable Name]**
|
||||
- Format: [Document/Code/Product]
|
||||
- Location: [Where to find it]
|
||||
- Status: [Draft/Review/Final]
|
||||
|
||||
2. **[Deliverable Name]**
|
||||
- Format: [Document/Code/Product]
|
||||
- Location: [Where to find it]
|
||||
- Status: [Draft/Review/Final]
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Project Review
|
||||
|
||||
### Lessons Learned
|
||||
*To be completed at project end*
|
||||
|
||||
**What went well:**
|
||||
-
|
||||
|
||||
**What could be improved:**
|
||||
-
|
||||
|
||||
**What to do differently next time:**
|
||||
-
|
||||
|
||||
### Follow-up Actions
|
||||
- [ ] [Post-project task]
|
||||
- [ ] [Post-project task]
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Quick Links
|
||||
- [[Projects/]] - All projects
|
||||
- [[2. Monthly Goals]] - Current month
|
||||
- [[1. Yearly Goals]] - Annual objectives
|
||||
|
||||
---
|
||||
|
||||
*Project Created: {{date:YYYY-MM-DD}}*
|
||||
*Last Updated: {{date:YYYY-MM-DD}}*
|
||||
*Status: [Active/On Hold/Complete]*
|
||||
|
||||
**Project Mantra:** [CUSTOMIZE: Inspiring quote or reminder for this project]
|
||||
187
vault-template/Templates/Weekly Review Template.md
Normal file
187
vault-template/Templates/Weekly Review Template.md
Normal file
@@ -0,0 +1,187 @@
|
||||
# Weekly Review - Week of {{date:YYYY-MM-DD}}
|
||||
|
||||
## 🎯 Week at a Glance
|
||||
**Week Number:** Week {{date:w}} of 52
|
||||
**Theme/Focus:** [Define this week's primary focus]
|
||||
**Energy Available:** [High/Medium/Low]
|
||||
|
||||
---
|
||||
|
||||
## 📊 Quick Stats
|
||||
- **Tasks Completed:** [X/Y]
|
||||
- **Projects Advanced:** [List projects worked on]
|
||||
- **Habits Maintained:** [X/7 days]
|
||||
- **One Metric Progress:** [Update from [[1. Yearly Goals]]]
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Last Week Review
|
||||
|
||||
### What Went Well? (Wins) 🎉
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### What Didn't Go Well? (Challenges) 🤔
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### Key Lessons Learned 📚
|
||||
-
|
||||
-
|
||||
|
||||
### Incomplete Tasks (Carry Forward?)
|
||||
- [ ] [Task] - Action: [Reschedule/Delegate/Delete]
|
||||
- [ ] [Task] - Action: [Reschedule/Delegate/Delete]
|
||||
|
||||
---
|
||||
|
||||
## 📅 This Week's Plan
|
||||
|
||||
### 🎯 ONE Big Thing
|
||||
**If I accomplish nothing else this week, I will:**
|
||||
|
||||
|
||||
### Priority Matrix
|
||||
|
||||
#### 🔴 Urgent & Important
|
||||
- [ ]
|
||||
- [ ]
|
||||
|
||||
#### 🟡 Important Not Urgent
|
||||
- [ ]
|
||||
- [ ]
|
||||
|
||||
#### 🟢 Quick Wins
|
||||
- [ ]
|
||||
- [ ]
|
||||
|
||||
---
|
||||
|
||||
## 🗓️ Day by Day
|
||||
|
||||
### Monday {{date+1:MM/DD}}
|
||||
**Focus:**
|
||||
- [ ] Priority task
|
||||
- [ ]
|
||||
|
||||
### Tuesday {{date+2:MM/DD}}
|
||||
**Focus:**
|
||||
- [ ] Priority task
|
||||
- [ ]
|
||||
|
||||
### Wednesday {{date+3:MM/DD}}
|
||||
**Focus:**
|
||||
- [ ] Priority task
|
||||
- [ ]
|
||||
|
||||
### Thursday {{date+4:MM/DD}}
|
||||
**Focus:**
|
||||
- [ ] Priority task
|
||||
- [ ]
|
||||
|
||||
### Friday {{date+5:MM/DD}}
|
||||
**Focus:**
|
||||
- [ ] Priority task
|
||||
- [ ]
|
||||
|
||||
### Weekend
|
||||
**Personal/Family Focus:**
|
||||
- [ ]
|
||||
- [ ]
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Project Status
|
||||
|
||||
### Active Projects
|
||||
1. **[Project Name]**
|
||||
- This week's goal:
|
||||
- Status: [On track/Behind/Ahead]
|
||||
- Next action:
|
||||
|
||||
2. **[Project Name]**
|
||||
- This week's goal:
|
||||
- Status: [On track/Behind/Ahead]
|
||||
- Next action:
|
||||
|
||||
---
|
||||
|
||||
## 🧘 Habits & Routines
|
||||
|
||||
### Habit Scorecard
|
||||
- [ ] Daily Morning Routine (Target: 7/7)
|
||||
- [ ] Exercise (Target: 3x)
|
||||
- [ ] Meditation (Target: 5x)
|
||||
- [ ] Reading (Target: 30 min/day)
|
||||
- [ ] Weekly Review (Target: Sunday)
|
||||
|
||||
---
|
||||
|
||||
## 📚 Learning Focus
|
||||
|
||||
**This Week's Topic:**
|
||||
**Resource:**
|
||||
**Time Allocated:**
|
||||
**Key Question to Answer:**
|
||||
|
||||
---
|
||||
|
||||
## 💭 Reflection
|
||||
|
||||
### Energy Check
|
||||
- **Physical:** [1-10] - Plan:
|
||||
- **Mental:** [1-10] - Plan:
|
||||
- **Emotional:** [1-10] - Plan:
|
||||
|
||||
### This Week's Intention
|
||||
*How do I want to show up?*
|
||||
|
||||
|
||||
### Potential Obstacles & Strategies
|
||||
1. **Obstacle:**
|
||||
- **Strategy:**
|
||||
|
||||
2. **Obstacle:**
|
||||
- **Strategy:**
|
||||
|
||||
---
|
||||
|
||||
## 📝 Brain Dump
|
||||
*Ideas, thoughts, things to remember*
|
||||
|
||||
-
|
||||
-
|
||||
-
|
||||
|
||||
---
|
||||
|
||||
## ✅ Review Checklist
|
||||
|
||||
- [ ] Reviewed last week's accomplishments
|
||||
- [ ] Processed all inbox items
|
||||
- [ ] Updated project statuses
|
||||
- [ ] Checked upcoming calendar
|
||||
- [ ] Reviewed [[2. Monthly Goals]]
|
||||
- [ ] Planned this week's priorities
|
||||
- [ ] Blocked time for deep work
|
||||
- [ ] Set ONE big thing for the week
|
||||
- [ ] Cleaned up digital workspace
|
||||
- [ ] Committed changes to Git
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Navigation
|
||||
- [[2. Monthly Goals|Current Month]]
|
||||
- [[1. Yearly Goals|Current Year]]
|
||||
- Previous: [[{{date-7:YYYY-MM-DD}} Weekly Review]]
|
||||
- Next: [[{{date+7:YYYY-MM-DD}} Weekly Review]]
|
||||
|
||||
---
|
||||
|
||||
*Review Started: {{time}}*
|
||||
*Review Completed: [TIME]*
|
||||
*Time Invested: [X minutes]*
|
||||
|
||||
**This Week's Mantra:**
|
||||
Reference in New Issue
Block a user