用途
env 技能用于管理 Convex 应用的环境变量与密钥,把 API 密钥等敏感信息存入 Convex 部署的环境变量中,而不是写死在代码或提交到版本库。当用户需要为 Convex 应用设置或接入部署环境变量、密钥时使用该技能。
主要能力与使用方式
- 按部署设置变量:执行
npx convex env set KEY value,每个部署单独配置取值。 - 在代码中读取:在 action 内通过
process.env.KEY读取;如需要可加'use node'。 - 确认已设置项:执行
npx convex env list --names-only,该命令只列出变量名称,不打印密钥值。 - 本地配置:密钥不硬编码、不提交;本地环境仅在
.env.local中配置。
规则与限制
- 密钥只存于 Convex 环境变量,不得出现在代码或 git 中。
process.env仅在 action 中使用,不用于 query/mutation。- 不同部署需要各自设置对应的值。
- 检查配置时只使用
--names-only方式列出名称,绝不把密钥值打印到对话中。