关于 convex-env
convex-env 是指导 Convex 开发者管理部署环境变量和密钥的技能,说明如何设置、读取和验证值,并避免将秘密写入代码或版本库。
主要功能
- 01按部署设置环境变量
- 02在 action 中读取变量
- 03避免提交密钥
- 04列出变量进行核对
适用场景
- 01为不同部署配置密钥
- 02在 action 中使用环境变量
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ get-convex/ agent-skills --skill convex-env安装后在 Claude Code 中输入/convex-env确认已加载。
详细介绍
管理环境变量和机密
将机密存储为 Convex 部署环境变量(npx convex env set),在 action 中通过 process.env 读取,切勿提交。
工作流
npx convex env set KEY value(每个部署分别设置)。- 在 action 中通过 process.env.KEY 读取(不能在 query/mutation 中读取)。
- 切勿将机密硬编码或提交;仅在本地添加到 .env.local。
- 使用
npx convex env list确认。
规则
- 机密应存储在 Convex 环境变量中,切勿放在代码或 git 中。
- process.env 只能在 action 中使用(如有需要,使用 'use node'),不能在 query/mutation 中使用。
- 不同部署需要各自的值。
评论
支持 Markdown