コンテンツにスキップ

コマンド

Wranglerは、Cloudflare Workersを管理するためのいくつかのコマンドを提供します。

  • docs - このページをデフォルトのブラウザで開きます。
  • init - 様々なWebフレームワークやテンプレートから新しいプロジェクトを作成します。 (非推奨 — npm create cloudflare@latestを代わりに使用してください)
  • generate - 既存のWorkersテンプレート ↗を使用してWranglerプロジェクトを作成します。
  • d1 - D1と対話します。
  • vectorize - Vectorizeインデックスと対話します。
  • hyperdrive - Hyperdriveを管理します。
  • deploy - WorkerをCloudflareにデプロイします。
  • dev - Workerの開発用にローカルサーバーを起動します。
  • publish - WorkerをCloudflareに公開します。
  • delete - CloudflareからWorkerを削除します。
  • kv namespace - Workers KVネームスペースを管理します。
  • kv key - Workers KVネームスペース内のキーと値のペアを管理します。
  • kv bulk - Workers KVネームスペース内の複数のキーと値のペアをバッチで管理します。
  • r2 bucket - Workers R2バケットを管理します。
  • r2 object - Workers R2オブジェクトを管理します。
  • secret - Workerの秘密変数を管理します。
  • secret:bulk - Workerの複数の秘密変数を管理します。
  • tail - デプロイされたWorkerからログをライブストリームするセッションを開始します。
  • pages - Cloudflare Pagesを構成します。
  • queues - Workers Queuesを構成します。
  • login - OAuthを使用してCloudflareアカウントでWranglerを認証します。
  • logout - アカウントへのアクセスのためのWranglerの認証を削除します。
  • whoami - ユーザー情報を取得し、認証設定をテストします。
  • versions - 最近のバージョンの詳細を取得します。
  • deployments - 最近のデプロイメントの詳細を取得します。
  • rollback - 最近のデプロイメントにロールバックします。
  • dispatch-namespace - dispatch namespaceと対話します。
  • mtls-certificate - mTLS接続に使用される証明書を管理します。
  • types - バインディングとモジュールルールから型を生成します。

Wranglerコマンドの実行方法

このページはWranglerコマンドのリファレンスを提供します。

wrangler <COMMAND> <SUBCOMMAND> [PARAMETERS] [OPTIONS]

Cloudflareは、プロジェクト内にWranglerをローカルにインストールすること ↗を推奨しているため、Wranglerの実行方法は特定のセットアップやパッケージマネージャーによって異なります。

Terminal window
npx wrangler <COMMAND> <SUBCOMMAND> [PARAMETERS] [OPTIONS]

よく使用するWranglerコマンドをプロジェクトのpackage.jsonファイルのスクリプトとして追加できます：

{
  ...
  "scripts": {
    "deploy": "wrangler deploy",
    "dev": "wrangler dev"
  }
  ...
}

その後、好みのパッケージマネージャーを使用して実行できます：

Terminal window
npm run deploy

docs

デフォルトのブラウザでCloudflare開発者ドキュメントを開きます。

wrangler docs [<COMMAND>]
  • COMMAND string optional
    • 詳細を知りたいWranglerコマンド。これにより、デフォルトのブラウザがそのコマンドを説明するドキュメントのセクションを開きます。

init

create-cloudflare-cli (C3)ツールを介して新しいプロジェクトを作成します。様々なWebフレームワークやテンプレートから選択できます。依存関係はデフォルトでインストールされ、プロジェクトを即座にデプロイするオプションがあります。

wrangler init [<NAME>] [OPTIONS]
  • NAME string optional (default: 作業ディレクトリの名前)
    • Workersプロジェクトの名前。これはディレクトリ名と生成されたwrangler.toml 構成ファイル内のnameプロパティの両方です。
  • --yes boolean optional
    • 新しいプロジェクトに対するプロンプトに「はい」と答えます。
  • --from-dash string optional
    • ダッシュボードから初期化されたWorkerを取得します。これはフラグとWorker名を渡すことで行います。wrangler init --from-dash <WORKER_NAME>。
    • --from-dashコマンドは、コマンドが使用された後にダッシュボードで行われた変更を自動的に同期しません。したがって、CLIの使用を続けることをお勧めします。

generate

既存のWorkersテンプレート ↗を使用して新しいプロジェクトを作成します。

wrangler generate [<NAME>] [TEMPLATE]
  • NAME string optional (default: 作業ディレクトリの名前)
    • Workersプロジェクトの名前。これはディレクトリ名と生成されたwrangler.toml 構成ファイル内のnameプロパティの両方です。
  • TEMPLATE string optional

d1

CloudflareのD1サービスと対話します。

create

新しいD1データベースを作成し、wrangler.tomlファイルに記載するバインディングとUUIDを提供します。

wrangler d1 create <DATABASE_NAME> [OPTIONS]
  • DATABASE_NAME string required
    • 新しいD1データベースの名前。
  • --location string optional
    • データベースリーダーのためのオプションのロケーションヒントを提供します。
    • 利用可能なオプションには、weur（西ヨーロッパ）、eeur（東ヨーロッパ）、apac（アジア太平洋）、oc（オセアニア）、wnam（北アメリカ西部）、enam（北アメリカ東部）があります。

info

D1データベースに関する情報を取得します。現在のデータベースのサイズと状態を含みます。

wrangler d1 info <DATABASE_NAME> [OPTIONS]
  • DATABASE_NAME string required
    • 情報を取得するD1データベースの名前。
  • --json boolean optional
    • 出力をテーブルではなくJSON形式で返します。

list

アカウント内のすべてのD1データベースをリストします。

wrangler d1 list [OPTIONS]
  • --json boolean optional
    • 出力をテーブルではなくJSON形式で返します。

delete

D1データベースを削除します。

wrangler d1 delete <DATABASE_NAME> [OPTIONS]
  • DATABASE_NAME string required
    • 削除するD1データベースの名前。
  • -y, --skip-confirmation boolean optional
    • 削除確認プロンプトをスキップします。

execute

D1データベースでクエリを実行します。

wrangler d1 execute <DATABASE_NAME> [OPTIONS]
  • DATABASE_NAME string required
    • クエリを実行するD1データベースの名前。
  • --command string optional
    • 実行したいSQLクエリ。
  • --file string optional
    • 実行したいSQLファイルへのパス。
  • -y, --yes boolean optional
    • プロンプトに「はい」と答えます。
  • --local boolean(default: true) optional
    • wrangler devで使用するためにローカルデータベースに対してコマンド/ファイルを実行します。
  • --remote boolean (default: false) optional
    • wrangler dev —remoteで使用するためにリモートD1データベースに対してコマンド/ファイルを実行します。
  • --persist-to string optional
    • ローカル永続性に使用するディレクトリを指定します（--localと組み合わせて使用）。
  • --json boolean optional
    • 出力をテーブルではなくJSON形式で返します。
  • --preview boolean optional
    • プレビューD1データベースに対してコマンド/ファイルを実行します（Wrangler.tomlのpreview_database_idで定義されます）。
  • --batch-size number optional
    • 単一バッチで送信するクエリの数。

export

D1データベースまたはテーブルのスキーマおよび/またはコンテンツを.sqlファイルにエクスポートします。

wrangler d1 export <DATABASE_NAME> [OPTIONS]
  • DATABASE_NAME string required
    • エクスポートするD1データベースの名前。
  • --remote boolean (default: false) optional
    • wrangler dev —remoteで使用するためにリモートD1データベースに対してコマンド/ファイルを実行します。
  • --output string optional
    • エクスポート用のSQLファイルへのパス。
  • --table string optional
    • エクスポートするD1データベース内のテーブルの名前。
  • --no-data boolean (default: false) optional
    • エクスポートSQLファイルにデータベースデータが含まれるかどうかを制御します。--no-data=trueは、既知のWranglerの制限によりfalseとして解釈されるため推奨されません。
  • --no-schema boolean (default: false) optional
    • エクスポートSQLファイルにデータベーススキーマが含まれるかどうかを制御します。--no-schema=trueは、既知のWranglerの制限によりfalseとして解釈されるため推奨されません。

time-travel restore

Time Travelを使用して特定の時点にデータベースを復元します。

wrangler d1 time-travel restore <DATABASE_NAME> [OPTIONS]
  • DATABASE_NAME string required
    • クエリを実行するD1データベースの名前。
  • --bookmark string optional
    • 特定の時点でのデータベースの状態を表すD1ブックマーク。
  • --timestamp string optional
    • 過去30日以内のUNIXタイムスタンプまたはJavaScript日付時刻string。
  • --json boolean optional
    • 出力をテーブルではなくJSON形式で返します。

time-travel info

Time Travelを使用して特定の時点でのデータベースの現在の状態を検査します。

wrangler d1 time-travel info <DATABASE_NAME> [OPTIONS]
  • DATABASE_NAME string required
    • クエリを実行するD1データベースの名前。
  • --timestamp string optional
    • 過去30日以内のUNIXタイムスタンプまたはJavaScript日付時刻string。
  • --json boolean optional
    • 出力をテーブルではなくJSON形式で返します。

backup create

D1バックアップを開始します。

