Docdex

概要

Docdex is a lightweight, local documentation indexer and search daemon designed to run per-project. It efficiently builds and maintains an on-disk index of your Markdown and text files, serving relevant top-k snippets via a secure HTTP API or CLI. This eliminates the need for external services or cloud uploads, providing a private, hardened solution for integrating project documentation directly into AI coding assistants and other development workflows without leaving your local environment.

主な機能

• Per-repository, local indexing of Markdown and text files without network calls.
• Robust security defaults including TLS, auth token enforcement, IP allowlisting, and rate limiting.
• 4 GitHub stars
• AI-friendly output, providing summaries, snippets, and doc metadata, along with an `/ai-help` JSON playbook for agents.
• Unified HTTP API and CLI for searching, ingesting, and self-checking the index.
• Live file watching for incremental index updates while serving.

ユースケース

• Providing contextual project documentation to AI coding assistants for improved code generation and understanding.
• Enabling fast, local search of a project's technical documentation within a developer's workflow.
• Automating documentation retrieval and updates for custom developer tools and scripts via HTTP or CLI.