コマンド

注意

This page is for Wrangler v1, which has now been deprecated. Access documentation for the current version of Wrangler by visiting the Wrangler homepage. Refer to the Migration guide for instructions on how to migrate to the latest version.

wrangler ↗のためのすべてのコマンドの完全なリスト、Workers CLI。

---

generate

公開GitHubリポジトリからCloudflare Workersプロジェクトのひな形を作成します。

wrangler generate [$NAME] [$TEMPLATE] [--type=$TYPE] [--site]

デフォルト値は=valueで示されています。

• $NAME =worker オプション

  • Workersプロジェクトの名前。これはディレクトリ名と生成されたwrangler.toml configurationファイルのnameプロパティの両方です。

• $TEMPLATE =https://github.com/cloudflare/worker-template ↗ オプション

  • プロジェクト生成のために使用するテンプレートのリポジトリのGitHub URL ↗。

• --type=$TYPE =webpack オプション

  • プロジェクトのタイプ; webpack、javascript、またはrustのいずれか。

• --site オプション

  • 定義されている場合、デフォルトの$TEMPLATE値はcloudflare/workers-sdk/templates/worker-sites ↗に変更されます。これにより、Workers Siteプロジェクトが作成されます。

---

init

既存のディレクトリにスケルトンwrangler.tomlを作成します。このコマンドは、テンプレートリポジトリを自分でクローンしたい場合や、すでにJavaScriptプロジェクトがありWranglerを使用したい場合にgenerateの代わりに使用できます。

wrangler init [$NAME] [--type=$TYPE] [--site]

デフォルト値は=valueで示されています。

• $NAME =(作業ディレクトリの名前) オプション

  • Workersプロジェクトの名前。これはディレクトリ名と生成されたwrangler.toml configurationファイルのnameプロパティの両方です。

• --type=$TYPE =webpack オプション

  • プロジェクトのタイプ; webpack、javascript、またはrustのいずれか。

• --site オプション

  • 定義されている場合、デフォルトの$TEMPLATE値はcloudflare/workers-sdk/templates/worker-sites ↗に変更されます。これにより、Workers Siteプロジェクトが作成されます。

---

build

プロジェクトをビルドします（該当する場合）。このコマンドは、wrangler.tomlファイルを見て、指定された"type"値に反応します。

type = "webpack"を使用する場合、Wranglerは内部のwebpackインストールを使用してWorkerをビルドします。type = "javascript"を使用する場合、定義されている場合はbuild.commandが実行されます。

wrangler build [--env $ENVIRONMENT_NAME]

• --env オプション
  • 定義されている場合、Wranglerはビルド前に一致する環境の設定をロードします。詳細についてはEnvironmentsを参照してください。

---

login

CloudflareアカウントでWranglerを認証します。これにより、ブラウザでログインページが開き、アカウントアクセス権限が要求されます。このコマンドはwrangler configの代替であり、OAuthトークンを使用します。

wrangler login [--scopes-list] [--scopes $SCOPES]

このコマンドのすべての引数とフラグはオプションです：

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

wrangler loginは、フラグが提供されていない場合、デフォルトで利用可能なすべてのスコープを使用します。

---

logout

アカウントへのアクセスのためのWranglerの認証を削除します。このコマンドは、現在のOAuthトークンを無効にし、設定ファイルが存在する場合は削除します。

wrangler logout

このコマンドは、wrangler loginコマンドを通じて取得されたOAuthトークンのみを無効にします。ただし、認証方法に関係なく設定ファイルを削除しようとします。

APIトークンを削除したい場合は、Cloudflareダッシュボードにログインし、右側のメニューでOverview > Get your API tokenに移動し、Wranglerトークンの三点メニューを選択してDeleteを選択してください。

---

config

Wranglerを構成して、OAuthトークンの代わりにCloudflare APIトークンまたはグローバルAPIキーを取得できるようにします。

wrangler config [--api-key]

• --api-key オプション
  • トークンの代わりにメールアドレスとグローバルAPIキーを提供します。（これはセキュリティ上推奨されません。）

環境変数を使用して認証することも、wrangler loginを使用してOAuthトークンで認証することもできます。

---

publish

