obsidian

Read, search, list, and create notes in an Obsidian vault.

27|2|Updated Jan 15, 2024
One-click install
npx skills add https://github.com/erfanzar/Xerxes-Agents --skill obsidian-erfanzar
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian
Source: https://github.com/erfanzar/Xerxes-Agents/tree/main/src/python/xerxes/skills/note-taking/obsidian
Command: npx skills add https://github.com/erfanzar/Xerxes-Agents --skill obsidian-erfanzar

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reading, searching, and creating notes inside an Obsidian vault is cumbersome without a lightweight automation layer. This Skill enables direct, script-based interactions with a local Obsidian vault to read, list, search, and create notes.

Core Features & Use Cases

  • Read a note by path
  • List notes across the vault
  • Search notes by filename or content
  • Create new notes in the vault
  • Append to existing notes
  • Use Obsidian wikilinks ( [[Note Name]] syntax ) to link related content

Quick Start

Read, search, and create notes in your configured Obsidian vault.

Frequently Asked Questions about obsidian

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I search and read notes inside an Obsidian vault?

You can search and read notes inside an Obsidian vault by using script-based operations to list files across folders, search by filename or content, and retrieve specific notes by their file path.

How do I create and link notes in an Obsidian vault?

To create and link notes in an Obsidian vault, you can generate new notes, append content to existing files, and use Obsidian wikilinks like [[Note Name]] to connect related notes across your knowledge base.

Do I need a specific environment variable to access my Obsidian vault?

Yes, accessing an Obsidian vault requires setting the OBSIDIAN_VAULT_PATH environment variable, or the system will default to the ~/Documents/Obsidian Vault directory for shell-based note operations.

Can I append content to existing notes in my personal knowledge base?

Yes, you can append content to existing notes in your personal knowledge base by applying shell-based note operations that target and update files within the configured Obsidian vault directory.

What is the best way to list notes across folders in an Obsidian vault?

The best way to list notes across folders in an Obsidian vault is using a lightweight automation layer that traverses the vault structure to enumerate all stored notes and files.

Are there limitations when managing notes with a script-based approach?

A limitation of this script-based approach is that it requires a local Obsidian vault path and does not interact with the Obsidian GUI, focusing solely on shell-based file operations for text notes.