mcpField
C
convex-env

convex-env

github.com/convexクラウド・DevOps6937.1k 回インストール1 日前に更新
リポジトリ

convex-env について

convex-env は、Convex デプロイの環境変数としてシークレットを管理するスキルです。デプロイごとの設定、アクションからの参照、値を漏らさずに名前を確認する方法を扱います。

主な機能

  1. 01デプロイごとの環境変数設定
  2. 02アクションでの process.env による値の参照
  3. 03シークレット値を表示しない名前一覧
  4. 04コードや git へのシークレット記載の回避

活用シーン

  1. 01Convex デプロイ用の認証情報の保存
  2. 02アクションからのシークレット参照
  3. 03設定済み変数名の安全な確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/convex/agent-skills --skill convex-env

インストール後、Claude Code で/convex-envを入力して読み込まれたか確認します。

詳細

環境変数とシークレットを管理する

シークレットは Convex デプロイメントの環境変数(npx convex env set)として保存し、アクション内で process.env を使って読み込み、決してコミットしないでください。

ワークフロー

  1. npx convex env set KEY value(デプロイメントごとに設定します)。
  2. アクション内で process.env.KEY を使って読み込みます(クエリやミューテーションでは使用しません)。
  3. シークレットをハードコードしたり、コミットしたりしないでください。ローカル用に限り .env.local に追加します。
  4. npx convex env list --names-only を実行して設定を確認します。このコマンドではシークレットの値を表示せず、名前のみを一覧表示します。

ルール

  • シークレットは Convex 環境変数に保存し、コードや git には決して含めません。
  • process.env はアクション内でのみ使用します(必要に応じて 'use node' を指定)。クエリやミューテーションでは使用しません。
  • デプロイメントごとに、それぞれの値を設定する必要があります。
  • npx convex env list --names-only を使って設定内容を確認します。シークレットの値を会話に決して出力しないでください。

コメント