Obsidian-CLI-skill  by pablo-mano

AI agents control Obsidian vaults via terminal commands

Created 3 months ago
300 stars

Top 88.7% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

This project provides an AI coding agent skill that enables full terminal control over Obsidian vaults using the official Obsidian CLI (v1.12+). It empowers AI agents to read, create, edit, search, and manage notes, tasks, plugins, and sync operations within Obsidian, streamlining knowledge management workflows for AI-assisted development.

How It Works

The skill integrates with various AI agents by exposing the Obsidian CLI's extensive command set via a SKILL.md file. AI models recognize Obsidian-related queries and invoke the skill, which translates natural language or explicit commands into Obsidian CLI calls. This approach leverages the robust, official CLI for comprehensive vault interaction without requiring direct API access or complex agent-specific logic.

Quick Start & Requirements

  • Installation: Varies by agent (e.g., marketplace add for Claude Code, cloning for Cursor/Cortex, custom instructions for Copilot).
  • Prerequisites: Obsidian Desktop v1.12.0+, CLI enabled in Obsidian settings, and the Obsidian application must be running for IPC communication.
  • Platform Notes: macOS/Linux auto-adds binary to PATH. Windows requires a redirector file and normal-privilege terminals. Headless Linux needs specific setup (e.g., xvfb, DISPLAY=:5, PrivateTmp=false).

Highlighted Details

  • Command Coverage: Over 130 commands across 20+ areas including Files, Daily Notes, Search, Properties, Tasks, Links, Plugins, Sync, Themes, and Developer tools.
  • AI Integration: Designed for seamless integration with LLM agents supporting SKILL.md or custom instructions, enabling natural language control.
  • Full CLI Functionality: Exposes nearly all Obsidian CLI capabilities, from note manipulation to plugin management and sync operations.
  • Developer Tools: Includes commands for eval, dev:screenshot, dev:debug, dev:console, and more.

Maintenance & Community

The README does not detail specific contributors, sponsorships, or community channels.

Licensing & Compatibility

The skill is provided "as-is" and relies on Obsidian v1.12+, which is free for all users. No specific open-source license is stated for the skill code itself. Compatibility is broad across LLM agents supporting SKILL.md or custom instructions.

Limitations & Caveats

Windows requires normal-privilege terminals; admin terminals cause silent failures. Headless Linux requires specific configurations (xvfb, DISPLAY=:5, PrivateTmp=false). Multi-vault interactions may require explicit vault naming or manual switching. Snap confinement on Linux can restrict IPC; .deb package is recommended. Obsidian must be running for the CLI to function.

Health Check
Last Commit

3 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
135 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.