一般コマンド

認証、テレメトリ、シェル補完向けの一般的な Wrangler コマンドです。

docs

既定のブラウザで Cloudflare の開発者向けドキュメントを開きます。

npx wrangler docs [SEARCH]

yarn wrangler docs [SEARCH]

pnpm wrangler docs [SEARCH]

• [SEARCH]string

  Enter search terms (e.g. the wrangler command) you want to know more about

• --yesboolean alias: --y

  Takes you to the docs, even if search fails

OAuth を使い、Wrangler を Cloudflare アカウントで認可します。Wrangler は、Cloudflare アカウントでのログインのため、Web ブラウザを自動で開こうとします。

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

wrangler login [OPTIONS]

• --scopes-list string 任意
  • 利用可能な OAuth スコープを、説明付きですべて一覧表示します。
• --scopes string 任意
  • 使う OAuth スコープのセットを選べます。スコープのセットは空白区切りのリストで入力します。 例: npx wrangler login --scopes account:read user:read。
• --browser boolean 任意
  • 既定は true です。OAuth リンクを既定のブラウザで自動的に開きます。開かずにリンクを表示するには --browser=false を使います。
• --callback-host string 任意
  • 既定は localhost です。Wrangler が OAuth コールバックを待ち受ける IP またはホスト名を設定します。--device と同時には使えません。
• --callback-port number 任意
  • 既定は 8976 です。Wrangler が OAuth コールバックを待ち受けるポートを設定します。--device と同時には使えません。
• --use-keyring boolean 任意
  • OAuth 認証情報を、既定の平文 TOML ファイルではなく、オペレーティングシステムのキーチェーンに保存します。詳細は OS キーチェーンへの OAuth 認証情報の保存 を参照してください。オプトアウトするには --no-use-keyring を使います。この選択は Wrangler の呼び出しをまたいで保持されます。
• --device boolean 任意
  • 既定は false です。既定の localhost コールバックフローの代わりに、OAuth 2.0 Device Authorization Grant（RFC 8628 ↗）を使います。ローカルコールバックサーバーなしで wrangler login を使う を参照してください。

次のグローバルフラグは、すべてのコマンドで使えます。

• --help boolean
  • ヘルプを表示します。
• --config string（Pages では未対応）
  • Wrangler 設定ファイル のパスです。
• --cwd string
  • 現在の作業ディレクトリではなく、指定したディレクトリで Wrangler を起動したように実行します。

Wrangler がブラウザを開けなかった場合は、wrangler login がターミナルに生成した URL をコピーしてブラウザに貼り付け、ログインできます。

リモートマシンで Wrangler を使い、ログインフローはローカルブラウザで実行する場合、ログイン後に次のエラーメッセージが表示されます。This site can't be reached。

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

npx wrangler login

 ⛅️ wrangler 2.1.6
-------------------
Attempting to login via OAuth...
Opening a link in your default browser: https://dash.cloudflare.com/oauth2/auth?xyz...

ブラウザのログインフローは、マシン上の localhost URL へリダイレクトします。

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

curl <LOCALHOST_URL>

2 つ目のターミナルセッションを使いたくない場合は、wrangler login --device を使います。この方法は localhost コールバック URL に依存しません。

Cloudflare の OAuth プロバイダーは、常に localhost:8976 のコールバックサーバーへリダイレクトします。コンテナ内で Wrangler を動かしている場合、ホストマシンのブラウザからこのサーバーへアクセスできないことがあります。接続を認可したあとも、ログインコマンドが停止したままになります。

ホストマシンのポート 8976 を、Wrangler の OAuth コールバックサーバーのポート（既定は 8976）へマッピングするよう、コンテナを設定する必要があります。

たとえば、Docker コンテナ内で Wrangler を動かす場合は次のとおりです。

docker run -p 8976:8976 <your-image>

コンテナ内で npx wrangler login を実行するときは、コールバックホストをすべてのネットワークインターフェースで待ち受けるように設定します。

npx wrangler login --callback-host=0.0.0.0

これでブラウザが localhost:8976 へリダイレクトすると、リクエストはコンテナ内の 0.0.0.0:8976 で動く Wrangler へ転送されます。

