obsidian-claude-pkm  by ballred

AI-powered personal knowledge management system

Created 5 months ago
814 stars

Top 43.5% on SourcePulse

GitHubView on GitHub
Project Summary

A starter kit for building a personal knowledge management (PKM) system using Obsidian and Claude Code. It aims to provide a fully functional, AI-enhanced PKM setup in under 15 minutes, targeting users who want to leverage AI for organization, goal alignment, and accountability within their note-taking workflow. The system offers automated backups and mobile readiness.

How It Works

This project integrates Obsidian's note-taking capabilities with Claude Code's AI features. Version 2.0 introduces significant enhancements, including hooks for automating actions like Git commits on save, custom AI agents for tasks such as note organization and weekly reviews, auto-discovered skills for vault operations, and modular rules for defining path-specific conventions. This layered approach automates routine PKM tasks and provides AI-driven insights and accountability.

Quick Start & Requirements

  • Prerequisites: Obsidian (https://obsidian.md/), Git (https://git-scm.com/), Claude Code CLI (https://code.claude.com/docs). A GitHub account is optional for mobile sync.
  • Installation: Clone the repository (git clone https://github.com/ballred/obsidian-claude-pkm.git), navigate into the directory, and run the setup script (scripts/setup.sh for macOS/Linux, scripts/setup.bat for Windows). An alternative manual copy method is also provided.
  • Estimated Setup Time: 15 minutes.

Highlighted Details

  • AI-Powered Agents & Skills: Features specialized agents for note organization, weekly reviews, goal alignment, and inbox processing, alongside auto-discovered skills for vault operations.
  • Productivity Coach: An AI output style designed to act as an accountability partner, challenging intentions, identifying misalignments, and driving momentum.
  • Automated Workflows: Includes hooks for session initialization and auto-committing changes via Git, alongside modular rules for defining project conventions.
  • Version Control & Mobile Ready: Leverages Git for automatic backups and offers GitHub integration for cross-device access.

Maintenance & Community

The repository encourages contributions via issues and pull requests. Specific community channels (like Discord/Slack) or details on maintainers are not explicitly mentioned in the README.

Licensing & Compatibility

The project is released under the MIT License, permitting free use for personal knowledge management. Its permissive nature suggests compatibility with commercial applications, though specific integration scenarios would require review.

Limitations & Caveats

As a starter kit, extensive customization may be required for advanced use cases. Version 2.0 introduces new features like agents, skills, and hooks, which may be subject to early-stage development issues or require further refinement. The README does not detail known bugs or unsupported platforms.

Health Check
Last Commit

2 days ago

Responsiveness

Inactive

Pull Requests (30d)
2
Issues (30d)
2
Star History
813 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.