Skip to content

jcgonzalez25/obsidian-cli-agent

Repository files navigation

Obsidian CLI Agent

Give your AI agent full access to your Obsidian vault.

Release Stars Last Commit License: MIT PRs Welcome


Most AI coding agents can't touch your knowledge base. This plugin bridges that gap — letting Claude Code and Cursor read, search, and write to your Obsidian vault using natural language.

Demo

Features

  • Daily Notes — Append findings, decisions, and meeting notes to today's daily note
  • Note Management — Create, read, append, move, rename, and delete notes
  • Task Tracking — List open tasks, toggle completion, filter by daily note
  • Search — Full-text search with context across your entire vault
  • Knowledge Graph — Find backlinks, orphaned notes, dead ends, and broken links
  • Templates — Create notes from your Obsidian templates
  • Properties — Read and set frontmatter properties on any note
  • Visual Formatting — Opinionated formatting conventions for scannable notes (callouts, mermaid diagrams, tables)

Install

Requires Obsidian installed and running (CLI communicates via IPC).

git clone https://github.com/jcgonzalez25/obsidian-cli-agent.git ~/obsidian-cli-agent
claude plugin install --path ~/obsidian-cli-agent
~/obsidian-cli-agent/setup.sh

The setup script auto-detects your Obsidian binary and vault. No manual config needed.

Claude Code (Skill)
git clone https://github.com/jcgonzalez25/obsidian-cli-agent.git ~/.claude/skills/obsidian-cli
~/.claude/skills/obsidian-cli/setup.sh
Cursor
git clone https://github.com/jcgonzalez25/obsidian-cli-agent.git /tmp/obsidian-cli-agent
cd your-project/
/tmp/obsidian-cli-agent/setup.sh --cursor
Manual setup

Copy config.example.yaml to ~/.config/obsidian-cli/config.yaml and fill in your values:

vault: "MyVault"
vault_path: "~/Documents/MyVault/"
binary: "/Applications/Obsidian.app/Contents/MacOS/obsidian"

Usage

Just ask naturally:

You say What happens
"Add today's meeting notes to my daily note" Appends formatted content to today's daily note
"Create a research note about distributed systems" Creates a new note with proper structure and frontmatter
"What tasks do I have open?" Lists all incomplete tasks across your vault
"Search my vault for anything about authentication" Full-text search with surrounding context
"Find orphaned notes in my vault" Lists notes with no incoming links
"Set the status of Project X to in-progress" Updates frontmatter properties

How It Works

graph LR
    A[You] -->|natural language| B[Claude Code / Cursor]
    B -->|constructs commands| C[Obsidian CLI]
    C -->|IPC| D[Obsidian App]
    B -->|fallback: direct file access| E[Vault Files]
Loading

The agent teaches your AI assistant to use Obsidian's official CLI, which communicates with the running app via IPC. For content the CLI doesn't handle well, it falls back to direct file access.

Documentation

Full docs — CLI reference (100+ commands), visual formatting guide, configuration, and architecture:

jcgonzalez25.github.io/obsidian-cli-agent

Contributing

Contributions are welcome! Please:

  1. Open an issue to discuss major changes before submitting a PR
  2. Follow existing code style
  3. Test your changes with a real Obsidian vault

Contributors

License

MIT


If this is useful to you, consider giving it a star — it helps others discover it.

About

An AI agent skill for interacting with your Obsidian vault via the CLI — works with Claude Code and Cursor

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages