Initialize Obsidian PM
Sets up project management integration between code repository and Obsidian vault.
Steps
- •
Get configuration:
- •Ask user for Obsidian vault path (if not in
$ARGUMENTS) - •Ask user for project name (if not in
$ARGUMENTS)
- •Ask user for Obsidian vault path (if not in
- •
Validate vault path:
- •Check that directory exists
- •Warn if path doesn't look like an Obsidian vault
- •
Create configuration file:
.claude/pm-config.jsonjson{ "obsidian_vault": "<vault-path>", "project_path": "projects/<project-name>", "task_dir": "tasks", "changelog_file": "changelog.md", "task_prefix": "TASK", "auto_mode": false } - •
Create Obsidian directories:
bashmkdir -p {vault}/{project_path}/tasks/ - •
Create README.md: Use template from
templates/readme-template.md- •Explains project structure
- •Links to conventions
- •Usage instructions
- •
Create changelog.md: Use template from
templates/changelog-template.md- •Frontmatter with metadata
- •Section divider
- •Initial entry
- •
Copy task template: Ensure
templates/task-template.mdis accessible for future task creation - •
Next steps: Suggest running:
bash/pm-new-task <description>
Conventions
These conventions are enforced throughout the plugin:
Task IDs
- •Format:
TASK-001(zero-padded 3 digits) - •Files:
TASK-001-short-description.md - •Sequential numbering
Git Integration
- •Branches:
feat/TASK-001-short-desc,fix/TASK-002-bug-desc - •Commits:
feat(TASK-001): description,fix(TASK-002): description - •Tag extraction: Plugin parses both branch names and commit messages
Status Flow
code
🎯 longTerm → 📋 backlog → ⭕ to-do → ⏳ in-progress → ✅ completed
↓
⏸️ pending → ⏳ in-progress
↓
❌ cancelled
- •New tasks default to
⭕ to-do - •First commit triggers
⏳ in-progress - •All criteria checked triggers
✅ completed
Language
- •All task content in English
- •Consistent terminology
- •Professional technical writing
Example Usage
bash
/pm-init ~/Documents/ObsidianVault my-api-project
Creates:
- •
.claude/pm-config.jsonin code repo - •
~/Documents/ObsidianVault/projects/my-api-project/tasks/directory - •README and changelog files