コンテナ内で別のポートを使う必要がある場合は、--callback-port も使い、ポートマッピングを合わせて変更します。例:

# When starting your container
docker run -p 8976:9000 <your-image>

# Inside the container
npx wrangler login --callback-host=0.0.0.0 --callback-port=9000

ポートをマッピングしたくない場合は、wrangler login --device を使います。この方法はコールバックサーバーを起動しません。

既定の wrangler login フローでは、ブラウザが localhost:8976 の一時的なローカルサーバーへ到達できる必要があります。一部の環境（リモート SSH セッション、ポート転送のないコンテナ、GitHub Codespaces、制限されたネットワークなど）では、そのコールバック URL にブラウザから到達できません。リモートマシンやコンテナ向けの回避策を用意するのも難しい場合があります。

そのような場合は --device を渡し、代わりに OAuth 2.0 Device Authorization Grant ↗ を使います。このフローはローカルコールバックサーバーを起動しません。代わりに Wrangler は、検証 URL と短いユーザーコードをターミナルに表示し、検証 URL を既定のブラウザで開き、承認を待つあいだ Cloudflare へアクセストークンをポーリングします。

npx wrangler login --device

 ⛅️ wrangler 4.119.0
────────────────────
Attempting to login via OAuth Device Authorization Grant...
To authorize Wrangler, please visit:

  https://dash.cloudflare.com/oauth2/device

and enter the code:

  jPqK6Qvs

You have 5 minutes to approve this request.

Opening a link in your default browser: https://dash.cloudflare.com/oauth2/device?user_code=jPqK6Qvs
Successfully logged in.

Wrangler がブラウザで開く URL には、ユーザーコードがすでに入っています。コードを確認してリクエストを承認するだけです。Wrangler は平文の検証 URL とユーザーコードも常に表示するので、スマートフォンや別のマシンで承認したり、ブラウザが開けないときにコードを手入力したりできます。

Wrangler は 5 分後、または Cloudflare がユーザーコードにより短い有効期限を設定している場合はそれより早く、ポーリングを停止します。承認前にコードが期限切れになった場合は、wrangler login --device を再実行して新しいコードを取得します。

Wrangler にブラウザを開かせず、検証 URL を自分でコピーするには --browser=false を渡します。

npx wrangler login --device --browser=false

--callback-host と --callback-port は、一時的なローカルコールバックサーバーを設定します。このフローでは使いません。Wrangler はフラグを無視せず、組み合わせをエラーとして拒否します。

npx wrangler login --device --callback-host=0.0.0.0

✘ [ERROR] `--callback-host` and `--callback-port` cannot be used with `--device`; the device authorization flow does not use a local callback server.

既定では、Wrangler は wrangler login が返す OAuth アクセストークンとリフレッシュトークンを、グローバルな Wrangler 設定ディレクトリ（通常は ~/.config/.wrangler/config/default.toml）配下の平文 TOML ファイルに保存します。より安全な保存先として OS のキーチェーンを使うには、--use-keyring を渡してオプトインします。

npx wrangler login --use-keyring

--use-keyring を有効にすると、Wrangler は認証情報を AES-256-GCM ↗ で暗号化したファイル（default.enc。従来の default.toml と同じ場所）へ書き込み、32 バイトの暗号化キーを OS のキーチェーンに保存します。

• macOS は、/usr/bin/security 経由の組み込み Keychain ↗ を使います。
• Linux は、libsecret-tools パッケージの secret-tool CLI 経由で libsecret ↗ を使います。secret-tool が使えない場合、Wrangler はディストリビューションごとのインストールヒントを表示します。
• Windows は、@napi-rs/keyring ↗ 経由で Credential Manager ↗ を使います。Wrangler はオプトインした初回に遅延インストールします（約 1.9 MB の一回限りのダウンロード）。CI などの非対話環境では、npm install -g @napi-rs/keyring@<version> でバインディングを事前インストールするか、既定の平文パスのままにしてください。

初めてオプトインしたときに平文の認証情報ファイルがある場合、Wrangler はそれを読み取り、内容を新しい .enc ファイルへ暗号化し、平文ファイルを削除します。