wrangler d1 backup create <DATABASE_NAME>
  • DATABASE_NAME string required
    • バックアップするD1データベースの名前。

backup list

利用可能なすべてのバックアップをリストします。

wrangler d1 backup list <DATABASE_NAME>
  • DATABASE_NAME string required
    • バックアップをリストするD1データベースの名前。

backup restore

バックアップをD1データベースに復元します。

wrangler d1 backup restore <DATABASE_NAME> <BACKUP_ID>
  • DATABASE_NAME 文字列 必須
    • バックアップを復元するD1データベースの名前。
  • BACKUP_ID 文字列 必須
    • 復元したいバックアップのID。

backup download

既存のデータをローカルマシンにダウンロードします。

wrangler d1 backup download <DATABASE_NAME> <BACKUP_ID>
  • DATABASE_NAME 文字列 必須
    • バックアップをダウンロードしたいD1データベースの名前。
  • BACKUP_ID 文字列 必須
    • ダウンロードしたいバックアップのID。
  • --output 文字列 オプション
    • 書き込む.sqlite3ファイル（デフォルトは'<DB_NAME>.<SHORT_BACKUP_ID>.sqlite3'）。

migrations create

新しいマイグレーションを作成します。

これにより、migrationsフォルダー内に新しいバージョン付きファイルが生成されます。マイグレーションファイルには変更の説明を付けて名前を付けてください。これにより、migrationsフォルダー内でマイグレーションを見つけやすくなります。例として、ファイル名は次のようになります：

0000_create_user_table.sql

ファイル名にはバージョン番号と、以下で指定したマイグレーション名が含まれます。

wrangler d1 migrations create <DATABASE_NAME> <MIGRATION_NAME>
  • DATABASE_NAME 文字列 必須
    • マイグレーションを作成したいD1データベースの名前。
  • MIGRATION_NAME 文字列 必須
    • 作成したいマイグレーションの説明的な名前。

migrations list

適用されていないマイグレーションファイルのリストを表示します。

wrangler d1 migrations list <DATABASE_NAME> [OPTIONS]
  • DATABASE_NAME 文字列 必須
    • 適用されていないマイグレーションのリストを表示したいD1データベースの名前。
  • --local ブール値 オプション
    • ローカルに保存されたD1データベースの適用されていないマイグレーションファイルのリストを表示します。
  • --persist-to 文字列 オプション
    • ローカルの永続性に使用するディレクトリを指定します（--localと組み合わせて使用）。
  • --preview ブール値 オプション
    • プレビューD1データベースの適用されていないマイグレーションファイルのリストを表示します（wrangler.tomlのpreview_database_idで定義）。

migrations apply

適用されていないマイグレーションを適用します。

このコマンドは、適用しようとしているマイグレーションを確認するように促します。続行することを確認してください。その後、バックアップが取得されます。

各マイグレーションの進行状況は、コンソールに表示されます。

CI/CD環境や他の非対話型コマンドラインでapplyコマンドを実行する場合、確認ステップはスキップされますが、バックアップは依然として取得されます。

マイグレーションの適用中にエラーが発生した場合、このマイグレーションはロールバックされ、前の成功したマイグレーションは適用されたままになります。

wrangler d1 migrations apply <DATABASE_NAME> [OPTIONS]
  • DATABASE_NAME 文字列 必須
    • マイグレーションを適用したいD1データベースの名前。
  • --local ブール値（デフォルト: true）オプション
    • ローカルに保存されたD1データベースで適用されていないマイグレーションを実行します。
  • --remote ブール値（デフォルト: false）オプション
    • リモートD1データベースで適用されていないマイグレーションを実行します。
  • --persist-to 文字列 オプション
    • ローカルの永続性に使用するディレクトリを指定します（--localと組み合わせて使用）。
  • --preview ブール値 オプション
    • プレビューD1データベースで適用されていないマイグレーションを実行します（wrangler.tomlのpreview_database_idで定義）。
  • --batch-size 数値 オプション
    • 一度に送信するクエリの数。

hyperdrive

Hyperdriveデータベースの設定を管理します。

create

新しいHyperdrive設定を作成します。

wrangler hyperdrive create <ID> [OPTIONS]
  • ID 文字列 必須
    • 作成するHyperdrive設定のID。
  • --connection-string 文字列 オプション
    • postgres://user:password@hostname:port/database形式のデータベース接続文字列。
  • --host 文字列 オプション
    • Hyperdriveが接続するホスト名またはIPアドレス。
  • --port 数値 オプション
    • 接続するデータベースのポート。
  • --scheme 文字列 オプション
    • オリジナルデータベースに接続するために使用されるスキーム - 例: postgresqlまたはpostgres。
  • --database 文字列 オプション
    • 接続するデータベース（名前）。例えば、Postgresまたはdefaultdb。
  • --user 文字列 オプション
    • データベースに認証するために使用されるユーザー名。
  • --password 文字列 オプション
    • データベースに認証するために使用されるパスワード。
  • --access-client-id 文字列 オプション
    • オリジナルデータベースに接続する際に使用するアクセストークンのクライアントID。クライアントアクセストークンのシークレットと共に設定する必要があります。portとは相互排他的。
  • --access-client-secret 文字列 オプション
    • オリジナルデータベースに接続する際に使用するアクセストークンのクライアントシークレット。クライアントアクセストークンのIDと共に設定する必要があります。portとは相互排他的。
  • --caching-disabled ブール値 オプション
    • SQLレスポンスのキャッシングを無効にします。
  • --max-age 数値 オプション
    • アイテムがキャッシュに保持される最大期間を指定します。キャッシングが無効な場合は設定できません。
  • --swr 数値 オプション
    • Stale While Revalidate - キャッシュが古くなった後にレスポンスを提供できる秒数を示します。キャッシングが無効な場合は設定できません。

update

既存のHyperdrive設定を更新します。

wrangler hyperdrive update <ID> [OPTIONS]
  • ID 文字列 必須
    • 更新するHyperdrive設定のID。
  • --name 文字列 オプション
    • Hyperdrive設定の新しい名前。
  • --origin-host 文字列 オプション
    • Hyperdriveが接続する新しいデータベースのホスト名またはIPアドレス。
  • --origin-port 文字列 オプション
    • 接続する新しいデータベースのポート。
  • --database 文字列 オプション
    • 接続する新しいデータベース（名前）。例えば、Postgresまたはdefaultdb。
  • --origin-user 文字列 オプション
    • データベースに認証するために使用される新しいユーザー名。
  • --origin-password 文字列 オプション
    • データベースに認証するために使用される新しいパスワード。
  • --access-client-id 文字列 オプション
    • オリジナルデータベースに接続する際に使用するアクセストークンのクライアントID。クライアントアクセストークンのシークレットと共に設定する必要があります。origin-portとは相互排他的。
  • --access-client-secret 文字列 オプション
    • オリジナルデータベースに接続する際に使用するアクセストークンのクライアントシークレット。クライアントアクセストークンのIDと共に設定する必要があります。origin-portとは相互排他的。
  • --caching-disabled ブール値 オプション
    • SQLレスポンスのキャッシングを無効にします。
  • --max-age 数値 オプション
    • アイテムがキャッシュに保持される最大期間を指定します。キャッシングが無効な場合は設定できません。
  • --swr 数値 オプション
    • Stale While Revalidate - キャッシュが古くなった後にレスポンスを提供できる秒数を示します。キャッシングが無効な場合は設定できません。

list

すべてのHyperdrive設定をリストします。

wrangler hyperdrive list

delete

既存のHyperdrive設定を削除します。

wrangler hyperdrive delete <ID>
  • ID 文字列 必須
    • 削除するHyperdrive設定の名前。

get

既存のHyperdrive設定を取得します。

wrangler hyperdrive get <ID>
  • ID 文字列 必須
    • 取得するHyperdrive設定の名前。

vectorize

Vectorizeベクターデータベースと対話します。

create

新しいベクターインデックスを作成し、wrangler.tomlファイルに記載するバインディングと名前を提供します。

Terminal window
npx wrangler vectorize create <INDEX_NAME> [--dimensions=<NUM_DIMENSIONS>] [--metric=<DISTANCE_METRIC>] [--description=<DESCRIPTION>]
  • INDEX_NAME 文字列 必須
    • 作成する新しいインデックスの名前。アカウントごとに一意であり、作成後は変更できず、インデックスの削除後に再利用できません。
  • --dimensions 数値 必須
    • インデックスの設定に使用するベクターの次元幅。作成後は変更できません。
  • --metric 文字列 必須
    • ベクター距離を計算するために使用する距離メトリック。cosine、euclidean、またはdot-productのいずれかでなければなりません。
  • --description 文字列 オプション
    • インデックスの説明。
  • --deprecated-v1 ブール値 オプション
    • レガシーVectorizeインデックスを作成します。レガシーVectorizeインデックスは非推奨のパスにありますのでご注意ください。

list

アカウント内のすべてのVectorizeインデックスをリストし、設定された次元と距離メトリックを含みます。

Terminal window
npx wrangler vectorize list
  • --deprecated-v1 ブール値 オプション
    • レガシーVectorizeインデックスをリストします。レガシーVectorizeインデックスは非推奨のパスにありますのでご注意ください。

get

