关于 convex
Convex 是面向开发者的开源响应式后端平台,使用 TypeScript 查询和函数构建应用。本技能涵盖数据建模、实时模式、身份验证、存储、调度和部署。
主要功能
- 01设计文档关系型架构
- 02编写查询、变更和操作函数
- 03构建实时订阅
- 04配置身份验证
- 05使用文件存储和定时函数
- 06部署和管理项目
适用场景
- 01为现有应用添加 Convex
- 02构建使用 Convex 后端的新项目
- 03调试 Convex 函数
- 04实现响应式数据更新
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ sickn33/ agentic-awesome-skills --skill convex安装后在 Claude Code 中输入/convex确认已加载。
附带文件references/detailed-guide.md
详细介绍
Convex
你是 Convex 领域的专家。Convex 是一个开源的响应式后端平台,其中查询以 TypeScript 代码编写。你深入了解架构设计、函数编写(查询、突变、操作)、实时数据订阅、身份验证、文件存储、调度,以及适用于 React、Next.js、Angular、Vue、Svelte、React Native 和服务端环境的部署工作流。
详细指南
执行此技能前,请阅读详细指南。该指南保留了完整流程和参考资料。必须遵守其中的安全要求、前置条件和验证要求。针对特定任务,请加载相关章节;若要端到端完成任务,请通读整份指南。
适用场景
- 使用 Convex 作为后端构建新项目时
- 将 Convex 添加到现有的 React、Next.js、Angular、Vue、Svelte 或 React Native 应用时
- 为 Convex 文档关系数据库设计架构时
- 编写或调试 Convex 函数(查询、突变、操作)时
- 实现实时/响应式数据模式时
- 使用 Convex Auth 或第三方提供商(Clerk、Auth0 等)设置身份验证时
- 使用 Convex 文件存储、计划函数或 cron 作业时
- 部署或管理 Convex 项目时
限制
-
查询和突变不能调用外部 HTTP API(请改用操作)
-
不支持原始 SQL——你需要使用 Convex 查询构建器 API
-
应用查询、突变和操作可以访问环境变量;组件有独立的绑定/隔离规则。绝不要向客户端返回机密信息。
-
文档大小上限为 1MB
-
函数执行时间受最大时限约束
-
除非使用特定 SSR 模式(使用预加载),否则无法在服务端渲染 Convex 数据
-
架构在写入时强制执行;更改架构需要迁移现有文档数据
-
附带示例会修改/部署云端数据,且并不完整;仅对已确认的部署使用这些示例,并遵循最小权限原则,做好备份并执行分阶段检查。示例不包含运行时/云端验证。
评论
支持 Markdown