この選択は Wrangler の呼び出しをまたいで保持されます。認証情報の保存先を確認するには、wrangler whoami を実行します。

npx wrangler whoami

👋 You are logged in with an OAuth Token, associated with the email [email protected].
🔐 Credentials are stored in: Encrypted file (~/.config/.wrangler/config/default.enc) with key in macOS Keychain (service=wrangler, account=default)

オプトアウトするには --no-use-keyring を渡します。

npx wrangler login --no-use-keyring

オプトアウトすると、暗号化ファイルとキーチェーンエントリは 削除 されます。Wrangler は意図的に、既存の認証情報を復号してディスクへ書き戻しません。オプトアウト時に平文を書くと、いま無効にしようとしている保存時保護の意味がなくなります。続くログインフローが、新しい認証情報を平文の TOML ファイルへ書き込みます。

環境変数 CLOUDFLARE_AUTH_USE_KEYRING は、1 回の呼び出しについて永続的な設定を上書きします。

# Force the keychain backend for this command only
CLOUDFLARE_AUTH_USE_KEYRING=true npx wrangler deploy

# Force the plaintext file backend for this command only
CLOUDFLARE_AUTH_USE_KEYRING=false npx wrangler deploy

環境変数が true で、キーチェーンバックエンドが使えない場合（たとえば Linux で secret-tool がない場合）、Wrangler は平文ファイルへ黙ってフォールバックせず、エラーで終了します。永続的な設定だけがある場合、Wrangler は平文ファイルへフォールバックし、キーチェーンの不具合でロックアウトされないよう、一度だけ警告を表示します。

--use-keyring のオプトインは、API トークンの解決方法を変えません。CLOUDFLARE_API_TOKEN と CLOUDFLARE_API_KEY / CLOUDFLARE_EMAIL は、保存済みの OAuth 認証情報より優先され続けます。非対話環境では、引き続き CI/CD で Wrangler を実行する の案内が適用されます。

アカウントへアクセスするための Wrangler の認可を解除します。このコマンドは、現在の OAuth トークンを無効化し、保存済みの認証情報を削除します。キーチェーン保存 が有効な場合は、暗号化された認証情報ファイルとキーチェーンエントリの両方が削除されます。

wrangler logout

次のグローバルフラグは、すべてのコマンドで使えます。

• --help boolean
  • ヘルプを表示します。
• --config string（Pages では未対応）
  • Wrangler 設定ファイル のパスです。
• --cwd string
  • 現在の作業ディレクトリではなく、指定したディレクトリで Wrangler を起動したように実行します。

OAuth ではなく CLOUDFLARE_API_TOKEN を使っている場合は、Cloudflare ダッシュボードで API トークンを削除してログアウトできます。

1. Cloudflare ダッシュボードで、Account API tokens ページを開きます。

   Account API tokens を開く ↗

2. Wrangler トークンの三点メニューを選びます。

3. Delete を選びます。

複数アカウントでの作業向けの名前付き 認証プロファイル など、認証を管理します。

他のツールやスクリプトで使うため、現在の認証トークンまたは認証情報を取得します。

wrangler auth token [OPTIONS]

• --json boolean 任意
  • トークン種別の情報付きで、出力を JSON として返します。API キー／メールの認証情報の取得も有効になります。

コマンドは、現在設定されている認証方法を次の優先順で返します。

• 環境変数 CLOUDFLARE_API_TOKEN の API トークン
• 環境変数 CLOUDFLARE_API_KEY と CLOUDFLARE_EMAIL の API キー／メール（値が 2 つあるため --json フラグが必要です）
• wrangler login の OAuth トークン（期限切れの場合は自動更新されます）

--json を使うと、出力にトークン種別が含まれます。

// API token
{ "type": "api_token", "token": "..." }

// OAuth token
{ "type": "oauth", "token": "..." }

// API key/email (only available with --json)
{ "type": "api_key", "key": "...", "email": "..." }

認証方法が使えない場合、または --json なしで API キー／メールが設定されている場合は、エラーが返ります。

次のグローバルフラグは、すべてのコマンドで使えます。

• --help boolean
  • ヘルプを表示します。
