关于 convex-env
convex-env 用于将机密信息作为 Convex 部署环境变量管理。它说明如何按部署设置变量、在 action 中读取,以及在不暴露机密值的情况下检查变量名。
主要功能
- 01按部署设置环境变量
- 02在 action 中通过 process.env 读取值
- 03只列出已配置名称,不显示机密值
- 04避免将机密写入代码或 git
适用场景
- 01为 Convex 部署存储凭据
- 02在 action 中访问机密
- 03安全检查已配置的变量名
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ convex/ agent-skills --skill convex-env安装后在 Claude Code 中输入/convex-env确认已加载。
详细介绍
管理环境变量和密钥
将密钥存储为 Convex 部署环境变量(npx convex env set),在操作中通过 process.env 读取,切勿提交密钥。
工作流
npx convex env set KEY value(针对每个部署)。- 在操作中通过 process.env.KEY 读取(不要在查询/变更中读取)。
- 切勿将密钥硬编码或提交;仅在本地将其添加到 .env.local。
- 使用
npx convex env list --names-only确认已设置,该命令只列出名称,不会输出密钥值。
规则
- 密钥存储在 Convex 环境变量中,绝不存储在代码或 git 中。
- process.env 只能用于操作中(必要时使用 'use node'),不能用于查询/变更。
- 不同部署需要各自的值。
- 使用
npx convex env list --names-only检查已设置的变量;切勿在对话中输出密钥值。
评论
支持 Markdown