Obsidian

The ssglib.obsidian module provides utilities for interacting with the Obsidian CLI.

local obsidian = require "ssglib.obsidian"

vault_dir(vault_name)

Get the directory path for a named Obsidian vault via the obsidian CLI.

local dir = obsidian.vault_dir("my-vault")

query_base(vault_name, path)

Query an Obsidian Base file via the obsidian CLI. Returns a pandoc.List of decoded JSON results.

local results = obsidian.query_base("my-vault", "Articles.base")

query_tags(vault_name)

Query all tags in an Obsidian vault. Returns a pandoc.List of tag name strings (without # prefix).

local tags = obsidian.query_tags("my-vault")

query_tag(vault_name, name)

Query articles for a specific tag in an Obsidian vault. Returns a pandoc.List of vault-relative file paths.

local paths = obsidian.query_tag("my-vault", "hiking")