Npx Y convex@latest mcp start

Convex 是一款开源响应式数据库，专为让 Web 应用开发者（无论是人类还是大模型）轻松开发而设计。通过编写纯 TypeScript，您可以获取数据并以强一致性执行业务逻辑。

Convex 提供数据库、编写服务端函数的平台以及客户端库。借助 Convex，您可以轻松构建并扩展动态实时更新的应用。 阅读文档，了解详情。

Convex 后端由 Convex 团队主导开发。我们 欢迎提交小型错误修复，也 乐于听取反馈。我们会在几天内将此代码库与任何内部开发工作保持同步。Convex 是一款经过充分测试的软件，包含多个设计精良的测试框架，包括随机测试。这些测试不属于开源版本的一部分。

入门

访问我们的文档，了解更多 Convex 信息并按照入门指南开始使用。

使用 Convex 构建应用的最简单方式是使用我们的 云平台，它提供慷慨的免费套餐，让您专注于构建应用，无需担心基础设施。许多小型应用和个人项目都可以完全免费使用该套餐，且无需维护。

自托管

可自托管产品包含云产品的大多数功能，包括控制面板和 CLI。可自托管的 Convex 适用于多种工具，包括 Neon、Fly.io、Vercel、Netlify、RDS、Sqlite、Postgres 等。

您可以使用 Docker（推荐）或预构建二进制文件来进行 Convex 自托管。请参阅我们的自托管指南，了解详细说明。您可以在 Discord 的 #self-hosted 频道获取自托管社区支持。

社区与支持

• 加入我们的 Discord 社区，获取帮助并参与讨论。
• 在构建和使用开源 Convex 后端时遇到问题，请通过 GitHub Issues 报告。
• 提交拉取请求即表示您确认，Convex 可以按照自行选择的条款使用、修改、复制和再分发您的贡献。

从源代码构建

请参阅 BUILD.md。

免责声明

• 如果您选择自托管，我们建议您遵循自托管指南。如果您选择从源代码构建，请务必将实例密钥和管理员密钥从代码库中的默认值改掉。
• Convex 在 Linux 和 Mac 上经过了最充分的实战测试。在 Windows 上的使用经验较少。如果您遇到问题，请在 Discord 的 #self-hosted 频道联系我们。
• Convex 可自托管版本包含一个信标，以帮助 Convex 改进产品。信标收集的信息极少且匿名，对 Convex 有帮助；但如果您确实想禁用它，可以在后端二进制文件中设置 --disable-beacon 标志。信标消息会输出到日志中，仅包括：
  • 您的部署的随机标识符（不会用于其他用途）
  • 数据库的迁移版本
  • 后端的 Git 修订版本
  • 后端的运行时长

仓库布局

• crates/ 包含 Rust 代码

  • 主二进制文件
    • local_backend/ 是基于 Runtime 构建的应用服务器，是 Convex 云的服务入口。

• npm-packages/ 包含我们的公开和内部 TypeScript 包。

  • 内部包
    • udf-runtime/ 为查询和 mutation 设置用户定义函数的 JS 环境
    • system-udfs/ 包含 Convex 系统使用的函数，例如 CLI