WorkerをCloudflareに公開します。wrangler.tomlファイル内のいくつかのキーが、*.workers.devサブドメインまたはカスタムドメインに公開しているかどうかを決定します。ただし、カスタムドメインはCloudflareを介してプロキシ（オレンジクラウド）される必要があります。詳細についてはGet started guideを参照してください。

wrangler publish [--env $ENVIRONMENT_NAME]

• --env オプション
  • 定義されている場合、Wranglerはビルドおよびデプロイ前に一致する環境の設定をロードします。詳細についてはEnvironmentsを参照してください。

このコマンドを使用するには、wrangler.tomlファイルに次のフィールドが必要です：

• name 文字列

  • Workersプロジェクトの名前。これはディレクトリ名と生成されたwrangler.toml configurationファイルのnameプロパティの両方です。

• type 文字列

  • プロジェクトのタイプ; webpack、javascript、またはrustのいずれか。

• account_id 文字列

  • CloudflareアカウントID。これはCloudflareダッシュボードで見つけることができます。例えば、account_id = "a655bacaf2b4cad0e2b51c5236a6b974"のように。

<your-worker>.<your-subdomain>.workers.dev ↗またはカスタムドメインに公開できます。

既存のWorkerスクリプトに変更を公開すると、すべての新しいリクエストはダウンタイムなしで更新されたWorkerのバージョンに自動的にルーティングされます。進行中のリクエストは、完了するまで前のバージョンで実行され続けます。すべての進行中のリクエストが完了すると、前のWorkerバージョンはパージされ、リクエストを処理しなくなります。

workers.devへの公開

*.workers.dev ↗に公開するには、最初にサブドメインを登録する必要があります。サブドメインは、wrangler subdomainコマンドを実行することで登録できます。

サブドメインを登録したら、wrangler.tomlファイルにworkers_devを追加します。

• workers_dev bool
  • trueの場合、Workerは*.workers.devドメインにデプロイされるべきであることを示します。

自分のドメインへの公開

自分のドメインに公開するには、wrangler.tomlファイルに次の3つのフィールドを指定します。

• zone_id 文字列

  • CloudflareゾーンID。例えば、zone_id = "b6558acaf2b4cad1f2b51c5236a6b972"のように、これはCloudflareダッシュボード ↗で見つけることができます。

• route 文字列

  • 公開したいルート。例えば、route = "example.com/my-worker/*"のように。

