Skip to content

albertoreis86/claude-code-obsidian

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

Claude Code + Obsidian

Make Claude Code understand and write native Obsidian markdown — wikilinks, frontmatter, callouts, tags — so your vault stays connected instead of becoming a folder of orphaned files.

Includes an optional skill that bridges to the Obsidian CLI for graph queries, backlinks, vault health checks, and task aggregation.

What's Inside

CLAUDE.md                      ← Obsidian writing rules for Claude Code
skills/obsidian/SKILL.md       ← Obsidian CLI bridge skill (optional)

Setup

1. CLAUDE.md (the important part)

Copy CLAUDE.md into your vault's .claude/ directory:

mkdir -p /path/to/your-vault/.claude
cp CLAUDE.md /path/to/your-vault/.claude/CLAUDE.md

Or merge its contents into your existing .claude/CLAUDE.md if you already have one.

What this gives you: Claude Code will now write Obsidian-native markdown in your vault — [[wikilinks]] instead of plain text references, YAML frontmatter on every file, callouts for emphasis, and it will follow existing links to gather context before making changes.

2. Obsidian Skill (optional)

Copy the skills/ folder into your vault's .claude/ directory:

cp -r skills/ /path/to/your-vault/.claude/skills/

What this gives you: Claude Code gains access to Obsidian's runtime via CLI — backlinks, indexed search, task lists, vault health (orphans, dead-ends, broken links), and frontmatter property management. Things you can't get from just reading files.

Requires: Obsidian 1.12.4+ running with the CLI enabled.

Why a CLAUDE.md Matters for Obsidian Vaults

Without instructions, Claude Code writes standard markdown. It uses [text](path) links, skips frontmatter, and treats your vault like a flat folder of files. The result is notes that exist in your vault but aren't part of it — no graph connections, no backlinks, no discoverability.

A CLAUDE.md fixes this by teaching Claude your vault's conventions:

  • Wikilinks build your graph. Every [[link]] Claude writes becomes a connection in Obsidian's graph view and backlink panels. Without this instruction, Claude uses standard markdown links that Obsidian doesn't index the same way.

  • Frontmatter enables structure. Properties like type, date, and tags make files searchable, filterable, and usable in Obsidian Bases and Dataview. Without frontmatter, files are just blobs of text.

  • Link-following gives Claude context. When Claude reads a file and encounters [[wikilinks]], it knows to follow relevant ones to understand the broader picture — the same way you'd click through links to build context. This means better, more informed edits.

  • Conventions compound. Once Claude knows your vault's patterns (callout types, tag taxonomy, file naming), every new file it creates is consistent with the rest. Your vault stays coherent as it grows.

The CLAUDE.md is a one-time setup that pays off on every interaction.

Customization

The included CLAUDE.md covers generic Obsidian mechanics. You'll get more value by extending it with your vault's specific conventions:

  • Vault layout — describe your folder structure so Claude knows where to create files
  • Frontmatter schemas — define what properties each file type should have
  • Tag taxonomy — list your tags and what they mean
  • Custom callout types — define domain-specific callouts (e.g., [!decision], [!blocked])
  • Linking rules — specify which files should always link to which (e.g., daily notes → weekly plans)

Requirements

  • Claude Code installed and configured
  • An Obsidian vault
  • (For the skill) Obsidian 1.12.4+ running with CLI enabled

License

MIT — use it however you want.

About

Make Claude Code understand and write native Obsidian markdown — wikilinks, frontmatter, callouts, tags — so your vault stays connected.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors