Getting Started

Prerequisites

• Obsidian installed and running (the CLI communicates via IPC)
• Claude Code or Cursor installed

Claude Code (Plugin — Recommended)

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

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

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

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"