Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Full-text search across structured Markdown documentation archives using SQLite FTS5. Use when you need to search large collections of Markdown articles that...
Full-text search across structured Markdown documentation archives using SQLite FTS5. Use when you need to search large collections of Markdown articles that...
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
Fast, indexed full-text search across Markdown documentation archives using SQLite FTS5 with BM25 relevance ranking.
Searching documentation archives for specific features, capabilities, or information Finding official source URLs to cite in reports Looking up technical specifications or configuration details Research across multiple documentation sources
Articles separated by --- delimiter with *Source: URL: # Article Title *Source: https://docs.example.com/path/to/article.html* Article content here... --- # Next Article Title *Source: https://docs.example.com/another/article.html* More content...
# 1. Index the documentation (one-time or when docs change) scripts/docs.py index ./docs # 2. Search scripts/docs.py search "kubernetes backup" --max 5 # 3. Check index status scripts/docs.py status
The unified CLI handles all operations:
# Index documentation directory scripts/docs.py index ./docs # Force full rebuild scripts/docs.py index ./docs --rebuild # Custom database location scripts/docs.py index ./docs --db /path/to/custom.db
# Basic search scripts/docs.py search "kubernetes backup" # Boolean operators scripts/docs.py search "AWS AND S3 AND snapshot" # Phrase search scripts/docs.py search '"exact phrase match"' # Prefix search scripts/docs.py search "kube*" # Exclude terms scripts/docs.py search "backup NOT restore" # Title-only search scripts/docs.py search "kubernetes" --title-only # Output formats scripts/docs.py search "kubernetes" --format json scripts/docs.py search "kubernetes" --format markdown # More context around matches scripts/docs.py search "kubernetes" --context 400 # Include full content in JSON scripts/docs.py search "kubernetes" --format json --full-content
SyntaxMeaningterm1 term2Documents with term1 OR term2 (ranked)term1 AND term2Documents with both termsterm1 OR term2Documents with either term"exact phrase"Exact phrase matchprefix*Words starting with prefixterm1 NOT term2term1 without term2title:termSearch only titles
# Get article by partial URL or title scripts/docs.py get "system_requirements" --full # Find all matching articles scripts/docs.py get "backup" --all
# Check index statistics scripts/docs.py status
# Check what's indexed scripts/docs.py status # Explore topics with broad searches scripts/docs.py search "<feature>" --max 20
# Narrow down with boolean operators scripts/docs.py search "<feature> AND <platform>" # Find specific information scripts/docs.py search "limitation OR restriction OR 'not supported'"
Every search result includes the Source: URL โ use this in your reports: According to documentation, [finding]... Source: https://docs.example.com/path/to/article.html
Each agent or project can have their own documentation and index: ~/docs/VendorA/ โโโ docs_part_01.md โโโ docs.db # Index lives with docs โโโ ... ~/docs/VendorB/ โโโ docs.md โโโ docs.db โโโ ... The docs.py script auto-detects the database location.
For specialized needs: scripts/fts_search.py โ Direct FTS5 search with more options scripts/index_docs.py โ Standalone indexing scripts/list_sources.py โ List all source URLs scripts/get_article.py โ Direct article retrieval scripts/search_docs.py โ Regex-based search (no index needed)
For common search patterns (feature research, architecture, security, etc.), see references/search-patterns.md.
# What's available? scripts/docs.py status # Output: Files indexed: 37, Articles indexed: 32065 # Find information scripts/docs.py search "kubernetes backup" --max 5 # Narrow to specific platform scripts/docs.py search "kubernetes AND AWS" --max 5 # Find limitations scripts/docs.py search "limitation OR 'not supported'" # Get full article for citation scripts/docs.py get "system_requirements" --full
Index once, search many times โ FTS5 is fast because it's indexed Use boolean operators โ AND, OR, NOT for precision Phrase search for exact terms โ "exact match" with quotes Always cite sources โ Include Source: URLs in reports Rebuild periodically โ Re-index when documentation updates Use JSON for analysis โ Pipe to jq or other tools for processing
Workflow acceleration for inboxes, docs, calendars, planning, and execution loops.
Largest current source with strong distribution and engagement signals.