• --config string（Pages では未対応）
  • Wrangler 設定ファイル のパスです。
• --cwd string
  • 現在の作業ディレクトリではなく、指定したディレクトリで Wrangler を起動したように実行します。

auth create

Create or re-authenticate a named auth profile

npx wrangler auth create [NAME]

yarn wrangler auth create [NAME]

pnpm wrangler auth create [NAME]

• [NAME]string required

  Name for the auth profile

• --browserboolean default: true

  Automatically open the OAuth link in a browser

• --scopesstring

  Pick the set of applicable OAuth scopes when logging in

• --callback-hoststring default: localhost

  Use the ip or host address for the temporary login callback server.

• --callback-portnumber default: 8976

  Use the port for the temporary login callback server.

auth activate

Bind a named auth profile to a directory

npx wrangler auth activate [NAME] [DIR]

yarn wrangler auth activate [NAME] [DIR]

pnpm wrangler auth activate [NAME] [DIR]

• [NAME]string required

  Name of the auth profile to activate

• [DIR]string

  Directory to bind the profile to (defaults to current directory)

auth deactivate

Remove the auth profile binding from a directory

npx wrangler auth deactivate [DIR]

yarn wrangler auth deactivate [DIR]

pnpm wrangler auth deactivate [DIR]

• [DIR]string

  Directory to unbind (defaults to current directory). Must be the exact directory the profile was bound to.

auth list

List all auth profiles

npx wrangler auth list

yarn wrangler auth list

pnpm wrangler auth list

auth delete

Delete a named auth profile

npx wrangler auth delete [NAME]

yarn wrangler auth delete [NAME]

pnpm wrangler auth delete [NAME]

• [NAME]string required

  Name of the auth profile to delete

whoami

🕵️ Retrieve your user information

npx wrangler whoami

yarn wrangler whoami

pnpm wrangler whoami

• --accountstring

  Show membership information for the given account (id or name).

• --jsonboolean default: false

  Return user information as JSON. Exits with a non-zero status if not authenticated.

Cloudflare は Wrangler の改善のため、匿名の利用データを収集します。詳細は データポリシー ↗ を参照してください。

これらのコマンドで、いつでも利用データの共有を管理できます。

Wrangler のテレメトリ収集を無効にします。

wrangler telemetry disable

Wrangler のテレメトリ収集を有効にします。

wrangler telemetry enable

テレメトリ収集が現在有効かどうかを確認します。戻り値は、コマンドを実行したディレクトリに固有です。

wrangler telemetry disable / enable で設定したグローバル状態、環境変数 WRANGLER_SEND_METRICS、および Wrangler 設定ファイル の send_metrics キーを解決します。

wrangler telemetry status

次のグローバルフラグは、すべてのコマンドで使えます。

• --help boolean
  • ヘルプを表示します。
• --config string（Pages では未対応）
  • Wrangler 設定ファイル のパスです。
• --cwd string
  • 現在の作業ディレクトリではなく、指定したディレクトリで Wrangler を起動したように実行します。

Wrangler コマンド向けのシェル補完スクリプトを生成します。シェル補完を使うと、入力中に Tab を押してコマンド、サブコマンド、フラグを自動補完できます。

wrangler complete <SHELL>

• SHELL string 必須
  • 補完を生成するシェルです。サポートする値: bash、zsh、fish、powershell。

補完スクリプトを生成し、シェルの設定ファイルへ追加します。

wrangler complete bash >> ~/.bashrc

wrangler complete zsh >> ~/.zshrc

wrangler complete fish >> ~/.config/fish/config.fish

wrangler complete powershell >> $PROFILE

セットアップ後、Tab を押すとコマンド、サブコマンド、フラグを自動補完できます。

wrangler d<TAB>          # completes to 'deploy', 'dev', 'd1', etc.
wrangler kv <TAB>        # shows subcommands: namespace, key, bulk

次のグローバルフラグは、すべてのコマンドで使えます。

• --help boolean
  • ヘルプを表示します。
• --config string（Pages では未対応）
  • Wrangler 設定ファイル のパスです。
• --cwd string
  • 現在の作業ディレクトリではなく、指定したディレクトリで Wrangler を起動したように実行します。