关于 convex
为 Convex 开发提供技能索引的编码 Agent 指南,按任务选择并加载对应技能,涵盖函数、数据模型、安全和项目流程。
主要功能
- 01按任务选择 Convex 技能
- 02涵盖函数、实时功能与存储
- 03提供安全检查与审计指南
- 04附带项目流程及 Git 安全规则
适用场景
- 01实现 Convex 查询、变更和操作
- 02设计表结构、索引或数据迁移
- 03检查公开函数的授权与数据暴露
- 04规划多步骤开发和安全撤销更改
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ waynesutton/ builder-skills --skill convex安装后在 Claude Code 中输入/convex确认已加载。
附带文件agents/openai.yamlassets/small-logo.svg
详细介绍
Convex
从这里开始,选择下方匹配的技能并加载。如果没有匹配项,仍须遵守底部的规则。
选择技能
| 技能 | 在以下情况加载 |
|---|---|
| convex-best-practices | 通用模式、项目结构、“这是不是 Convex 的做法” |
| convex-functions | 查询、变更、操作、内部函数、错误处理 |
| convex-schema-validator | 表、索引、验证器、v.* 类型、架构变更 |
| convex-realtime | useQuery、乐观更新、分页、在线状态、重新渲染频繁 |
| convex-http-actions | Webhook、REST 端点、convex/http.ts、Stripe 或 Clerk 回调 |
| convex-file-storage | 上传、上传 URL、提供文件、存储清理 |
| convex-cron-jobs | crons.ts、runAfter、runAt、批处理、未触发的定时任务 |
| convex-migrations | 数据回填、字段重命名、实时数据的架构演进 |
| convex-agents | AI Agent、线程、工具、流式传输、使用 @convex-dev/agent 实现 RAG |
| convex-component-authoring | 构建可复用的组件包、defineComponent |
| convex-security-check | 发布前快速审计:公共函数的身份验证、暴露的数据 |
| convex-security-audit | 深度审查:授权模型、注入、速率限制、密钥 |
| avoid-feature-creep | 对范围扩张提出异议、精简 MVP、“再加一个功能” |
| project-workflow | 多步骤任务、prds/ 中的 PRD、task.md、供审查的计划 |
| project-docs | 让 task.md、changelog.md、files.md 与已交付代码保持同步 |
| git-safety | revert、undo、reset、checkout、clean、stash、force push |
通常会同时用到两个技能。代码任务加载领域技能,工作流任务加载流程技能,例如 convex-functions 加上 project-workflow。
适用于所有情况的规则
- 每个函数都要声明
args和returns验证器,包括内部函数。 - 使用
withIndex读取。对整张表扫描后再用.filter()是迟早会出问题的做法。 - 变更必须具备幂等性。检查当前状态;无需操作时直接返回。
- 仅对
internal.*函数进行调度和设置定时任务。绝不使用api.*。 - 不要在查询中调用
Date.now()。将时间作为参数传入。 - 开发时使用
npx convex dev。除非收到要求,否则不要运行npx convex deploy。 - 在依据记忆使用 API 前,先获取 https://docs.convex.dev/llms.txt。
禁止事项
- 不要编辑
convex/_generated/下的任何内容。 - 不要使用
crons.daily、crons.hourly或crons.weekly。使用crons.interval或crons.cron。 - 不要在同时导出查询或变更的文件中添加
"use node"。 - 未先加载 git-safety,不要运行会丢弃工作的 git 命令。
文档
评论
支持 Markdown