项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 2723
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- macOS 环境,需先安装 Xcode 命令行工具与 Homebrew
- NodeJS LTS 版本 + Yarn 包管理器
- Rust 工具链(rustup)及 cargo-watch
- Docker(用于启动本地开发所需的容器服务)
- 本地需具备 tmuxp(README 用 tmuxp load trieve 拉起服务,但未给出安装命令)
安装与启动步骤
-
1安装系统基础依赖
macOS 下先装 Xcode 命令行工具、Homebrew,再装 pkg-config 和 openssl;装完可能需重开终端。
xcode-select --install /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" brew install pkg-config openssl -
2安装 Node 与 Yarn
用 NVM 安装脚本装 NVM,重开终端刷新配置后装 Node LTS,再全局安装 Yarn。
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash nvm install --lts npm install -g yarn -
3安装 Rust 环境
通过 rustup 官方脚本安装 Rust 工具链,随后用 cargo 安装 cargo-watch 用于开发热重载。
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh cargo install cargo-watch -
4准备各端环境变量
前端各子项目与 server 都需要各自的 .env;README 提示可能需先在 ./frontends 下创建 analytics 目录。
mkdir -p ./frontends/analytics cp .env.analytics ./frontends/analytics/.env cp .env.chat ./frontends/chat/.env cp .env.search ./frontends/search/.env cp .env.example ./server/.env cp .env.dashboard ./frontends/dashboard/.env -
5启动依赖容器
把 chat/search/server/docker-compose 四份环境变量合并成根目录 .env,再用 convenience.sh 拉起本地开发所需容器服务。
cat .env.chat .env.search .env.server .env.docker-compose > .env ./convenience.sh -l -
6装前端依赖并构建 SDK
先在 frontends 下执行 yarn 安装依赖,再到 clients/ts-sdk 执行 yarn build 构建 TypeScript SDK。
cd frontends && yarn cd ../clients/ts-sdk && yarn build cd ../.. -
7拉起全部本地服务
README 说明在 cargo build 完成后使用 tmuxp 加载 trieve 进程组来同时运行前后端服务。
tmuxp load trieve -
8可选:装 MCP 服务
若想在 Claude Desktop 中直接使用 Trieve,可用 Smithery CLI 一键安装 trieve-mcp-server。
npx -y @smithery/cli install trieve-mcp-server --client claude
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
server/.env | 是 | 服务端主配置,由仓库根目录 .env.example 复制而来 | .env.example |
frontends/analytics/.env | 是 | analytics 前端环境变量,由 .env.analytics 复制 | .env.analytics |
frontends/chat/.env | 是 | chat 前端环境变量,由 .env.chat 复制 | .env.chat |
frontends/search/.env | 是 | search 前端环境变量,由 .env.search 复制 | .env.search |
frontends/dashboard/.env | 是 | dashboard 前端环境变量,由 .env.dashboard 复制 | .env.dashboard |
OPENAI_API_KEY | 否 | 运行 evals 评测时通过命令行前缀传入的模型密钥 | sk-xxxxxxxx |
如何确认成功
浏览器打开 http://localhost:8090/redoc 能看到 OpenAPI 文档;http://localhost:5173 可注册并创建测试数据集;http://localhost:5174 可搜索该数据集。
常见问题
Q:验证时页面打不开怎么办?
A:确认 ./convenience.sh -l 拉起的容器仍在运行,且 cargo build / tmuxp load trieve 已完成;8090 为 API 文档端口,5173 为 dashboard,5174 为搜索页。
Q:非 macOS 系统能用这份流程吗?
A:README 给的是 macOS 本地开发流程(Xcode、Homebrew 均为 macOS 专用);Linux/Windows 需自行替换为对应的依赖安装方式,README 未给出对应命令。
Q:怎么跑 evals 评测?
A:evals 包会加载 MCP 客户端执行 index.ts,无需反复重建;用环境变量前缀传入密钥即可:OPENAI_API_KEY=your-key npx mcp-eval evals.ts clients/mcp-server/src/index.ts。
Q:如何测试 Stripe 支付相关功能?
A:先装 Stripe CLI,执行 stripe login 和 stripe listen --forward-to localhost:8090/api/stripe/webhook,把返回的签名密钥写入 server/.env 的 STRIPE_WEBHOOK_SECRET,再创建产品和订阅计划。
Q:有没有更省事的使用方式?
A:可以直接注册官方托管服务(dashboard.trieve.ai,含免费额度),或者用 Smithery 一键把 trieve-mcp-server 装进 Claude Desktop,无需自托管。
注意事项
- 本流程为 README 中的本地开发(Local Setup)自托管方式,部署到 AWS/GCP/K8s 的完整自托管指南需查阅官方文档。
- README 提示可能需要先在 ./frontends 下手动创建 analytics 目录,否则 cp .env.analytics 会失败。
- 最后一步 tmuxp load trieve 依赖 tmuxp,README 未给出其安装命令,请自行确认环境已具备。
- 自托管后还可调用官方 SDK:TypeScript SDK(ts-sdk.trieve.ai)与 Python SDK(trieve-py-client)。
核心亮点
- Rust 实现,性能高,延迟低,适合生产环境
- 一体化 API,集成搜索、推荐和 RAG,减少开发工作量
- 支持自托管,数据隐私可控,避免依赖第三方云服务
不足之处
- 文档和社区生态相对较小,学习资源有限
- 高级功能配置复杂,需要一定的搜索和 AI 背景知识
适用场景
- 为 SaaS 产品添加智能搜索和 AI 问答功能
- 构建企业知识库,实现文档检索和摘要生成
- 电商平台实现个性化推荐和搜索排序
替代项目
Meilisearch、Qdrant、Weaviate
上一篇:rag-web-ui
下一篇:code-graph-rag
同类项目推荐
awesome-papers
开源
按主题整理 AI 系统论文笔记,快速找到该读的文献
Here are my personal paper reading notes (including machine learning systems, AI inf···
YT-Navigator
开源
搜 YouTube 视频内容,像聊天一样直接问,秒出带时间戳的答案
YT Navigator: AI-powered YouTube content explorer that lets you search and chat with···
Medical-Graph-RAG
开源
让医疗AI回答有据可查,告别凭空捏造
A Graph RAG System for Evidenced-based Medical Information Retrieval [ACL 2025]
A-Systematic-Literature-Review-o···
开源
一篇文章看懂 RAG 架构、检索与落地场景
A systematic literature review of Retrieval Augmented Generation (RAG) models, cover···
pi-llm-wiki
开源
把散乱资料自动织成互链维基,越用越聪明
Self-maintaining, Obsidian-compatible knowledge base for pi — turn raw sources into···
SeekStorm
开源
搜亿级数据秒出结果,快到你怀疑人生
SeekStorm: vector & lexical search - in-process library & multi-tenancy server, in R···
awesome-ai-tools
开源
一张清单,快速找到靠谱AI工具,省去全网搜索时间
A curated list of Artificial Intelligence Top Tools
arcana
开源
在 Elixir/Phoenix 里快速接入 RAG 智能搜索,自带仪表盘
Embeddable RAG library for Elixir/Phoenix with agentic pipelines and dashboard
anysearch-skill
开源
给 AI 智能体一键装上实时搜索与整页抓取能力
Unified real-time search engine skill for AI agents. Supports general web search, ve···
