obsidian

Read, search, and create Markdown notes in an Obsidian vault via scripts using OBSIDIAN_VAULT_PATH.

1|Updated Apr 30, 2025
One-click install
npx skills add https://github.com/lucasfth/config --skill obsidian-lucasfth
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian
Source: https://github.com/lucasfth/config/tree/main/.hermes/skills/note-taking/obsidian
Command: npx skills add https://github.com/lucasfth/config --skill obsidian-lucasfth

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Obsidian vault users often need to read, search, and create notes programmatically, which can be tedious when working outside the Obsidian UI. This Skill provides command-line access to a vault, enabling quick retrieval and creation of notes.

Core Features & Use Cases

  • Read a note by path to inspect content without opening the app.
  • List notes and folders within the vault for quick navigation.
  • Search notes by filename or content to locate relevant information.
  • Create or append notes to the vault, preserving linking conventions (Wikilinks).

Quick Start

Read the contents of a specific note from the Obsidian vault using the vault path defined by OBSIDIAN_VAULT_PATH.

Frequently Asked Questions about obsidian

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

FAQPage Schema
How do I search Obsidian vault contents from the command line?

You can search Obsidian vault contents from the command line by using this Skill to locate notes by filename or content. It accesses the vault via the OBSIDIAN_VAULT_PATH environment variable and standard shell utilities.

Can I create or append notes in an Obsidian vault using scripts?

Yes, you can create or append notes in an Obsidian vault using scripts. This Skill writes Markdown notes directly to the vault path, preserving standard linking conventions like Wikilinks during the creation process.

How do I list notes and folders in an Obsidian vault without opening the app?

To list notes and folders in an Obsidian vault without opening the app, this Skill uses standard shell utilities to read the directory structure. This enables quick programmatic navigation of your local vault contents.

Do I need a specific environment variable to read Obsidian notes programmatically?

Yes, you need the OBSIDIAN_VAULT_PATH environment variable set to read Obsidian notes programmatically. This local path allows the shell utilities to access, read, and search the Markdown files within your vault.

What is the best way to retrieve a specific note from an Obsidian vault for automation?

The best way to retrieve a specific note for automation is to read the note by its file path. This Skill provides command-line access to inspect Markdown content directly from the local vault without launching the Obsidian UI.