個々のインデックスの詳細を取得し、その設定を含みます。

Terminal window
npx wrangler vectorize get <INDEX_NAME>
  • INDEX_NAME 文字列 必須
    • 詳細を取得するインデックスの名前。
  • --deprecated-v1 ブール値 オプション
    • レガシーVectorizeインデックスを取得します。レガシーVectorizeインデックスは非推奨のパスにありますのでご注意ください。

info

個々のインデックスに関する追加情報を取得し、ベクター数や最後に処理された変更の詳細を含みます。

Terminal window
npx wrangler vectorize info <INDEX_NAME>
  • INDEX_NAME 文字列 必須
    • 詳細を取得するインデックスの名前。

delete

Vectorizeインデックスを削除します。

Terminal window
npx wrangler vectorize delete <INDEX_NAME> [OPTIONS]
  • INDEX_NAME 文字列 必須
    • 削除するVectorizeインデックスの名前。
  • --force ブール値 オプション
    • インデックスを削除する際に確認をスキップします（注意：これは回復不可能な操作です）。
  • --deprecated-v1 ブール値 オプション
    • レガシーVectorizeインデックスを削除します。レガシーVectorizeインデックスは非推奨のパスにありますのでご注意ください。

insert

インデックスにベクターを挿入します。

Terminal window
npx wrangler vectorize insert <INDEX_NAME> [OPTIONS]
  • INDEX_NAME 文字列 必須
    • ベクターをアップサートするVectorizeインデックスの名前。
  • --file 文字列 必須
    • 挿入するベクターを改行区切りのJSON（JSON）形式で含むファイル。
  • --batch-size 数値 オプション
    • 一度に挿入するベクターの数（デフォルト: 1000）。
  • --deprecated-v1 ブール値 オプション
    • レガシーVectorizeインデックスに挿入します。レガシーVectorizeインデックスは非推奨のパスにありますのでご注意ください。

upsert

インデックスにベクターをアップサートします。インデックス内の既存のベクターは上書きされます。

Terminal window
npx wrangler vectorize upsert <INDEX_NAME> [OPTIONS]
  • INDEX_NAME 文字列 必須
    • ベクターをアップサートするVectorizeインデックスの名前。
  • --file 文字列 必須
    • 挿入するベクターを改行区切りのJSON（JSON）形式で含むファイル。
  • --batch-size 数値 オプション
    • 一度に挿入するベクターの数（デフォルト: 5000）。

query

類似ベクターのためにVectorizeインデックスをクエリします。

Terminal window
npx wrangler vectorize query <INDEX_NAME> [OPTIONS]
  • INDEX_NAME 文字列 必須
    • クエリするVectorizeインデックスの名前。
  • --vector 配列 必須
    • Vectorizeインデックスに対してクエリを実行するベクター。
  • --top-k 数値 オプション
    • クエリするベクターの数（デフォルト: 5）。
  • --return-values ブール値 オプション
    • レスポンスにベクター値を返すように有効にします（デフォルト: false）。
  • --return-metadata 文字列 オプション
    • レスポンスにベクターメタデータを返すように有効にします。none、indexed、またはallのいずれかでなければなりません（デフォルト: none）。
  • --namespace 文字列 オプション
    • この名前空間からのベクターのみを含むクエリ応答。
  • --filter 文字列 オプション
    • このメタデータフィルターに基づいてベクターをフィルタリングします。例: '{ 'p1': 'abc', 'p2': { '$ne': true }, 'p3': 10, 'p4': false, 'nested.p5': 'abcd' }'

get-vectors

提供されたIDを使用してVectorizeインデックスからベクターを取得します。

Terminal window
npx wrangler vectorize get-vectors <INDEX_NAME> [OPTIONS]
  • INDEX_NAME 文字列 必須
    • ベクターを取得するVectorizeインデックスの名前。
  • --ids 配列 必須
    • ベクターを取得するためのIDのリスト。

delete-vectors

提供されたIDを使用してVectorizeインデックス内のベクターを削除します。

Terminal window
npx wrangler vectorize delete-vectors <INDEX_NAME> [OPTIONS]
  • INDEX_NAME 文字列 必須
    • ベクターを削除するVectorizeインデックスの名前。
  • --ids 配列 必須
    • 削除するベクターに対応するIDのリスト。

create-metadata-index

指定されたプロパティに対してメタデータフィルタリングを有効にします。

Terminal window
npx wrangler vectorize create-metadata-index <INDEX_NAME> [OPTIONS]
  • INDEX_NAME 文字列 必須
    • メタデータインデックスを作成するVectorizeインデックスの名前。
  • --property-name 文字列 必須
    • メタデータフィルタリングを有効にするメタデータプロパティ。
  • --type 文字列 必須
    • プロパティのデータ型。string、number、またはbooleanのいずれかでなければなりません。

list-metadata-index

メタデータフィルタリングが有効なメタデータプロパティをリストします。

Terminal window
npx wrangler vectorize list-metadata-index <INDEX_NAME> [OPTIONS]
  • INDEX_NAME string required
    • メタデータインデックスを取得するためのVectorizeインデックスの名前。

delete-metadata-index

指定されたプロパティのメタデータフィルタリングを無効にします。

Terminal window
npx wrangler vectorize delete-metadata-index <INDEX_NAME> [OPTIONS]
  • INDEX_NAME string required
    • メタデータインデックスを無効にするためのVectorizeインデックスの名前。
  • --property-name string required
    • メタデータフィルタリングを無効にするメタデータプロパティ。

dev

Workerの開発のためにローカルサーバーを起動します。

