obsidian-plugin-vault
Installation
SKILL.md
Obsidian Plugin Vault
This skill covers the Vault API for reading, writing, and managing files and folders inside an Obsidian vault. It also covers the file type hierarchy (TFile, TAbstractFile, TFolder), vault events, and the MetadataCache for querying parsed frontmatter, headings, links, and tags.
When to Use This Skill
- Reading or modifying note contents programmatically
- Creating, deleting, or renaming files and folders
- Batch-processing all Markdown files in the vault
- Listening for file changes (create, modify, delete, rename)
- Querying parsed metadata (frontmatter, headings, links, embeds, tags)
- Working with the active file or resolving file paths
Overview
this.app.vault is the primary interface for file system operations. It extends Events, so you can subscribe to vault-wide changes. this.app.metadataCache provides pre-parsed metadata for every indexed file, avoiding the need to parse Markdown yourself.
Key rule: always use Vault APIs instead of raw Node.js fs calls. Obsidian's abstraction handles sync, mobile compatibility, and link updates.