xiaoyaosearch

环境要求

• 支持 Windows / macOS / Linux（开发者部署），整合包部署仅支持 Windows
• 已安装 Python 环境，可执行 pip 命令
• 已安装 Node.js 与 npm，用于前端依赖和开发服务器
• 已安装 Ollama，并可拉取 qwen2.5:1.5b 模型
• 可访问百度网盘下载 BGE-M3、faster-whisper、CN-CLIP 等默认模型（提取码 ycr5）

安装与启动步骤

1. 1克隆项目

   把仓库拉取到本地并进入项目目录，后续所有命令都在该目录下执行。

   git clone https://github.com/dtsola/xiaoyaosearch.git
   cd xiaoyaosearch

   复制

2. 2安装后端依赖

   在项目根目录安装 requirements.txt 中的依赖（默认 CPU 推理引擎），并单独安装 faster-whisper 语音识别依赖。

   pip install -r requirements.txt
   pip install faster-whisper

   复制

3. 3安装并拉取Ollama

   先安装 Ollama 客户端，安装完成后打开命令行启动服务并拉取默认大模型 qwen2.5:1.5b。

   ollama serve
   ollama pull qwen2.5:1.5b

   复制

4. 4下载并放置模型

   从百度网盘下载默认模型（链接 https://pan.baidu.com/s/1jRcTztvjf8aiExUh6oayVg 提取码 ycr5），按目录解压：嵌入模型放 data/models/embedding、语音模型放 data/mo

5. 5配置环境变量

   按 README 给出的路径与接口配置数据、API 和日志参数（示例为 CPU 环境相对路径），建议先跑通默认配置再更换模型。

   FAISS_INDEX_PATH=../data/indexes/faiss
   WHOOSH_INDEX_PATH=../data/indexes/whoosh
   DATABASE_PATH=../data/database/xiaoyao_search.db
   API_HOST=127.0.0.1
   API_PORT=8000
   API_RELOAD=true
   LOG_LEVEL=info
   LOG_FILE=../data/logs/app.log

   复制

6. 6启动后端服务

   两种启动方式任选其一：python main.py 使用内置配置，或用 uvicorn 指定 127.0.0.1:8000 并开启热重载。

   python main.py

   复制

7. 7部署并启动前端

   在前端目录执行 npm install 安装依赖，再用 npm run dev 启动开发服务器，与后端配合使用。

   npm install
   npm run dev

   复制

8. 8配置MCP客户端

   小遥搜索 MCP 服务器使用 HTTP 传输协议，任何支持 HTTP MCP 的客户端都可连接；启动 MCP 后可用 Claude Code CLI 检查是否添加成功。

   claude mcp list

   复制

关键配置

如何确认成功

后端在 127.0.0.1:8000 正常响应、前端开发服务器启动无报错；若配置了 MCP，执行 claude mcp list 能看到小遥搜索。

常见问题

注意事项

• 整合包解压目录建议不要包含中文路径，避免脚本执行异常。
• 建议先准备默认模型并成功启动应用后，再更换其他模型。
• 本地运行默认数据不上传，使用云端 API 时性能与隐私需自行权衡。
• 默认安装的是 CPU 版本推理引擎，需要 GPU 加速请按显卡型号选择对应准备脚本。