wrangler dev [<SCRIPT>] [OPTIONS]
  • SCRIPT string
    • Workerのエントリポイントへのパス。wrangler.tomlにmainキーが含まれていない場合のみ必須です（例：main = "index.js"）。
  • --name string optional
    • Workerの名前。
  • --no-bundle boolean (default: false) optional
    • Wranglerのビルドステップをスキップします。特にカスタムビルドを使用する際に便利です。詳細については、バンドルを参照してください。
  • --env string optional
    • 特定の環境で実行します。
  • --compatibility-date string optional
    • yyyy-mm-dd形式の日付で、使用されるWorkersランタイムのバージョンを決定するために使用されます。
  • --compatibility-flags, --compatibility-flag string[] optional
    • 互換性チェックに使用するフラグ。
  • --latest boolean (default: true) optional
    • Workersランタイムの最新バージョンを使用します。
  • --ip string optional
    • リッスンするIPアドレス、デフォルトはlocalhostです。
  • --port number optional
    • リッスンするポート。
  • --inspector-port number optional
    • devtoolsが接続するためのポート。
  • --routes, --route string[] optional
    • アップロードするルート。
    • 例：--route example.com/*。
  • --host string optional
    • リクエストを転送するホスト、デフォルトはプロジェクトのゾーンです。
  • --local-protocol “http”|“https” (default: http) optional
    • リクエストをリッスンするプロトコル。
  • --https-key-path string optional
    • カスタム証明書キーへのパス。
  • --https-cert-path string optional
    • カスタム証明書へのパス。
  • --local-upstream string optional
    • ローカルモードでオリジンとして機能するホスト、デフォルトはdev.hostまたはルートです。
  • --legacy-assets string optional experimental
    • 提供される静的アセットのルートフォルダー。
    • 基本的な静的ファイルホスティングのために--nameと--latestと組み合わせて使用します。例：wrangler dev --name personal_blog --legacy-assets dist/ --latest。
  • --assets string optional experimental
    • 提供される静的アセットのルートフォルダー。
  • --site string optional
    • Workers Sitesのための静的アセットのルートフォルダー。
  • --site-include string[] optional
    • サイトディレクトリからのファイルまたはディレクトリ名に一致する.gitignoreスタイルのパターンの配列。マッチしたアイテムのみがアップロードされます。
  • --site-exclude string[] optional
    • サイトディレクトリからのファイルまたはディレクトリ名に一致する.gitignoreスタイルのパターンの配列。マッチしたアイテムはアップロードされません。
  • --upstream-protocol “http”|“https” (default: https) optional
    • ホストにリクエストを転送するためのプロトコル。
  • --var key:value [] optional
    • コードに変数として注入するためのkey:valueペアの配列。値は常に文字列としてWorkerに渡されます。
    • 例：--var git_hash:$(git rev-parse HEAD) test:123は、git_hashとtest変数をWorkerのenvで利用可能にします。
    • このフラグは、wrangler.tomlでvarsを定義する代替手段です。両方の場所で定義されている場合、このフラグの値が使用されます。
  • --define key:value [] optional
    • コード内のグローバル識別子を置き換えるためのkey:valueペアの配列。
    • 例：--define GIT_HASH:$(git rev-parse HEAD)は、ビルド時にGIT_HASHのすべての使用を実際の値に置き換えます。
    • このフラグは、wrangler.tomlでdefineを定義する代替手段です。両方の場所で定義されている場合、このフラグの値が使用されます。
  • --tsconfig string optional
    • カスタムtsconfig.jsonファイルへのパス。
  • --minify boolean optional
    • Workerを最小化します。
  • --node-compat boolean optional
    • Node.jsの互換性を有効にします。
  • --persist-to string optional
    • ローカル永続性に使用するディレクトリを指定します。
  • --remote boolean (default: false) optional
    • Cloudflareのネットワーク上に保存されたリモートリソースとデータに対して開発します。
  • --test-scheduled boolean (default: false) optional
    • 開発中にスケジュールされたイベント（Cron Trigger）をトリガーする/__scheduledフェッチルートを公開します。異なるcronパターンをシミュレートするために、cronクエリパラメータを渡すことができます：/__scheduled?cron=*+*+*+*+*。
  • --log-level “debug”|“info”|“log”|“warn”|“error”|“none” (default: log) optional
    • Wranglerのログレベルを指定します。
  • --show-interactive-dev-session boolean (default: true if the terminal supports interactivity) optional
    • インタラクティブな開発セッションを表示します。
  • --alias Array<string>

wrangler devは、開発中にWorkerをローカルでテストする方法です。wrangler devが実行されている状態で、HTTPリクエストをlocalhost:8787に送信すると、Workerは期待通りに実行されます。また、console.logメッセージや例外がターミナルに表示されます。

deploy

WorkerをCloudflareにデプロイします。

wrangler deploy [<SCRIPT>] [OPTIONS]
  • SCRIPT string
    • Workerのエントリポイントへのパス。wrangler.tomlにmainキーが含まれていない場合のみ必須です（例：main = "index.js"）。
  • --name string optional
    • Workerの名前。
  • --no-bundle boolean (default: false) optional
    • Wranglerのビルドステップをスキップします。特にカスタムビルドを使用する際に便利です。詳細については、バンドルを参照してください。
  • --env string optional
    • 特定の環境で実行します。
  • --outdir string optional
    • WranglerがバンドルされたWorkerファイルを書き込むディレクトリへのパス。
  • --compatibility-date string optional
    • yyyy-mm-dd形式の日付で、使用されるWorkersランタイムのバージョンを決定するために使用されます。
  • --compatibility-flags, --compatibility-flag string[] optional
    • 互換性チェックに使用するフラグ。
  • --latest boolean (default: true) optional
    • Workersランタイムの最新バージョンを使用します。
  • --legacy-assets string optional experimental
    • 提供される静的アセットのルートフォルダー。
    • 基本的な静的ファイルホスティングのために--nameと--latestと組み合わせて使用します。例：wrangler dev --name personal_blog --legacy-assets dist/ --latest。
  • --assets string optional experimental
    • 提供される静的アセットのルートフォルダー。
  • --site string optional
    • Workers Sitesのための静的アセットのルートフォルダー。
  • --site-include string[] optional
    • サイトディレクトリからのファイルまたはディレクトリ名に一致する.gitignoreスタイルのパターンの配列。マッチしたアイテムのみがアップロードされます。
  • --site-exclude string[] optional
    • サイトディレクトリからのファイルまたはディレクトリ名に一致する.gitignoreスタイルのパターンの配列。マッチしたアイテムはアップロードされません。
  • --var key:value [] optional
    • コードに変数として注入するためのkey:valueペアの配列。値は常に文字列としてWorkerに渡されます。
    • 例：--var git_hash:$(git rev-parse HEAD) test:123は、git_hashとtest変数をWorkerのenvで利用可能にします。
    • このフラグは、wrangler.tomlでvarsを定義する代替手段です。両方の場所で定義されている場合、このフラグの値が使用されます。
  • --define key:value [] optional
    • コード内のグローバル識別子を置き換えるためのkey:valueペアの配列。
    • 例：--define GIT_HASH:$(git rev-parse HEAD)は、ビルド時にGIT_HASHのすべての使用を実際の値に置き換えます。
    • このフラグは、wrangler.tomlでdefineを定義する代替手段です。両方の場所で定義されている場合、このフラグの値が使用されます。
  • --triggers, --schedule, --schedules string[] optional
    • デプロイされたWorkerに添付するCronスケジュール。詳細については、Cron Triggerの例を参照してください。
  • --routes, --route string[] optional
    • このWorkerがデプロイされるルート。
    • 例：--route example.com/*。
  • --tsconfig string optional
    • カスタムtsconfig.jsonファイルへのパス。
  • --minify boolean optional
    • デプロイ前にバンドルされたWorkerを最小化します。
  • --node-compat boolean optional
    • node.jsの互換性を有効にします。
  • --dry-run boolean (default: false) optional
    • 実際にライブサーバーにデプロイせずにプロジェクトをコンパイルします。--outdirと組み合わせることで、npx wrangler deployの出力をテストするのにも便利です。また、開発者が生成されたソースマップをSentryのようなサービスにアップロードする機会を提供し、Workerからのエラーをソースコードにマッピングできるようにしますが、サービスがライブになる前に行います。
  • --keep-vars boolean (default: false) optional
    • Wranglerの開発者環境をWorker設定の真実のソースとして扱い、Cloudflareダッシュボードを介して変更を加えないことが推奨されるベストプラクティスです。
    • Cloudflareダッシュボードで環境変数やバインディングを変更した場合、次回デプロイ時にWranglerがそれらを上書きします。この動作を無効にしたい場合は、keep-varsをtrueに設定します。
  • --dispatch-namespace string optional

publish

WorkerをCloudflareに公開します。

wrangler publish [OPTIONS]

delete

Workerとすべての関連するCloudflare開発プラットフォームリソースを削除します。

wrangler delete [<SCRIPT>] [OPTIONS]
  • SCRIPT string
    • Workerのエントリポイントへのパス。wrangler.tomlにmainキーが含まれていない場合のみ必須です（例：main = "index.js"）。
  • --name string optional
    • Workerの名前。
  • --env string optional
    • 特定の環境で実行します。
  • --dry-run boolean (default: false) optional
    • 実際にWorkerを削除しません。これは、wrangler deleteの出力をテストするのに便利です。

kv namespace

Manage Workers KV namespaces.

create

Create a new namespace.

wrangler kv namespace create <NAMESPACE> [OPTIONS]
  • NAMESPACE string required
    • The name of the new namespace.
  • --env string optional
    • Perform on a specific environment.
  • --preview boolean optional
    • Interact with a preview namespace (the preview_id value).

The following is an example of using the create command to create a KV namespace called MY_KV.

Terminal window
npx wrangler kv namespace create "MY_KV"
🌀 Creating namespace with title "worker-MY_KV"
✨ Success!
Add the following to your configuration file in your kv_namespaces array:
kv_namespaces = [
  { binding = "MY_KV", id = "e29b263ab50e42ce9b637fa8370175e8" }
]

The following is an example of using the create command to create a preview KV namespace called MY_KV.

Terminal window
npx wrangler kv namespace create "MY_KV" --preview
🌀 Creating namespace with title "my-site-MY_KV_preview"
✨ Success!
Add the following to your configuration file in your kv_namespaces array:
kv_namespaces = [
  { binding = "MY_KV", preview_id = "15137f8edf6c09742227e99b08aaf273" }
]

list

List all KV namespaces associated with the current account ID.

wrangler kv namespace list

The following is an example that passes the Wrangler command through the jq command:

Terminal window
npx wrangler kv namespace list | jq "."
[
  {
    "id": "06779da6940b431db6e566b4846d64db",
    "title": "TEST_NAMESPACE"
  },
  {
    "id": "32ac1b3c2ed34ed3b397268817dea9ea",
    "title": "STATIC_CONTENT"
  }
]

delete

Delete a given namespace.

wrangler kv namespace delete {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]
  • --binding string
    • The binding name of the namespace, as stored in the wrangler.toml file, to delete.
  • --namespace-id string
    • The ID of the namespace to delete.
  • --env string optional
    • Perform on a specific environment.
  • --preview boolean optional
    • Interact with a preview namespace instead of production.

The following is an example of deleting a KV namespace called MY_KV.

Terminal window
npx wrangler kv namespace delete --binding=MY_KV
Are you sure you want to delete namespace f7b02e7fc70443149ac906dd81ec1791? [y/n]
yes
Deleting namespace f7b02e7fc70443149ac906dd81ec1791
Deleted namespace f7b02e7fc70443149ac906dd81ec1791

The following is an example of deleting a preview KV namespace called MY_KV.

Terminal window
npx wrangler kv namespace delete --binding=MY_KV --preview
Are you sure you want to delete namespace 15137f8edf6c09742227e99b08aaf273? [y/n]
yes
Deleting namespace 15137f8edf6c09742227e99b08aaf273
Deleted namespace 15137f8edf6c09742227e99b08aaf273

kv key

Manage key-value pairs within a Workers KV namespace.

put

Write a single key-value pair to a particular namespace.

wrangler kv key put <KEY> {<VALUE>|--path=<PATH>} {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]
  • KEY string required
    • The key to write to.
  • VALUE string optional
    • The value to write.
  • --path optional
    • When defined, the value is loaded from the file at --path rather than reading it from the VALUE argument. This is ideal for security-sensitive operations because it avoids saving keys and values into your terminal history.
  • --binding string
    • The binding name of the namespace, as stored in the wrangler.toml file, to delete.
  • --namespace-id string
    • The ID of the namespace to delete.
  • --env string optional
    • Perform on a specific environment.
  • --preview boolean optional
    • Interact with a preview namespace instead of production.
  • --ttl number optional
    • The lifetime (in number of seconds) that the key-value pair should exist before expiring. Must be at least 60 seconds. This option takes precedence over the expiration option.
  • --expiration number optional
    • The timestamp, in UNIX seconds, indicating when the key-value pair should expire.
  • --metadata string optional
    • Any (escaped) JSON serialized arbitrary object to a maximum of 1024 bytes.
  • --local boolean optional
    • Interact with locally persisted data.
  • --persist-to string optional
    • Specify directory for locally persisted data.

The following is an example that puts a key-value into the namespace with binding name of MY_KV.

Terminal window
npx wrangler kv key put --binding=MY_KV "my-key" "some-value"
Writing the value "some-value" to key "my-key" on namespace f7b02e7fc70443149ac906dd81ec1791.

The following is an example that puts a key-value into the preview namespace with binding name of MY_KV.

Terminal window
npx wrangler kv key put --binding=MY_KV --preview "my-key" "some-value"
Writing the value "some-value" to key "my-key" on namespace 15137f8edf6c09742227e99b08aaf273.

The following is an example that puts a key-value into a namespace, with a time-to-live value of 10000 seconds.

Terminal window
npx wrangler kv key put --binding=MY_KV "my-key" "some-value" --ttl=10000
Writing the value "some-value" to key "my-key" on namespace f7b02e7fc70443149ac906dd81ec1791.

The following is an example that puts a key-value into a namespace, where the value is read from the value.txt file.

Terminal window
npx wrangler kv key put --binding=MY_KV "my-key" --path=value.txt
Writing the contents of value.txt to the key "my-key" on namespace f7b02e7fc70443149ac906dd81ec1791.

list

Output a list of all keys in a given namespace.

wrangler kv key list {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]
  • --binding string
    • The binding name of the namespace, as stored in the wrangler.toml file, to delete.
  • --namespace-id string
    • The ID of the namespace to delete.
  • --env string optional
    • Perform on a specific environment.
  • --preview boolean optional
    • Interact with a preview namespace instead of production.
  • --prefix string optional
    • Only list keys that begin with the given prefix.
  • --local boolean optional
    • Interact with locally persisted data.
  • --persist-to string optional
    • Specify directory for locally persisted data.

Below is an example that passes the Wrangler command through the jq command:

Terminal window
npx wrangler kv key list --binding=MY_KV --prefix="public" | jq "."
[
  {
    "name": "public_key"
  },
  {
    "name": "public_key_with_expiration",
    "expiration": "2019-09-10T23:18:58Z"
  }
]

get

Read a single value by key from the given namespace.

wrangler kv key get <KEY> {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]
  • KEY string required
    • The key value to get.
  • --binding string
    • The binding name of the namespace, as stored in the wrangler.toml file, to get from.
  • --namespace-id string
    • The ID of the namespace to get from.
  • --env string optional
    • Perform on a specific environment.
  • --preview boolean optional
    • Interact with a preview namespace instead of production.
  • --text boolean optional
    • Decode the returned value as a UTF-8 string.
  • --local boolean optional
    • Interact with locally persisted data.
  • --persist-to string optional
    • Specify directory for locally persisted data.

The following is an example that gets the value of the "my-key" key from the KV namespace with binding name MY_KV.

Terminal window
npx wrangler kv key get --binding=MY_KV "my-key"
value

delete

Remove a single key value pair from the given namespace.

wrangler kv key delete <KEY> {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]
  • KEY string required
    • The key value to get.
  • --binding string
    • The binding name of the namespace, as stored in the wrangler.toml file, to delete.
  • --namespace-id string
    • The ID of the namespace to delete.
  • --env string optional
    • Perform on a specific environment.
  • --preview boolean optional
    • Interact with a preview namespace instead of production.
  • --local boolean optional
    • Interact with locally persisted data.
  • --persist-to string optional
    • Specify directory for locally persisted data.

The following is an example that deletes the key-value pair with key "my-key" from the KV namespace with binding name MY_KV.

Terminal window
npx wrangler kv key delete --binding=MY_KV "my-key"
Deleting the key "my-key" on namespace f7b02e7fc70443149ac906dd81ec1791.

kv bulk

Manage multiple key-value pairs within a Workers KV namespace in batches.

put

Write a JSON file containing an array of key-value pairs to the given namespace.

wrangler kv bulk put <FILENAME> {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]
  • FILENAME string required
    • The JSON file containing an array of key-value pairs to write to the namespace.
  • --binding string
    • The binding name of the namespace, as stored in the wrangler.toml file, to delete.
  • --namespace-id string
    • The ID of the namespace to delete.
  • --env string optional
    • Perform on a specific environment.
  • --preview boolean optional
    • Interact with a preview namespace instead of production.
  • --local boolean optional
    • Interact with locally persisted data.
  • --persist-to string optional
    • Specify directory for locally persisted data.

This command takes a JSON file as an argument with a list of key-value pairs to upload. An example of JSON input:

[
  {
    "key": "test_key",
    "value": "test_value",
    "expiration_ttl": 3600
  }
]

KV namespace values can only store strings. In order to save complex a value, stringify it to JSON:

[
  {
    "key": "test_key",
    "value": "{\"name\": \"test_value\"}",
    "expiration_ttl": 3600
  }
]

Refer to the full schema for key-value entries uploaded via the bulk API:

  • key string required
    • The key’s name. The name may be 512 bytes maximum. All printable, non-whitespace characters are valid.
  • value string required
    • The UTF-8 encoded string to be stored, up to 25 MB in length.
  • metadata object optional
    • Any arbitrary object (must serialize to JSON) to a maximum of 1,024 bytes.
  • expiration number optional
    • The time, measured in number of seconds since the UNIX epoch, at which the key should expire.
  • expiration_ttl number optional
    • The number of seconds the document should exist before expiring. Must be at least 60 seconds.
  • base64 boolean optional
    • When true, the server will decode the value as base64 before storing it. This is useful for writing values that would otherwise be invalid JSON strings, such as images. Defaults to false.

The following is an example of writing all the key-value pairs found in the allthethingsupload.json file.

Terminal window
npx wrangler kv bulk put --binding=MY_KV allthethingsupload.json
Success!

delete

Delete all keys read from a JSON file within a given namespace.

wrangler kv bulk delete <FILENAME> {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]
  • FILENAME string required
    • The JSON file containing an array of keys to delete from the namespace.
  • --binding string
    • The binding name of the namespace, as stored in the wrangler.toml file, to delete.
  • --namespace-id string
    • The ID of the namespace to delete.
  • --env string optional
    • Perform on a specific environment.
  • --preview boolean optional
    • Interact with a preview namespace instead of production.
  • --local boolean optional
    • Interact with locally persisted data.
  • --persist-to string optional
    • Specify directory for locally persisted data.

This command takes a JSON file as an argument containing an array of keys to delete.

The following is an example of the JSON input:

["test_key_1", "test_key_2"]

The following is an example of deleting all the keys found in the allthethingsdelete.json file.

Terminal window
npx wrangler kv bulk delete --binding=MY_KV allthethingsdelete.json
? Are you sure you want to delete all keys in allthethingsdelete.json from kv-namespace with id "f7b02e7fc70443149ac906dd81ec1791"? › (Y/n)
Success!

r2 bucket

R2ストア内のバケットと対話します。

create

新しいR2バケットを作成します。

wrangler r2 bucket create <NAME>
  • NAME string required
    • 新しいR2バケットの名前。
  • --storage-class “Standard”|“InfrequentAccess” optional
    • バケットにアップロードされたオブジェクトのデフォルトストレージクラス。
  • --jurisdiction string optional
    • R2バケットが作成される管轄区域。詳細については、管轄区域の制限を参照してください。

delete

R2バケットを削除します。

wrangler r2 bucket delete <NAME>
  • NAME string required
    • 削除するR2バケットの名前。

list

現在のアカウントのR2バケットをリストします。

wrangler r2 bucket list

notification create

R2バケットのイベント通知ルールを作成します。

wrangler r2 bucket notification create <NAME> --event-type <EVENT_TYPE> --queue <QUEUE_NAME> [OPTIONS]]
  • NAME string required
    • イベント通知ルールを作成するR2バケットの名前。
  • EVENT_TYPE “object-create”|“object-delete” required
  • QUEUE_NAME string required
    • イベント通知メッセージを受信するキューの名前。
  • --prefix string optional
    • オブジェクトがイベント通知をトリガーするために一致しなければならないキー名のプレフィックスを指定します。値は文字列でなければなりません。正規表現はサポートされていません。
  • --suffix string optional
    • オブジェクトがイベント通知をトリガーするために一致しなければならないキー名のサフィックスを指定します。値は文字列でなければなりません。正規表現はサポートされていません。

notification delete

バケットのイベント通知設定からルールを削除します。

wrangler r2 bucket notification delete <NAME> --queue <QUEUE_NAME>
  • NAME string required
    • イベント通知ルールを削除するR2バケットの名前。
  • QUEUE_NAME string required
    • イベント通知ルールに対応するキューの名前。

notification get

バケットのイベント通知設定をリストします。

wrangler r2 bucket notification get <NAME>
  • NAME string required
    • イベント通知設定を取得するR2バケットの名前。

sippy enable

バケットのSippyインクリメンタルマイグレーションを有効にします。

wrangler r2 bucket sippy enable <NAME> [OPTIONS]
  • NAME string required
    • Sippyを有効にするR2バケットの名前。
  • --provider “AWS”|“GCS” required
    • ソースオブジェクトストレージバケットのプロバイダー。
  • --bucket string required
    • ソースオブジェクトストレージバケットの名前。
  • --r2-key-id string required
    • R2アクセスキーID。読み取りおよび書き込みアクセスが必要です。
  • --r2-secret-access-key string required
    • R2シークレットアクセスキー。読み取りおよび書き込みアクセスが必要です。
  • --jurisdiction string optional
    • このR2バケットが存在する管轄区域。管轄区域が指定されている場合に参照します。管轄区域の制限を参照してください。
  • AWS S3プロバイダー固有のオプション:
  • --key-id string optional
  • --secret-access-key string optional
  • --region string optional
    • S3バケットが存在するAWSリージョン。例: us-west-2。
  • Google Cloud Storageプロバイダー固有のオプション:
  • --service-account-key-file string optional
    • Google CloudサービスアカウントキーJSONファイルのパス。このファイルを読み取り、client_emailおよびprivate_keyオプションを設定します。読み取りおよびリストアクセスが必要です。
  • --client-email string optional
  • --private-key string optional
  • このコマンドを正常に実行するには、service-account-key-fileまたはclient_emailとprivate_keyのいずれかを提供する必要があります。

sippy disable

バケットのSippyインクリメンタルマイグレーションを無効にします。

wrangler r2 bucket sippy disable <NAME>
  • NAME string required
    • Sippyを無効にするR2バケットの名前。

sippy get

バケットのSippyインクリメンタルマイグレーションのステータスを取得します。

wrangler r2 bucket sippy get <NAME>
  • NAME string required
    • Sippyのステータスを取得するR2バケットの名前。

r2 object

R2オブジェクトと対話します。

get

R2バケットからオブジェクトを取得します。

wrangler r2 object get <OBJECT_PATH> [OPTIONS]
  • OBJECT_PATH string required
    • {bucket}/{key}形式のソースオブジェクトパス。
  • --local boolean optional
    • ローカルに保存されたデータと対話します。
  • --persist-to string optional
    • ローカルに保存されたデータのディレクトリを指定します。

put

R2バケットにオブジェクトを作成します。

wrangler r2 object put <OBJECT_PATH> [OPTIONS]
  • OBJECT_PATH string required
    • {bucket}/{key}形式の宛先オブジェクトパス。
  • --file string optional
    • アップロードするファイルのパス。--fileまたは--pipeのいずれかを提供する必要があります。
  • --pipe boolean optional
    • ファイルを--fileオプションで指定するのではなく、パイプで入力できるようにします。--fileまたは--pipeのいずれかを提供する必要があります。
  • --content-type string optional
    • オブジェクトデータの形式を説明する標準MIMEタイプ。
  • --content-disposition string optional
    • オブジェクトのプレゼンテーション情報を指定します。
  • --content-encoding string optional
    • オブジェクトに適用されたコンテンツエンコーディングを指定し、Content-Typeヘッダーフィールドで参照されるメディアタイプを取得するために適用されるデコーディングメカニズムを指定します。
  • --content-language string optional
    • コンテンツの言語。
  • --cache-control string optional
    • リクエスト/応答チェーンに沿ったキャッシング動作を指定します。
  • --expires string optional
    • オブジェクトがキャッシュできなくなる日時。
  • --local boolean optional
    • ローカルに保存されたデータと対話します。
  • --persist-to string optional
    • ローカルに保存されたデータのディレクトリを指定します。

delete

R2バケット内のオブジェクトを削除します。

wrangler r2 object delete <OBJECT_PATH> [OPTIONS]
  • OBJECT_PATH string required
    • {bucket}/{key}形式の宛先オブジェクトパス。
  • --local boolean optional
    • ローカルに保存されたデータと対話します。
  • --persist-to string optional
    • ローカルに保存されたデータのディレクトリを指定します。

secret

Workerの秘密変数を管理します。

このアクションは、Workerの新しいバージョンを作成し、即座にデプロイします。Workerの新しいバージョンを作成するだけの場合は、wrangler versions secretコマンドを使用してください。

put

Workerの秘密を作成または置き換えます。

wrangler secret put <KEY> [OPTIONS]

  • KEY string required

    • Workerでアクセスするためのこの秘密の変数名。

  • --name string optional

    • wrangler.tomlから継承するのではなく、特定のWorkerで実行します。

  • --env string optional

    • 特定の環境で実行します。

このコマンドを実行すると、秘密の値を入力するように求められます：

Terminal window
npx wrangler secret put FOO
? Enter a secret value: › ***
🌀 スクリプトworker-appのための秘密を作成中
✨ 成功！秘密FOOをアップロードしました

putコマンドは、パイプ入力も受け取ることができます。例えば：

Terminal window
echo "-----BEGIN PRIVATE KEY-----\nM...==\n-----END PRIVATE KEY-----\n" | wrangler secret put PRIVATE_KEY

delete

Workerの秘密を削除します。

wrangler secret delete <KEY> [OPTIONS]

  • KEY string required

    • Workerでアクセスするためのこの秘密の変数名。

  • --name string optional

    • wrangler.tomlから継承するのではなく、特定のWorkerで実行します。

  • --env string optional

    • 特定の環境で実行します。

list

Workerのすべての秘密の名前をリストします。

wrangler secret list [OPTIONS]

  • --name string optional

    • wrangler.tomlから継承するのではなく、特定のWorkerで実行します。

  • --env string optional

    • 特定の環境で実行します。

以下は、現在のWorkerの秘密をリストする例です。

Terminal window
npx wrangler secret list
[
  {
    "name": "FOO",
    "type": "secret_text"
  }
]

secret:bulk

Workerの秘密を一度に複数アップロードします。

wrangler secret:bulk [<FILENAME>] [OPTIONS]

  • FILENAME string optional

    • 秘密としてアップロードするためのキーと値のペアを含むJSONファイル、形式は{"SECRET_NAME": "secret value", ...}。
    • 省略した場合、Wranglerはファイルではなくstdinから入力を受け取ることを期待します。

  • --name string optional

    • wrangler.tomlから継承するのではなく、特定のWorkerで実行します。

  • --env string optional

    • 特定の環境で実行します。

以下は、stdinにリダイレクトされたJSONファイルから秘密をアップロードする例です。完了すると、出力の要約にアップロードされた秘密の数とアップロードに失敗した秘密の数が表示されます。

{
  "secret-name-1": "secret-value-1",
  "secret-name-2": "secret-value-2"
}
Terminal window
npx wrangler secret:bulk < secrets.json
🌀 Worker "script-name"のための秘密を作成中
✨ キー: secret-name-1の秘密を正常に作成しました
...
🚨 キー: secret-name-1の秘密のアップロード中にエラーが発生しました
✨ キー: secret-name-2の秘密を正常に作成しました


秘密JSONファイルの処理が完了しました:
✨ 1つの秘密が正常にアップロードされました
🚨 1つの秘密のアップロードに失敗しました

tail

デプロイされたWorkerからログをライブストリームするセッションを開始します。

wrangler tail <WORKER> [OPTIONS]
  • WORKER string required
    • Workerの名前またはWorkerが実行されているルート。
  • --format “json”|“pretty” optional
    • ログエントリの形式。
  • --status “ok”|“error”|“canceled” optional
    • 呼び出しステータスでフィルタリングします。
  • --header string optional
    • HTTPヘッダーでフィルタリングします。
  • --method string optional
    • HTTPメソッドでフィルタリングします。
  • --sampling-rate number optional
    • ログサンプリング率にリクエストの一部を追加します（0から1の間）。
  • --search string optional
    • console.logメッセージ内のテキスト一致でフィルタリングします。
  • --ip (string|“self”)[] optional
    • リクエストの発信元IPアドレスでフィルタリングします。自分のIPからのメッセージのみを表示するには、"self"を使用します。
  • --version-id string optional
    • Workerバージョンでフィルタリングします。

wrangler tailを開始すると、Workerが受信する各リクエストのコンソールおよび例外ログのライブフィードが受信されます。

Workerに高いトラフィックがある場合、tailはサンプリングモードに入ることがあります。これにより、一部のメッセージがドロップされ、tailログに警告が表示されることがあります。メッセージがドロップされないようにするには、上記のオプションを追加してtailメッセージのボリュームをフィルタリングします。

メッセージのフィルタリングにオプションを使用してもサンプリングが続く場合は、インスタントログ ↗の使用を検討してください。

pages

Cloudflare Pagesを構成します。

dev

フルスタックPagesアプリケーションをローカルで開発します。

wrangler pages dev [<DIRECTORY>] [OPTIONS]
  • DIRECTORY string optional
    • 提供する静的アセットのディレクトリ。
  • --local boolean optional (default: true)
    • ローカルマシンで実行します。
  • --ip string optional
    • リッスンするIPアドレス、デフォルトはlocalhost。
  • --port number optional (default: 8788)
    • リッスンするポート（提供するポート）。
  • --binding string[] optional
    • 環境変数または秘密をバインドします（例: --binding <VARIABLE_NAME>=<VALUE>）。
  • --kv string[] optional
    • バインドするKV名前空間のバインディング名（例: --kv <BINDING_NAME>）。
  • --r2 string[] optional
    • バインドするR2バケットのバインディング名（例: --r2 <BINDING_NAME>）。
  • --d1 string[] optional
    • バインドするD1データベースのバインディング名（例: --d1 <BINDING_NAME>）。
  • --do string[] optional
    • バインドするDurable Objectのバインディング名（例: --do <BINDING_NAME>=<CLASS>）。
  • --live-reload boolean optional (default: false)
    • 変更が検出されたときにHTMLページを自動的にリロードします。
  • --compatibility-flag string[] optional
    • 適用するランタイム互換性フラグ。
  • --compatibility-date string optional
    • 適用するランタイム互換性日。
  • --show-interactive-dev-session boolean optional (default: true if the terminal supports interactivity)
    • インタラクティブな開発セッションを表示します。
  • --https-key-path string optional
    • カスタム証明書キーへのパス。
  • --https-cert-path string optional
    • カスタム証明書へのパス。

project list

Pagesプロジェクトのリストを表示します。

wrangler pages project list

project create

新しいCloudflare Pagesプロジェクトを作成します。

wrangler pages project create <PROJECT_NAME> [OPTIONS]
  • PROJECT_NAME string required
    • Pagesプロジェクトの名前。
  • --production-branch string optional
    • プロジェクトの本番ブランチの名前。

project delete

Cloudflare Pagesプロジェクトを削除します。

wrangler pages project delete <PROJECT_NAME> [OPTIONS]
  • PROJECT_NAME string required
    • 削除するPagesプロジェクトの名前。
  • --yes boolean optional
    • 確認プロンプトに「はい」と答えます。

deployment list

Cloudflare Pagesプロジェクトのデプロイメントをリストします。

wrangler pages deployment list [--project-name <PROJECT_NAME>]
  • --project-name string optional
    • デプロイメントをリストするためのプロジェクト名。

deployment tail

デプロイされた Pages Functions からログをライブストリームするセッションを開始します。

wrangler pages deployment tail [<DEPLOYMENT>] [OPTIONS]
  • DEPLOYMENT string optional
    • テールするデプロイメントの ID または URL。デプロイメント ID が不明な場合は環境で指定します。
  • --project-name string optional
    • テールしたいプロジェクトの名前。
  • --environment “production”|“preview” optional
    • 特定のデプロイメント ID を提供しない場合、環境を指定すると最新のプロダクションまたはプレビューのデプロイメントを取得します。
  • --format “json”|“pretty” optional
    • ログエントリのフォーマット。
  • --status “ok”|“error”|“canceled” optional
    • 呼び出しステータスでフィルタリングします。
  • --header string optional
    • HTTP ヘッダーでフィルタリングします。
  • --method string optional
    • HTTP メソッドでフィルタリングします。
  • --sampling-rate number optional
    • ログサンプリングレートに追加するリクエストの割合。
  • --search string optional
    • console.log メッセージ内のテキスト一致でフィルタリングします。
  • --ip (string|“self”)[] optional
    • リクエストが発信される IP アドレスでフィルタリングします。自分の IP からのメッセージのみを表示するには "self" を使用します。

wrangler pages deployment tail を開始すると、Functions が受け取る各リクエストのコンソールおよび例外ログのライブストリームを受け取ります。

deploy

静的アセットのディレクトリを Pages デプロイメントとしてデプロイします。

wrangler pages deploy <BUILD_OUTPUT_DIRECTORY> [OPTIONS]
  • BUILD_OUTPUT_DIRECTORY string optional
    • アップロードする静的ファイルの ディレクトリ。Wrangler 3.45.0 以降、これは Pages プロジェクトに wrangler.toml ファイルがない場合にのみ必要です。詳細については Pages Functions 設定ガイド を参照してください。
  • --project-name string optional
    • デプロイしたいプロジェクトの名前。
  • --branch string optional
    • デプロイしたいブランチの名前。
  • --commit-hash string optional
    • このデプロイメントに添付する SHA。
  • --commit-message string optional
    • このデプロイメントに添付するコミットメッセージ。
  • --commit-dirty boolean optional
    • このデプロイメントのためにワークスペースが汚れていると見なされるかどうか。

publish

静的アセットのディレクトリを Pages デプロイメントとして公開します。

wrangler pages publish [<DIRECTORY>] [OPTIONS]

secret put

Pages プロジェクトのためのシークレットを作成または更新します。

wrangler pages secret put <KEY> [OPTIONS]

  • KEY string required

    • Pages プロジェクトでアクセスされるこのシークレットの変数名。

  • --project-name string optional

    • あなたの Pages プロジェクトの名前。

secret delete

Pages プロジェクトからシークレットを削除します。

wrangler pages secret delete <KEY> [OPTIONS]

  • KEY string required

    • Pages プロジェクトでアクセスされるこのシークレットの変数名。

  • --project-name string optional

    • あなたの Pages プロジェクトの名前。

secret list

Pages プロジェクトのすべてのシークレットの名前をリストします。

wrangler pages secret list [OPTIONS]

  • --project-name string optional

    • あなたの Pages プロジェクトの名前。

secret bulk

Pages プロジェクトのために複数のシークレットを一度にアップロードします。

wrangler pages secret bulk [<FILENAME>] [OPTIONS]

  • FILENAME string optional

    • シークレットとしてアップロードするためのキーと値のペアを含む JSON ファイル、形式は {"SECRET_NAME": "secret value", ...}。
    • 省略した場合、Wrangler はファイルではなく stdin からの入力を受け取ることを期待します。

  • --project-name string optional

    • あなたの Pages プロジェクトの名前。

queues

あなたの Workers Queues 設定を管理します。

create

新しいキューを作成します。

wrangler queues create <name> [OPTIONS]
  • name string required
    • 作成するキューの名前。
  • --delivery-delay-secs number optional
    • 公開されたメッセージが遅延される時間（秒）。正の整数でなければなりません。

delete

既存のキューを削除します。

wrangler queues delete <name> [OPTIONS]
  • name string required
    • 削除するキューの名前。

list

現在のアカウントのすべてのキューをリストします。

wrangler queues list [OPTIONS]

consumer

キューコンシューマの設定を管理します。

consumer add <script-name>

Worker スクリプトを キューコンシューマ として追加します。

wrangler queues consumer add <queue-name> <script-name> [OPTIONS]
  • queue-name string required
    • コンシューマを追加するキューの名前。
  • script-name string required
    • 指定されたキューのコンシューマとして追加する Workers スクリプトの名前。
  • --batch-size number optional
    • バッチあたりの最大メッセージ数。正の整数でなければなりません。
  • --batch-timeout number optional
    • メッセージでバッチを満たすために待機する最大秒数。正の整数でなければなりません。
  • --message-retries number optional
    • 各メッセージの最大再試行回数。正の整数でなければなりません。
  • --max-concurrency number optional
    • 受信メッセージのボリュームを処理するためにスケールアップされる最大同時コンシューマ呼び出し数。正の整数でなければなりません。
  • --retry-delay-secs number optional
    • 再試行されたメッセージが遅延される時間（秒）。正の整数でなければなりません。

consumer remove

キューからコンシューマを削除します。

wrangler queues consumer remove <queue-name> <script-name>
  • queue-name string required
    • コンシューマを削除するキューの名前。
  • script-name string required
    • コンシューマとして削除する Workers スクリプトの名前。

login

OAuth を使用して Wrangler をあなたの Cloudflare アカウントに認証します。Wrangler は自動的にウェブブラウザを開いて Cloudflare アカウントでログインしようとします。

ヘッドレスまたは継続的インテグレーション環境での認証に API トークンを使用することを好む場合は、CI/CD で Wrangler を実行するを参照してください。

wrangler login [OPTIONS]
  • --scopes-list string optional
    • 説明付きのすべての利用可能な OAuth スコープをリストします。
  • --scopes $SCOPES string optional
    • OAuth スコープのセットを選択できます。スコープのセットは、空白で区切られたリストで入力する必要があります。 例えば、npx wrangler login --scopes account:read user:read。

Wrangler がブラウザを開くのに失敗した場合、ターミナルで生成された URL をコピーしてブラウザに貼り付けてログインできます。

リモートマシンで wrangler login を使用する

リモートマシンから Wrangler を使用しているが、ローカルブラウザからログインフローを実行する場合、ログイン後に次のエラーメッセージが表示されます：このサイトにアクセスできません。

ログインフローを完了するには、wrangler login を実行し、ブラウザでログインフローを進めます：

Terminal window
npx wrangler login
 ⛅️ wrangler 2.1.6
-------------------
OAuth 経由でログインを試みています...
デフォルトのブラウザでリンクを開いています: https://dash.cloudflare.com/oauth2/auth?xyz...

ブラウザのログインフローは、あなたのマシンの localhost URL にリダイレクトされます。

ログインフローをアクティブのままにします。2 番目のターミナルセッションを開きます。その 2 番目のターミナルセッションで、リモートマシン上で curl または同等のリクエストライブラリを使用してこの localhost URL を取得します。wrangler login フロー中に生成された localhost URL をコピーして貼り付け、実行します：

Terminal window
curl <LOCALHOST_URL>

logout

Wrangler のアカウントへのアクセスの認証を削除します。このコマンドは現在の OAuth トークンを無効にします。

wrangler logout

OAuth の代わりに CLOUDFLARE_API_TOKEN を使用している場合、Cloudflare ダッシュボードで API トークンを削除することでログアウトできます：

  1. Cloudflare ダッシュボード ↗にログインします。
  2. マイプロファイル > API トークンに移動します。
  3. Wrangler トークンの三点メニューを選択します。
  4. 削除を選択します。

whoami

ユーザー情報を取得し、認証設定をテストします。

wrangler whoami

versions

upload

即座にデプロイされない新しい バージョン の Worker をアップロードします。

wrangler versions upload [OPTIONS]
  • --tag string optional
    • バージョンタグを追加します。空の文字列を受け入れます。
  • --message string optional
    • バージョンメッセージを追加します。空の文字列を受け入れます。
  • --name string optional
    • wrangler.toml から継承するのではなく、特定の Worker で実行します。

deploy

以前に作成された バージョン の Worker を一度にデプロイするか、インタラクティブなプロンプトに従って新しいバージョンにトラフィックを段階的に移行する 段階的デプロイメント を作成します。

wrangler versions deploy [OPTIONS]
  • --name string optional
    • wrangler.toml から継承するのではなく、特定の Worker で実行します。

list

最新の 10 件のバージョンの詳細を取得します。詳細には Version ID、Created on、Author、Source、およびオプションで Tag または Message が含まれます。

wrangler versions list [OPTIONS]
  • --name string optional
    • wrangler.toml から継承するのではなく、特定の Worker で実行します。

secret put

Worker のためのシークレットを作成または置き換えます。デプロイせずにシークレットを変更した新しい バージョン を作成します。

wrangler versions secret put <KEY> [OPTIONS]
  • KEY string required
    • Worker でアクセスされるこのシークレットの変数名。
  • --name string optional
    • wrangler.toml から継承するのではなく、特定の Worker で実行します。
  • --env string optional
    • 特定の環境で実行します。

secret delete

Worker のためのシークレットを削除します。デプロイせずにシークレットを変更した新しい バージョン を作成します。

wrangler versions delete <KEY> [OPTIONS]
  • KEY string required
    • Worker でアクセスされるこのシークレットの変数名。
  • --name string optional
    • wrangler.toml から継承するのではなく、特定の Worker で実行します。
  • --env string optional
    • 特定の環境で実行します。

secret bulk

Worker のために複数のシークレットを一度にアップロードします。デプロイせずにシークレットを変更した新しい バージョン を作成します。

wrangler versions secret bulk <FILENAME> [OPTIONS]
  • FILENAME string optional
    • シークレットとしてアップロードするためのキーと値のペアを含む JSON ファイル、形式は {"SECRET_NAME": "secret value", ...}。
    • 省略した場合、Wrangler はファイルではなく stdin からの入力を受け取ることを期待します。
  • --name string optional
    • wrangler.toml から継承するのではなく、特定の Worker で実行します。
  • --env string optional
    • 特定の環境で実行します。

triggers

deploy

wrangler versions upload を使用しているときに、トリガー（ルートまたはドメインおよび Cron トリガー）への変更を適用します。

wrangler triggers deploy [OPTIONS]
  • --name string optional
    • wrangler.toml から継承するのではなく、特定の Worker で実行します。

deployments

デプロイメント は、トラフィックを積極的に提供している Worker のバージョンを追跡します。

list

最新の 10 件の デプロイメント の詳細を取得します。詳細には Created on、Author、Source、オプションの Message、およびデプロイメント内の Version(s) に関するメタデータが含まれます。

wrangler deployments list [OPTIONS]
  • --name string optional
    • wrangler.toml から継承するのではなく、特定の Worker で実行します。

status

最新のデプロイメントの詳細を取得します。詳細には、Created on、Author、Source、オプションのMessage、およびデプロイメント内のVersion(s)に関するメタデータが含まれます。

wrangler deployments status
  • --name string optional
    • wrangler.tomlから継承するのではなく、特定のWorkerに対して実行します。

rollback

wrangler rollback [<VERSION_ID>] [OPTIONS]
  • VERSION_ID string optional
    • ロールバックしたいバージョンのID。指定しない場合、rollbackコマンドは最新バージョンの前にアップロードされたバージョンをデフォルトとします。
  • --name string optional
    • wrangler.tomlから継承するのではなく、特定のWorkerに対して実行します。
  • --message string optional
    • ロールバックのメッセージを追加します。空の文字列を受け入れます。指定された場合、ロールバック確認とメッセージのためのインタラクティブなプロンプトはスキップされます。

dispatch namespace

list

すべてのディスパッチネームスペースをリストします。

wrangler dispatch-namespace list

get

ディスパッチネームスペースに関する情報を取得します。

wrangler dispatch-namespace get <NAME>

  • NAME string required

    • 詳細を取得するディスパッチネームスペースの名前。

create

ディスパッチネームスペースを作成します。

wrangler dispatch-namespace create <NAME>

  • NAME string required

    • 作成するディスパッチネームスペースの名前。

delete

ディスパッチネームスペースを削除します。

wrangler dispatch-namespace get <NAME>

  • NAME string required

    • 削除するディスパッチネームスペースの名前。

rename

ディスパッチネームスペースの名前を変更します。

wrangler dispatch-namespace get <OLD_NAME> <NEW_NAME>

  • OLD_NAME string required

    • ディスパッチネームスペースの以前の名前。

  • NEW_NAME string required

    • ディスパッチネームスペースの新しい名前。

mtls-certificate

mTLS接続に使用されるクライアント証明書を管理します。

これらの証明書は、クライアント認証（mTLS）を必要とするオリジンとの接続を確立する際に証明書を提示するWorkerを可能にするmtls_certificate bindingsで使用できます。

upload

クライアント証明書をアップロードします。

wrangler mtls-certificate upload --cert <PATH> --key <PATH> [OPTIONS]
  • --cert string required
    • アップロードするTLS証明書へのパス。証明書チェーンがサポートされています。
  • --key string required
    • アップロードするプライベートキーへのパス。
  • --name string optional
    • アップロード時にmTLS証明書に割り当てられる名前。

以下は、uploadコマンドを使用してmTLS証明書をアップロードする例です。

Terminal window
npx wrangler mtls-certificate upload --cert cert.pem --key key.pem --name my-origin-cert
mTLS証明書 my-origin-cert をアップロード中...
成功！ mTLS証明書 my-origin-cert をアップロードしました
ID: 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d
発行者: CN=my-secured-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
有効期限: 1/01/2025

その後、この証明書をwrangler.tomlのbindingに追加できます：

mtls_certificates = [
  { binding = "MY_CERT", certificate_id = "99f5fef1-6cc1-46b8-bd79-44a0d5082b8d" }
]

証明書とプライベートキーは、アップロード時に別々の（通常は.pem）ファイルである必要があります。

list

現在のアカウントIDに関連付けられたmTLS証明書をリストします。

wrangler mtls-certificate list

以下は、listコマンドを使用してmTLS証明書をアップロードする例です。

Terminal window
npx wrangler mtls-certificate list
ID: 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d
名前: my-origin-cert
発行者: CN=my-secured-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
作成日: 1/01/2023
有効期限: 1/01/2025


ID: c5d004d1-8312-402c-b8ed-6194328d5cbe
発行者: CN=another-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
作成日: 1/01/2023
有効期限: 1/01/2025

delete

クライアント証明書を削除します。

wrangler mtls-certificate delete {--id <ID|--name <NAME>}
  • --id string
    • mTLS証明書のID。
  • --name string
    • アップロード時にmTLS証明書に割り当てられる名前。

以下は、deleteコマンドを使用してmTLS証明書を削除する例です。

Terminal window
npx wrangler mtls-certificate delete --id 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d
証明書 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d (my-origin-cert) を削除してもよろしいですか？ [y/n]
はい
証明書 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d を削除中...
証明書 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d を正常に削除しました

types

バインディングとモジュールルールから型を生成します。

wrangler types [<PATH>] [OPTIONS]

  • PATH string (default: ./worker-configuration.d.ts)

    • WorkerのEnv型が書き込まれるパス。
    • パスはd.ts拡張子を持っている必要があります。

  • --env-interface string (default: Env)

    • 環境オブジェクトのために生成するインターフェースの名前。
    • WorkerがService Worker構文を使用している場合は無効です。

  • --experimental-include-runtime string optional (default: ./.wrangler/types/runtime.d.ts)

    • ランタイム型ファイルが書き込まれるパス。
    • デフォルトオプションを使用するには、パスを空白のままにします。例: npx wrangler types --x-include-runtime
    • カスタムパスはプロジェクトルートに対して相対的である必要があります。例: ./my-runtime-types.d.ts
    • カスタムパスはd.ts拡張子を持っている必要があります。
Cloudflare DashboardDiscordCommunityLearning CenterSupport Portal
Cookie Settings