使い方
- インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
- 必要なツール、認証情報、対応環境を原文で確認します。
- 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/convex/agent-skills --skill convex-env開始前の確認
- 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
- スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。
<!-- GENERATED from convex-agents content/capabilities/env.json — do not edit by hand. -->
Manage env vars + secrets
Store secrets as Convex deployment env vars (npx convex env set), read them in any Convex function through the typed env export, never commit them.
Workflow
- Declare the var in the
envsection ofdefineApp(ordefineComponentfor a component) inconvex.config.ts, e.g.env: { KEY: v.string() }. This generates the typedenvexport. Components don't see the app's env vars, so pass any a component declares through its.use()call, e.g.app.use(myComponent, { env: { KEY: app.env.KEY } }). npx convex env set KEY value(per deployment). For secrets, keep the value out of shell history: omit it to be prompted (npx convex env set KEY) or pipe it in on stdin (e.g.pbpaste | npx convex env set KEY).- Read via
env.KEYfromimport { env } from "./_generated/server"in queries, mutations or actions. Prefer it overprocess.env.KEY. - Never hardcode or commit secrets;
.env.localvalues don't reach Convex functions, so set the dev deployment's value too. - Confirm it's set with
npx convex env list --names-only, which lists names without printing the secret values.
Rules
- Secrets live in Convex env vars, never in code or git.
- Read env vars through the typed
envexport in queries, mutations and actions.process.envremains available as a legacy/fallback path, e.g. for existing or third-party code that expects to read env vars there. - Different deployments need their own values.
- Check what is set with
npx convex env list --names-only; never print secret values into the conversation.