Quivr - 您的第二大脑，由生成式人工智能驱动

用生成式人工智能的力量成为您的个人助手！把它想象成 Obsidian，但是加入了AI功能。

路线图在此

主要功能 🎯

  • 快速高效：设计时考虑了速度和效率。Quivr 确保快速访问您的数据。
  • 安全：您的数据，您掌控。始终如此。
  • 操作系统兼容性：Ubuntu 22 或更新版本。
  • 文件兼容性：文本、Markdown、PDF、Powerpoint、Excel、CSV、Word、音频、视频
  • 开源：自由是美好的，Quivr 也是如此。开源并且免费使用。
  • 公开/私有：通过公共链接与用户分享您的大脑，或保持私密。
  • 市场：与世界分享您的大脑，或使用其他人的大脑提升您的生产力。
  • 离线模式：Quivr 可以离线工作，因此您可以随时随地访问您的数据。

演示亮点 🎥

https://github.com/quivrhq/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5

入门指南 🚀

按照以下说明，在您的本地机器上进行开发和测试，运行项目的副本。

您可以在文档中找到所有内容。

先决条件 📋

确保已安装以下内容：

  • Docker
  • Docker Compose

60秒安装 💽

您可以在这里找到安装视频。

  • 步骤0：Supabase CLI

    按照此处的说明安装所需的 Supabase CLI。

    supabase -v # 检查安装是否成功

  • 步骤1：克隆存储库：

    git clone https://github.com/quivrhq/quivr.git && cd quivr

  • 步骤2：复制 .env.example 文件

    cp .env.example .env

  • 步骤3：更新 .env 文件

    vim .env # 或者 emacs 或 vscode 或 nano

    更新 .env 文件中的 OPENAI_API_KEY。

    您只需要在 .env 文件中更新 OPENAI_API_KEY 变量。

    您可以在此处获取您的 API 密钥。您需要先创建一个帐户。

    然后放入您的信用卡信息。不用担心，除非您使用该 API，否则您不会被收费。您可以在这里找到有关定价的更多信息。

  • 步骤4：启动项目

    cd backend && supabase start

    然后

    cd ../
docker compose pull
docker compose up

    如果您使用的是 Mac，请转到 Docker Desktop > 设置 > 通用，并检查 “文件共享实现” 是否设置为 VirtioFS。

    如果您是开发人员，您可以使用以下命令以开发模式运行项目：docker compose -f docker-compose.dev.yml up --build

  • 步骤5：登录应用程序

    您现在可以使用 admin@quivr.app 和 admin 登录应用程序。您可以在 http://localhost:3000/login 访问该应用程序。

    您可以在 http://localhost:5050/docs 访问 Quivr 后端 API。

    您可以在 http://localhost:54323 访问 supabase。

更新 Quivr 🚀

  • 步骤1：拉取最新更改

    git pull

  • 步骤2：更新迁移

    supabase migration up

    许可证 📄

本项目基于 Apache 2.0 许可证 - 有关详细信息，请参阅 LICENSE 文件

星星历史 📈

Star History Chart

参考资料

https://github.com/QuivrHQ/quivr/blob/main/README.md