📚 docs-search

零依赖本地文档搜索引擎 — SQLite 索引 · 毫秒级检索 · CLI + Web UI + 文档上传
Zero-dependency local document search engine — SQLite index, millisecond retrieval.

PyPI v1.4.0 Python 3.10+ License MIT CI 4 矩阵全绿

pip install docs-search GitHub 仓库

🤖 AI Agent 入口：本站提供机器可读索引 AGENT-INDEX.json（工具元数据 / API 端点 / 调用协议 / 退出码），以及 AGENT-GUIDE.md 操作手册。抓取 .md 原文请直接用 URL。

快速开始 / Quick Start

# 安装（或从源码：python scripts/docs-search.py）
pip install docs-search

# 索引一个文档目录（默认 ./docs，也可用 --dir 指定）
docs-search index --dir /path/to/your/docs

# 搜索（多关键词 AND，毫秒级）
docs-search search "关键词" --dir /path/to/your/docs

# 启动 Web UI（含拖拽上传 / 上传接口）
docs-search-web /path/to/your/docs
# → http://127.0.0.1:8765

特性 / Features

⚡ 毫秒级检索

SQLite 索引，搜索前自动检测文件变更并增量重建。

📦 零依赖

纯 Python 标准库（3.10+），运行时零第三方依赖；本地模式无网络请求、无遥测。

🗂 多库隔离

索引库按文档目录哈希隔离（~/.docs-search/<hash>/）；每次操作可带 workspace 切自包含库，all 跨库聚合。

🔓 不绑定路径

文档目录由 --dir / 环境变量 DOCS_SEARCH_DIR / ./docs 解析，无任何写死路径。

🤝 Agent 对接

内置 MCP stdio server：Cursor / ZCode / Qoder / DSH / Cline / OpenCode / Reasonix / Command Code / MiniMax Code / pi 即插即用；docs-search-install 一键写入已安装 agent 的配置（幂等/子集/附加参数）；支持远程模式（--url 连已运行服务）。