Docdex FAQs

Question 1

What types of files can Docdex index, and how does it handle updates?

Accepted Answer

Docdex primarily indexes Markdown and plain text files within your project repositories. It supports live file watching while serving, enabling incremental index updates to keep your search results always current without needing a full reindex.

Question 2

How does Docdex ensure data privacy and security?

Accepted Answer

Docdex operates entirely locally, storing its index on-disk within your project repository without making any network calls. It enforces robust security defaults including auth token requirements, TLS, IP allowlisting, rate limiting, and strict state directory permissions.

Question 3

How do I get started with Docdex for my project?

Accepted Answer

You can install Docdex globally via npm (`npm i -g docdex`). After installation, use `docdexd index --repo /path/to/your/repo` to build the initial index, then `docdexd serve --repo /path/to/your/repo` to start the HTTP API, or use `docdexd query` for CLI-based searches.

Question 4

Is Docdex compatible with AI coding assistants and development tools?

Accepted Answer

Absolutely. Docdex is designed with AI in mind, providing AI-friendly output like structured summaries, snippets, and document metadata. It even offers a dedicated `/ai-help` JSON playbook to guide agents on its capabilities and best practices.

Question 5

What is Docdex and what problem does it solve?

Accepted Answer

Docdex is a lightweight, local daemon that indexes and searches your project's Markdown and text documentation files. It solves the problem of efficiently accessing and leveraging local project knowledge for developers, coding assistants, and AI tools, without needing external services or uploads.

Docdex

Docdex

主な機能

ユースケース

主な機能

ユースケース