docs-search

Index local documentation collections into a SQLite FTS5 index with BM25 ranking.

Updated Jan 27, 2026
One-click install
npx skills add https://github.com/carbonscott/deploy-opencode --skill docs-search-carbonscott
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-search
Source: https://github.com/carbonscott/deploy-opencode/tree/main/claude/skills/docs-search
Command: npx skills add https://github.com/carbonscott/deploy-opencode --skill docs-search-carbonscott

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Strategy guide for searching local documentation collections and indexing docs to enable quick retrieval of answers from local sources.

Core Features & Use Cases

  • Discover and index a local documentation tree into a fast searchable SQLite index with BM25 ranking.
  • Perform fast queries across thousands of docs with precise highlighting and snippets.
  • Use the info command to monitor index size and contents and plan maintenance.

Quick Start

Index your documentation folder with the index command, then run a search with your query.

Frequently Asked Questions about docs-search

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

FAQPage Schema
How do I search local documentation offline?

You can index local documentation trees into a SQLite FTS5 index and run CLI queries to retrieve relevant snippets with BM25 ranking entirely offline.

Can I index a large documentation tree incrementally?

Yes, you can index large documentation trees incrementally. The indexer applies SQLite FTS5 with incremental updates to add new docs and maintain search results without full rebuilds.

What is the best way to find specific text across thousands of local docs?

The best way to find text across thousands of local docs is using a SQLite FTS5 index with BM25 ranking, which provides fast queries and precise highlighting to surface relevant snippets.

Does the local documentation search require an internet connection?

No, local documentation search does not require an internet connection. It operates completely offline by indexing files into a local SQLite database and querying them via CLI.

How do I check the size and contents of my documentation index?

You can check the size and contents of your documentation index by using the info CLI command, which monitors index metrics to help you plan maintenance and manage indexed docs.

How does BM25 ranking work for local documentation retrieval?

BM25 ranking for local documentation retrieval scores search results by term frequency and relevance within the SQLite FTS5 index, ensuring the most pertinent snippets surface first during CLI queries.