Prompt With Jarvis
Work with meGet the free pack
All guides

LIBRARYYou commented this keyword

claude-obsidian

Turn your notes and sources into a linked Obsidian wiki that Claude Code can add to, search and answer from, with your files staying on your computer.

Before you start:
  • Claude Code
  • Obsidian
  • Python 3
  • git
Setup
15 min
Level
Intermediate
Stars
15.4k
License
MIT
Jump to the install commandView on GitHub

What it does

claude-obsidian adds 15 skills to Claude Code that build and maintain a knowledge base in Obsidian, the free notes app. You drop a source into an inbox folder, and Claude turns it into linked notes that cite where each claim came from.

Later you can ask the vault questions and get answers drawn from what is already in it. The vault is a normal folder of Markdown files you own. Nothing is uploaded unless you choose to allow it.

Install it

  1. Download the project with the git commands in the first block below. This folder is the tool, not your notes.
  2. Create a separate vault with the init command in the second block. It shows a plan first and prints an approved_plan_sha256 value.
  3. Run the same init command again with --approved-plan-sha256 "<sha256-from-the-plan>" --apply added to the end to actually create the vault.
  4. Open the new vault folder in Obsidian.
  5. From the vault folder, start Claude Code with the plugin using the command in the third block. Replace the path with where you downloaded claude-obsidian.

1. Get the product

Terminal
git clone https://github.com/AgriciDaniel/claude-obsidian.git
cd claude-obsidian

2. Plan a new vault

Terminal
export GENERATED_AT="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
export OPERATION_ID="init-reviewed"
python3 scripts/claude-obsidian.py init "$HOME/Documents/MyKnowledgeVault" \
  --generated-at "$GENERATED_AT" --operation-id "$OPERATION_ID"

3. Start Claude Code in the vault

Terminal
cd "$HOME/Documents/MyKnowledgeVault"
claude --plugin-dir /absolute/path/to/claude-obsidian

Use it

  1. Type /claude-obsidian:wiki in Claude Code to get started.
  2. Put a source file in the inbox/ folder and run /claude-obsidian:wiki-ingest to turn it into linked notes.
  3. Ask questions with /claude-obsidian:wiki-query.
  4. Save a specific answer into the vault with /claude-obsidian:save.

Good to know

Already have an Obsidian vault? Use the non-destructive adopt workflow in the installation guide instead of init.

PDFs and EPUBs are stored but not read for meaning, and URL, YouTube and OCR capture need an extra external tool configured. Windows users should read the Windows and WSL guide in the repo. It is not a backup tool, so keep your own backups.

Links

Want the next one first?

One new guide a week, straight to your inbox.

More like this