OpenAICloudflare Developer PlatformMar 25, 2026, 12:00 AM

Workers - Declare required secrets in your Wrangler configuration

A condensed section focused on the key takeaways first.

Original Post

Quick Digest

Summary

A condensed section focused on the key takeaways first.

openaienmodel: gpt-5-mini-2025-08-07

Workers - Declare required secrets in your Wrangler configuration

Key Points

  • Declare required secrets in wrangler config
  • Type generation works in CI without env files
  • Deploy fails if required secrets are missing

Summary

The new secrets configuration property (secrets.required) lets you declare the secret names a Worker needs in your wrangler.toml / wrangler.jsonc. Wrangler uses that list for local development, type generation, and deploy-time validation so missing secrets are caught earlier and CI-friendly typing works without env files.

Key Points

  • Configure required secrets in your Wrangler config:

    JSON example:

    {
      "secrets": { "required": ["API_KEY", "DB_PASSWORD"] }
    }
    

    TOML example:

    [secrets]
    required = ["API_KEY", "DB_PASSWORD"]
    
  • Local development: wrangler dev and vite dev will load only keys listed in secrets.required from .dev.vars / .env / process.env. Extra keys are ignored. Missing required secrets produce a logged warning listing names.

  • Type generation: wrangler types generates typed secret bindings from secrets.required (not inferred from env files), enabling safe typegen in CI. Per-environment secrets become optional in the aggregated Env type if they only exist for some environments.

  • Deploy validation: wrangler deploy and wrangler versions validate that each name in secrets.required is configured for the Worker and will fail with an error listing any missing secrets.

Recommended actions

  • Add all required secret names to secrets.required in your Wrangler config.
  • Ensure those secrets are set in your Cloudflare Worker environments (or in local .dev.vars for development).
  • Run wrangler types in CI to produce consistent typed bindings without relying on env files.

Full Translation

Translations

A translation section that keeps the flow of the original article.

openaijamodel: gpt-5-mini-2025-08-07

Workers — Wrangler構成で必須のシークレットを宣言する

Workers — Wrangler構成で必須のシークレットを宣言する

公開日: 2026-03-25

概要

新しい secrets 構成プロパティにより、Wrangler の構成ファイルで Worker が必要とするシークレット名を宣言できます。

必須のシークレットはローカル開発とデプロイ時に検証され、型生成のソース・オブ・トゥルースとして使用されます。

wrangler.jsonc

{
 " secrets " : {
 " required " : [ "API_KEY" , "DB_PASSWORD" ],
},
}

wrangler.toml

[ secrets ]
required = [ "API_KEY" , "DB_PASSWORD" ]

ローカル開発

  • secrets が定義されている場合、wrangler devvite dev.dev.vars.env / process.env から secrets.required にリストされたキーのみを読み込みます。追加のキーは除外されます。
  • 必須のシークレットが不足している場合、欠落している名前を列挙した警告がログに出力されます。

型生成

  • wrangler types.dev.vars.env から名前を推測するのではなく、secrets.required から型付きバインディングを生成します。
  • これにより、CI やこれらのファイルが存在しない他の環境でも型生成を実行できます。
  • 環境ごとのシークレットもサポートされています — 集約された Env 型は一部の環境でのみ存在するシークレットをオプショナルとしてマークします。

デプロイ

  • wrangler deploy および wrangler versions upload は、操作が成功する前に secrets.required に含まれるすべてのシークレットが Worker に設定されていることを検証します。
  • 必須のシークレットが不足している場合、どのシークレットを設定する必要があるかを列挙したエラーによりコマンドは失敗します。

詳細

詳しくは secrets configuration property reference を参照してください。