• routes 配列

  • 公開したいルート。例えば、routes = ["example.com/foo/*", example.com/bar/*]のように。

ノート

routeまたはroutesのいずれか一方のみを使用してください。両方を使用しないでください。

複数のドメインへの同じコードの公開

複数のドメインにコードを公開するには、environmentsのドキュメントを参照してください。

---

dev

wrangler devは、localhostとグローバルネットワークサーバーとの接続を確立し、開発中のWorkerを操作します。cloudflaredトンネルは、すべてのリクエストをグローバルネットワークサーバーに転送し、Workerコードが変更されるたびに継続的に更新されます。これにより、Workers KV、Durable Objects、および他のCloudflare開発者プラットフォーム製品への完全なアクセスが可能になります。devコマンドは、開発中にWorkerをテストする方法です。

wrangler dev [--env $ENVIRONMENT_NAME] [--ip <ip>] [--port <port>] [--host <host>] [--local-protocol <http|https>] [--upstream-protocol <http|https>]

• --env オプション

  • 定義されている場合、Wranglerは一致する環境の設定をロードします。詳細についてはEnvironmentsを参照してください。

• --ip オプション

  • リッスンするIP、デフォルトは127.0.0.1です。

• --port オプション

  • リッスンするポート、デフォルトは8787です。

• --host オプション

  • リクエストを転送するホスト、デフォルトはプロジェクトのゾーンまたは未認証の場合はtutorial.cloudflareworkers.comです。

• --local-protocol オプション

  • リクエストをリッスンするプロトコル、デフォルトはhttpです。

• --upstream-protocol オプション

  • ホストにリクエストを転送するプロトコル、デフォルトはhttpsです。

これらの引数は、wrangler.tomlファイルにも設定できます。詳細についてはwrangler devの設定ドキュメントを参照してください。

使用法

wrangler devは、Workerディレクトリから実行する必要があります。Wranglerはリクエストを受け入れ、Workerを実行し、ホストに転送するローカルサーバーを実行します。ゾーンやtutorials.cloudflare.com以外のホストを使用したい場合は、--host example.comで指定できます。

wrangler dev

💁  JavaScriptプロジェクトが見つかりました。不要なビルドをスキップします！
💁  "./"を監視中
👂  http://127.0.0.1:8787でリッスン中

wrangler devが実行されている状態で、HTTPリクエストをlocalhost:8787に送信すると、Workerは期待通りに実行されるはずです。また、console.logメッセージや例外がターミナルに表示されます。これらのいずれかが発生しない場合や、出力が正しくないと思われる場合は、問題を報告してください ↗。

---

tail

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

wrangler tail [--format $FORMAT] [--status $STATUS] [OPTIONS]

• --format $FORMAT json|pretty
  • ログエントリのフォーマット。
• --status $STATUS
  • 呼び出しステータスでフィルタリング [可能な値: ok, error, canceled].
• --header $HEADER
  • HTTPヘッダーでフィルタリング。
• --method $METHOD
  • HTTPメソッドでフィルタリング。
• --sampling-rate $RATE
  • ログサンプリング率に追加するリクエストのパーセンテージ。
• --search $SEARCH
  • console.logメッセージ内のテキストマッチでフィルタリング。

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

すべてのWranglerコマンドと同様に、wrangler tailはWorkerのルートディレクトリ（wrangler.tomlファイルのあるディレクトリ）から実行します。

既存のcloudflared設定に関するレガシーの問題

wrangler tailのバージョン1.19.0未満はcloudflaredを使用して実行されます。問題を避けるために、最新のWranglerバージョンに更新してください。

---

preview

Cloudflare Workersプレビューサービス ↗を使用してプロジェクトをプレビューします。

wrangler preview [--watch] [--env $ENVIRONMENT_NAME] [ --url $URL] [$METHOD] [$BODY]

デフォルト値は=valueで示されています。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、Wranglerは一致する環境の設定をロードします。詳細についてはEnvironmentsを参照してください。

• --watch 推奨

  • 有効にすると、Workerプロジェクトへの変更があるたびに、最新のバージョンでプレビューサービスが継続的に更新されます。デフォルトでは、wrangler previewはプロジェクトを一度だけバンドルします。

• $METHOD =“GET” オプション

  • Workerをプレビューするためのリクエストのタイプ（GET、POST）。

• $BODY =“Null” オプション

  • プレビューWorkerリクエストに投稿するボディ文字列。例えば、wrangler preview post hello=helloのように。

kv_namespaces

wrangler previewでkv_namespacesを使用している場合、セッションを開始する前にwrangler.tomlファイルにpreview_idを指定する必要があります。これは、開発中に本番ネームスペースに変更を書き込まないようにするためです。preview_idをidに等しくすることで、本番ネームスペースでプレビューすることもできますが、本番Workerを壊す値を書き込まないように注意してください。

preview_idを作成するには、次のコマンドを実行します：

wrangler kv:namespace create --preview "NAMESPACE"

Windows Subsystem for Linux (WSL 1/2)でのプレビュー

$BROWSERをブラウザバイナリに設定する

WSLはLinux環境であるため、Wranglerはブラウザを開くためにxdg-openを呼び出そうとします。wrangler previewをWSLで動作させるには、$BROWSERをブラウザバイナリのパスに設定する必要があります：

export BROWSER="/mnt/c/tools/firefox.exe"
wrangler preview

Linuxではファイルパスにスペースが含まれることは一般的ではなく、一部のプログラム（xdg-openなど）はスペースを含むパス ↗で壊れることがあります。この問題を回避するには、バイナリを/usr/local/binにリンクすることができます：

ln -s "/mnt/c/Program Files/Mozilla Firefox/firefox.exe" firefox
export BROWSER=firefox

$BROWSERをwsl-openに設定する

別のオプションは、wsl-open ↗をインストールし、wsl-open -wを介して$BROWSER環境変数をwsl-openに設定することです。これにより、xdg-openがブラウザを開こうとする際にwsl-openを使用することが保証されます。

WSL 2を使用している場合は、npmを通じてではなく、彼らのスタンドアロンメソッド ↗に従ってwsl-openをインストールする必要があります。これは、彼らのnpmパッケージがまだWSL 2のサポートで更新されていないためです。

---

route

ドメインに関連付けられたルートをリストまたは削除します：

wrangler route list [--env $ENVIRONMENT_NAME]

デフォルト値は=valueで示されています。

• --env $ENVIRONMENT_NAME オプション
  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

このコマンドは、List Routes APIからのJSONレスポンスを転送します。JSONリスト内の各オブジェクトには、ルートID、ルートパターン、およびルートに割り当てられたWorker名が含まれます。これをjqなどのツールを通してパイプすることで、出力がきれいに表示されます。

wrangler route delete $ID [--env $ENVIRONMENT_NAME]

デフォルト値は=valueで示されています。

• $ID 必須

  • 削除するルートIDのハッシュ。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

---

subdomain

あなたの*.workers.dev ↗サブドメインを作成または変更します。

wrangler subdomain <name>

---

secret

あなたのシークレットと対話します。

put

シークレットを作成または置き換えます。

wrangler secret put <name> --env ENVIRONMENT_NAME
Enter the secret text you would like assigned to the variable name on the Worker named my-worker-ENVIRONMENT_NAME:

シークレットの値を入力するように求められます。このコマンドはパイプ入力を受け取ることができるため、次の例も可能です：

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

• name

  • スクリプト内でアクセス可能な変数名。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

delete

特定のスクリプトからシークレットを削除します。

wrangler secret delete <name> --env ENVIRONMENT_NAME

• name

  • スクリプト内でアクセス可能な変数名。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

list

特定のスクリプトにバインドされたすべてのシークレット名をリストします。

wrangler secret list --env ENVIRONMENT_NAME

• --env $ENVIRONMENT_NAME オプション
  • 定義されている場合、指定された環境のシークレットのみがリストされます。詳細についてはEnvironmentsを参照してください。

---

kv

kvサブコマンドを使用すると、Cloudflareネットワークにアプリケーションデータを保存し、Workers KV ↗を使用してWorkersからアクセスできます。KV操作はあなたのアカウントにスコープされているため、これらのコマンドを使用するには：

• プロジェクトのwrangler.tomlファイルにaccount_idを設定する必要があります。
• プロジェクトのルートディレクトリからターミナルですべてのwrangler kv:<command>操作を実行する必要があります。

Getting started

Workers KVをWorkerで使用するには、最初にKV名前空間を作成する必要があります。これはkv:namespaceサブコマンドを使用して行います。

kv:namespaceサブコマンドは、新しいバインディング名を引数として取ります。Workers KV名前空間は、あなたのWorkerの名前（wrangler.tomlファイルから）と提供したバインディング名の連結を使用して作成されます：

wrangler kv:namespace create "MY_KV"

🌀  Creating namespace with title "my-site-MY_KV"
✨  Success!
Add the following to your configuration file:
kv_namespaces = [
  { binding = "MY_KV", id = "e29b263ab50e42ce9b637fa8370175e8" }
]

成功した操作は、新しい設定ブロックを印刷し、これをwrangler.tomlファイルにコピーする必要があります。出力を既存のkv_namespaces設定に追加します。これで、Worker内からバインディングにアクセスできるようになります：

let value = await MY_KV.get("my-key");

Wranglerを使用してKV名前空間に値を書き込むには、wrangler kv:key putサブコマンドを実行します。

wrangler kv:key put --binding=MY_KV "key" "value"

✨  Success

--bindingの代わりに--namespace-idを使用して、どのKV名前空間が操作を受け取るかを指定できます：

wrangler kv:key put --namespace-id=e29b263ab50e42ce9b637fa8370175e8 "key" "value"

✨  Success

さらに、KV名前空間は環境とともに使用できます。これは、MY_KVのようなKVバインディングを参照するコードがあり、これらのバインディングが異なる名前空間（ステージング用と本番用など）を指すことができるようにするのに便利です。

2つの環境を持つwrangler.tomlファイル：

[env.staging]
kv_namespaces = [
  { binding = "MY_KV", id = "e29b263ab50e42ce9b637fa8370175e8" }
]

[env.production]
kv_namespaces = [
  { binding = "MY_KV", id = "a825455ce00f4f7282403da85269f8ea" }
]

特定のKV名前空間に値を挿入するには、次のように使用できます：

wrangler kv:key put --env=staging --binding=MY_MV "key" "value"

✨  Success

--namespace-idは常にユニークであるため（バインディング名とは異なり）、--env引数を指定する必要はありません。

Concepts

ほとんどのkvコマンドでは、名前空間を指定する必要があります。名前空間は2つの方法で指定できます：

1. --bindingを使用：

   wrangler kv:key get --binding=MY_KV "my key"

   • これは、--previewフラグと組み合わせて、プロダクション名前空間ではなくプレビュー名前空間と対話することができます。

2. --namespace-idを使用：

   wrangler kv:key get --namespace-id=06779da6940b431db6e566b4846d64db "my key"

ほとんどのkvサブコマンドでは、オプションの--envフラグを指定することもできます。これにより、異なる名前空間を持つ同じコードを実行するWorkersを公開できます。たとえば、wrangler.tomlファイル内のKVデータに対して、ステージングと本番の名前空間を別々に使用できます：

type = "webpack"
name = "my-worker"
account_id = "<account id here>"
route = "staging.example.com/*"
workers_dev = false

kv_namespaces = [
  { binding = "MY_KV", id = "06779da6940b431db6e566b4846d64db" }
]

[env.production]
route = "example.com/*"
kv_namespaces = [
  { binding = "MY_KV", id = "07bc1f3d1f2a4fd8a45a7e026e2681c6" }
]

上記のwrangler.tomlファイルを使用すると、--env productionを指定して、env.productionの下の名前空間MY_KVに対してKVアクションを実行できます。たとえば、上記のwrangler.tomlファイルを使用して、次のように本番KVインスタンスから値を取得できます：

wrangler kv:key get --binding "MY_KV" --env=production "my key"

環境について詳しくは、Environmentsを参照してください。

kv:namespace

create

新しい名前空間を作成します。

wrangler kv:namespace create $NAME [--env=$ENVIRONMENT_NAME] [--preview]

• $NAME

  • 新しい名前空間の名前。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

• --preview オプション

  • プロダクションではなくプレビュー名前空間（preview_id値）と対話します。

Usage

wrangler kv:namespace create "MY_KV"
🌀  Creating namespace with title "worker-MY_KV"
✨  Add the following to your wrangler.toml:
kv_namespaces = [
  { binding = "MY_KV", id = "e29b263ab50e42ce9b637fa8370175e8" }
]

wrangler kv:namespace create "MY_KV" --preview
🌀  Creating namespace with title "my-site-MY_KV_preview"
✨  Success!
Add the following to your wrangler.toml:
kv_namespaces = [
  { binding = "MY_KV", preview_id = "15137f8edf6c09742227e99b08aaf273" }
]

list

アカウントIDに関連付けられたすべてのKV名前空間をリストします。

wrangler kv:namespace list

Usage

この例では、Wranglerコマンドをjqコマンドを通して渡します：

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

delete

指定された名前空間を削除します。

wrangler kv:namespace delete --binding= [--namespace-id=]

• --binding 必須（—namespace-idがない場合）

  • 削除する名前空間の名前。

• --namespace-id 必須（—bindingがない場合）

  • 削除する名前空間のID。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

• --preview オプション

  • プロダクションではなくプレビュー名前空間と対話します。

Usage

wrangler kv:namespace delete --binding=MY_KV
Are you sure you want to delete namespace f7b02e7fc70443149ac906dd81ec1791? [y/n]
yes
🌀  Deleting namespace f7b02e7fc70443149ac906dd81ec1791
✨  Success

wrangler kv:namespace delete --binding=MY_KV --preview
Are you sure you want to delete namespace 15137f8edf6c09742227e99b08aaf273? [y/n]
yes
🌀  Deleting namespace 15137f8edf6c09742227e99b08aaf273
✨  Success

kv:key

put

特定の名前空間に単一のキー-バリュー対を書き込みます。

wrangler kv:key put --binding= [--namespace-id=] $KEY $VALUE
✨  Success

• $KEY 必須

  • 書き込むキー。

• $VALUE 必須

  • 書き込む値。

• --binding 必須（—namespace-idがない場合）

  • 書き込む名前空間の名前。

• --namespace-id 必須（—bindingがない場合）

  • 書き込む名前空間のID。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

• --preview オプション

  • プロダクションではなくプレビュー名前空間と対話します。これをwrangler.tomlファイルのkv_namespaces.preview_idに渡します。

• --ttl オプション

  • ドキュメントが期限切れになる前に存在するべき期間（秒数）。少なくとも60秒でなければなりません。このオプションはexpirationオプションよりも優先されます。

• --expiration オプション

  • キー-バリュー対が期限切れになるべき時刻を示すUNIX秒のタイムスタンプ。

• --path オプション

  • 定義されている場合、Wranglerは--pathファイルの場所を読み取り、その内容をKVドキュメントとしてアップロードします。これは、キーと値をターミナルの履歴に保存しないため、セキュリティに敏感な操作に最適です。

Usage

wrangler kv:key put --binding=MY_KV "key" "value"
✨  Success

wrangler kv:key put --binding=MY_KV --preview "key" "value"
✨  Success

wrangler kv:key put --binding=MY_KV "key" "value" --ttl=10000
✨  Success

wrangler kv:key put --binding=MY_KV "key" value.txt --path
✨  Success

list

特定の名前空間内のすべてのキーのリストを出力します。

wrangler kv:key list --binding= [--namespace-id=] [--prefix] [--env]

• --binding 必須（—namespace-idがない場合）

  • リストする名前空間の名前。

• --namespace-id 必須（—bindingがない場合）

  • リストする名前空間のID。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

• --prefix オプション

  • リストされたキーをフィルタリングするためのプレフィックス。

Usage

この例では、Wranglerコマンドをjqコマンドを通して渡します：

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

指定された名前空間からキーによって単一の値を読み取ります。

wrangler kv:key get --binding= [--env=] [--preview] [--namespace-id=] "$KEY"

• $KEY 必須

  • 取得するキーの値。

• --binding 必須（—namespace-idがない場合）

  • 取得する名前空間の名前。

• --namespace-id 必須（—bindingがない場合）

  • 取得する名前空間のID。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、操作は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

• --preview オプション

  • プロダクションではなくプレビュー名前空間と対話します。これを使用して、wrangler.tomlファイルのkv_namespaces.preview_idをkv_namespaces.idの代わりに使用します。

Usage

wrangler kv:key get --binding=MY_KV "key"
value

delete

指定された名前空間から単一のキー値ペアを削除します。

wrangler kv:key delete --binding= [--env=] [--preview] [--namespace-id=] "$KEY"

• $KEY 必須

  • 削除するキーの値。

• --binding 必須（—namespace-idがない場合）

  • 削除する名前空間の名前。

• --namespace-id 必須（—bindingがない場合）

  • 削除する名前空間のID。

• --env オプション

  • 指定された環境$ENVIRONMENT_NAMEで実行します。

• --preview オプション

  • プロダクションではなくプレビュー名前空間と対話します。これを使用して、wrangler.tomlのkv_namespaces.preview_idをkv_namespaces.idの代わりに使用します。

使用法

wrangler kv:key delete --binding=MY_KV "key"
本当にキー "key" を削除してもよろしいですか？ [y/n]
はい
🌀  キー "key" を削除中
✨  成功

kv:bulk

put

指定された名前空間にキーと値のペアのファイルを書き込みます。

wrangler kv:bulk put --binding= [--env=] [--preview] [--namespace-id=] $FILENAME

• $FILENAME 必須

  • 名前空間に書き込むファイル

• --binding 必須（—namespace-idがない場合）

  • 書き込む名前空間の名前。

• --namespace-id 必須（—bindingがない場合）

  • 書き込む名前空間のID。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

• --preview オプション

  • 本番環境ではなくプレビュー名前空間と対話します。これを使用して、wrangler.tomlファイルのkv_namespaces.preview_idをkv_namespaces.idの代わりに使用します。

このコマンドは、アップロードするキーと値のペアのリストを含むJSONファイルを引数として受け取ります。JSON入力の例：

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

JSONデータを保存するためには、valueを文字列にキャストします：

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

以下のスキーマは、バルクAPIを介してアップロードされたキーと値のエントリの完全なスキーマです：

• key 文字列 必須

  • キーの名前。名前は最大512バイトです。すべての印刷可能な非空白文字が有効です。

• value 文字列 必須

  • 保存されるUTF-8エンコードされた文字列で、最大25MBの長さです。

• expiration 整数 オプション

  • キーが期限切れになるUNIXエポックからの秒数で測定された時間。

• expiration_ttl 整数 オプション

  • ドキュメントが期限切れになる前に存在する必要がある秒数。少なくとも60秒でなければなりません。

• base64 ブール オプション

  • trueの場合、サーバーは値を保存する前にbase64としてデコードします。これは、画像など、無効なJSON文字列となる値を書くのに便利です。デフォルトはfalseです。

指定されたキーに対してexpirationとexpiration_ttlの両方が指定されている場合、APIはexpiration_ttlを優先します。

使用法

wrangler kv:bulk put --binding=MY_KV allthethingsupload.json
🌀  1つのキーと値のペアをアップロード中
✨  成功

delete

指定された名前空間内のすべてのキーを削除します。

wrangler kv:bulk delete --binding= [--env=] [--preview] [--namespace-id=] $FILENAME

• $FILENAME 必須

  • 削除するキーと値のペアを含むファイル。

• --binding 必須（—namespace-idがない場合）

  • 削除する名前空間の名前。

• --namespace-id 必須（—bindingがない場合）

  • 削除する名前空間のID。

• --env $ENVIRONMENT_NAME オプション

  • 定義されている場合、変更は指定された環境にのみ適用されます。詳細についてはEnvironmentsを参照してください。

• --preview オプション

  • 本番環境ではなくプレビュー名前空間と対話します。これを使用して、wrangler.tomlファイルのkv_namespaces.preview_idをkv_namespaces.idの代わりに使用します。

このコマンドは、削除するキーと値のペアのリストを含むJSONファイルを引数として受け取ります。JSON入力の例：

[
  {
    "key": "test_key",
    "value": ""
  }
]

• key 文字列 必須

  • キーの名前。名前は最大512バイトです。すべての印刷可能な非空白文字が有効です。

• value 文字列 必須

  • このフィールドはデシリアライズの目的で指定する必要がありますが、提供されたキーが削除されるため、使用されません。

使用法

wrangler kv:bulk delete --binding=MY_KV allthethingsdelete.json

本当にallthethingsdelete.json内のすべてのキーを削除してもよろしいですか？ [y/n]
はい
🌀  1つのキーと値のペアを削除中
✨  成功

---

環境変数

Wranglerは、環境変数として渡された任意のwrangler.tomlキーをサポートしています。これは、CF_ + すべての大文字のTOMLキーを渡すことによって機能します。例えば：

CF_NAME=my-worker CF_ACCOUNT_ID=1234 wrangler dev

---

—help

wrangler --help

👷 ✨  wrangler 1.12.3
Wranglerチーム <wrangler@cloudflare.com>

使用法：
    wrangler [サブコマンド]

フラグ：
    -h, --help       ヘルプ情報を表示します
    -V, --version    バージョン情報を表示します

サブコマンド：
    kv:namespace    🗂️  Workers KV Namespacesと対話します
    kv:key          🔑  Workers KVキーと値のペアを個別に管理します
    kv:bulk         💪  複数のWorkers KVキーと値のペアと一度に対話します
    route           ➡️  ワーカーのルートをリストまたは削除します。
    secret          🤫  ワーカーのスクリプトで参照できる秘密を生成します
    generate        👯  新しいワーカープロジェクトを生成します
    init            📥  既存のプロジェクトのためにwrangler.tomlを作成します
    build           🦀  ワーカーをビルドします
    preview         🔬  cloudflareworkers.comでコードを一時的にプレビューします
    dev             👂  ワーカーの開発のためにローカルサーバーを開始します
    publish         🆙  ワーカーをオレンジのクラウドに公開します
    config          🕵️  Cloudflare APIトークンまたはグローバルAPIキーでWranglerを認証します
    subdomain       👷  workers.devサブドメインを構成します
    whoami          🕵️  ユーザー情報を取得し、認証設定をテストします
    tail            🦚  本番ワーカーからのログを集約します
    login           🔓  Cloudflareのユーザー名とパスワードでWranglerを認証します
    logout          ⚙️  Wranglerからの認証を削除します。
    help            このメッセージまたは指定されたサブコマンドのヘルプを表示します