convex-env について
convex-env は、Convex デプロイの環境変数としてシークレットを管理するスキルです。デプロイごとの設定、アクションからの参照、値を漏らさずに名前を確認する方法を扱います。
主な機能
- 01デプロイごとの環境変数設定
- 02アクションでの process.env による値の参照
- 03シークレット値を表示しない名前一覧
- 04コードや git へのシークレット記載の回避
活用シーン
- 01Convex デプロイ用の認証情報の保存
- 02アクションからのシークレット参照
- 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 対応