convex-env について
convex-env は、Convex の環境変数とシークレットを管理する開発者向けのスキルです。デプロイごとの設定や読み取り、コードやバージョン管理へのシークレット混入防止を扱います。
主な機能
- 01デプロイごとの環境変数設定
- 02action 内での変数読み取り
- 03シークレットのコミット防止
- 04変数一覧による確認
活用シーン
- 01デプロイごとのシークレット設定
- 02action での環境変数の利用
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ get-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で確認します。
ルール
- シークレットは Convex の環境変数に保存し、コードや git には含めないでください。
- process.env はアクション内でのみ使用します(必要に応じて 'use node' を指定します)。クエリやミューテーションでは使用しないでください。
- デプロイ環境ごとに、それぞれ独自の値が必要です。
コメント
Markdown 対応