📚 docs-search

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

PyPI Python License CI
🤖 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>/),多文档库并存互不干扰。

🔓 不绑定路径

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

⬆️ 上传接口

Web UI 拖拽上传 + POST /api/upload;仅 .md、≤10MB、文件名消毒防穿越。

🖥 跨平台

Windows / macOS / Linux;控制台 UTF-8 兼容,防多进程重复绑定端口。

详细手册 / Guides

🧑‍💻 人类使用手册

安装、CLI 完整参考、Web UI、路径与索引库规则、安全模型、故障排查 FAQ。

阅读 HUMAN-GUIDE →

🤖 Agent 操作手册

机器可读调用协议:API 优先的集成方式、错误处理表、常见任务配方。

阅读 AGENT-GUIDE →

🔌 Web API 参考

全部 6 个端点:参数、curl 示例、响应结构、错误码。

阅读 API.md →

🛠 开发与贡献

工程结构、验证链、发布流程(仓库内文档)。

查看仓库 →
← 返回首页 查看 .md 原文