Back to Skills

skill-obsidian-search-tool

verified

Search Obsidian vault via DQL and JsonLogic

View on GitHub

Marketplace

obsidian-search-tool

dnvriend/obsidian-search-tool

Plugin

obsidian-search-tool

Repository

dnvriend/obsidian-search-tool

plugins/obsidian-search-tool/skills/obsidian-search-tool/SKILL.md

Last Verified

January 21, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/dnvriend/obsidian-search-tool/blob/main/plugins/obsidian-search-tool/skills/obsidian-search-tool/SKILL.md -a claude-code --skill skill-obsidian-search-tool

Installation paths:

Claude
.claude/skills/skill-obsidian-search-tool/
Powered by add-skill CLI

Instructions

# When to use
- Search Obsidian vault from command line
- Query notes with Dataview TABLE queries
- Filter notes with JsonLogic expressions
- Integrate Obsidian search in workflows

# Obsidian Search Tool Skill

## Purpose

A professional CLI tool for searching an Obsidian vault through the Obsidian Local REST API using Dataview Query Language (DQL) TABLE queries and JsonLogic queries. Enables programmatic access to Obsidian notes for automation, scripting, and integration workflows.

## When to Use This Skill

**Use this skill when:**
- You need to search an Obsidian vault from the command line
- You want to query notes using Dataview DQL TABLE syntax
- You need to filter notes with JsonLogic expressions
- You're building automation workflows that interact with Obsidian
- You want to integrate Obsidian search into CI/CD pipelines

**Do NOT use this skill for:**
- Modifying or creating Obsidian notes (read-only tool)
- Searching without Obsidian Local REST API plugin
- Complex queries requiring GROUP BY or FLATTEN (API limitation)

## CLI Tool: obsidian-search-tool

Python CLI tool (version 0.1.0) that interfaces with Obsidian's Local REST API plugin to perform searches using Dataview Query Language and JsonLogic.

### Installation

```bash
# Clone repository
git clone https://github.com/dnvriend/obsidian-search-tool.git
cd obsidian-search-tool

# Install with uv
uv tool install .

# Or install from source
uv sync
uv tool install . --reinstall
```

### Prerequisites

1. **Obsidian** must be running
2. **Local REST API plugin** by Adam Coddington installed and enabled
3. **Dataview plugin** by Michael Brenan installed and enabled
4. **OBSIDIAN_API_KEY** environment variable set with API key from plugin settings

```bash
# Set API key (get from Obsidian → Settings → Community Plugins → Local REST API)
export OBSIDIAN_API_KEY="your-api-key-here"
```

### Quick Start

```bash
# Check API connectivity
obsidian-search-tool status

# Validate authentication
obsidian-search

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
15565 chars

Issues Found:

  • name_directory_mismatch