← Cloudflare Workers / workers / wrangler / commands

Obecné příkazy

Obecné příkazy Wrangler pro autentizaci, telemetrii a doplňování příkazů v shellu.

docs

Otevřete vývojářskou dokumentaci Cloudflare ve výchozím prohlížeči.

npx wrangler docs [SEARCH]

• [SEARCH]string

  Zadejte hledaný výraz (například příkaz wrangler), o kterém chcete zjistit více

• --yesboolean alias: --y

  Přesměruje vás do dokumentace, i když vyhledávání selže

Autorizujte Wrangler ke svému účtu Cloudflare pomocí OAuth. Wrangler se pokusí automaticky otevřít webový prohlížeč, abyste se mohli přihlásit ke svému účtu Cloudflare.

Pokud pro ověřování dáváte přednost API tokenům, například v headless prostředích nebo prostředích průběžné integrace, přečtěte si Spouštění Wrangler v CI/CD.

wrangler login [OPTIONS]

• --scopes-list string volitelné
  • Vypsat všechny dostupné rozsahy OAuth s popisy.
• --scopes string volitelné
  • Umožňuje vybrat sadu rozsahů OAuth. Sada rozsahů musí být zadána jako seznam oddělený mezerami, například, npx wrangler login --scopes account:read user:read.
• --browser boolean volitelné
  • Výchozí hodnota je true. Automaticky otevře odkaz OAuth ve výchozím prohlížeči. Použijte --browser=false pro vypsání odkazu místo jeho otevření.
• --callback-host string volitelné
  • Výchozí hodnota je localhost. Nastaví IP adresu nebo název hostitele, na kterém má Wrangler naslouchat OAuth callbacku. Nelze kombinovat s --device.
• --callback-port number volitelné
  • Výchozí hodnota je 8976. Nastaví port, na kterém má Wrangler naslouchat OAuth callbacku. Nelze kombinovat s --device.
• --use-keyring boolean volitelné
  • Ukládá přihlašovací údaje OAuth do klíčenky operačního systému místo do výchozího prostého souboru TOML. Další informace v Ukládání přihlašovacích údajů OAuth do klíčenky OS pro podrobnosti. Použijte --no-use-keyring abyste se znovu odhlásili. Volba se zachovává napříč jednotlivými spuštěními Wrangleru.
• --device boolean volitelné
  • Výchozí hodnota je false. Používá OAuth 2.0 Device Authorization Grant (RFC 8628 ↗) místo výchozího localhost postup s callbackem. Přečtěte si Použijte wrangler login bez místního callback serveru.

Následující globální příznaky fungují u každého příkazu:

• --help boolean
  • Zobrazí nápovědu.
• --config string (Pages toto nepodporují)
  • Cesta k vašemu Konfigurační soubor Wrangler.
• --cwd string
  • Spustit, jako by byl Wrangler spuštěn v zadaném adresáři místo aktuálního pracovního adresáře.

Pokud se Wrangleru nepodaří otevřít prohlížeč, můžete zkopírovat a vložit adresu URL vygenerovanou wrangler login ve vašem terminálu do prohlížeče a přihlaste se.

Pokud používáte Wrangler ze vzdáleného počítače, ale přihlašovací proces spouštíte v místním prohlížeči, po přihlášení se zobrazí následující chybová zpráva:This site can't be reached.

Chcete-li dokončit přihlašovací postup, spusťte wrangler login a projděte přihlašovacím procesem v prohlížeči:

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...

Přihlašovací proces v prohlížeči vás přesměruje na localhost URL na vašem počítači.

Ponechte přihlašovací postup aktivní. Otevřete druhou relaci terminálu. V této druhé relaci terminálu použijte curl nebo ekvivalentní knihovnu pro HTTP požadavky na vzdáleném počítači a stáhnout tento localhost URL. Zkopírujte a vložte localhost URL, která byla vygenerována během wrangler login tok a spusťte:

curl <LOCALHOST_URL>

Chcete-li se této druhé relaci terminálu úplně vyhnout, použijte wrangler login --device, který nezávisí na localhost callback URL.

Poskytovatel OAuth Cloudflare vždy přesměruje na server zpětného volání na adrese localhost:8976. Pokud spouštíte Wrangler uvnitř kontejneru, tento server nemusí být dostupný z prohlížeče na vašem hostitelském počítači: i po autorizaci připojení zůstane příkaz pro přihlášení viset.

Kontejner musíte nakonfigurovat tak, aby mapoval port 8976 na hostitelském počítači na port serveru OAuth callback Wrangleru (8976 ve výchozím nastavení).

Pokud například spouštíte Wrangler v kontejneru Docker:

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

A když spustíte npx wrangler login uvnitř vašeho kontejneru nastavte callback host tak, aby naslouchal na všech síťových rozhraních:

npx wrangler login --callback-host=0.0.0.0

Nyní, když prohlížeč přesměruje na localhost:8976, požadavek se přesměruje na Wrangler běžící uvnitř kontejneru na 0.0.0.0:8976.

Pokud uvnitř kontejneru potřebujete použít jiný port, použijte --callback-port a odpovídajícím způsobem upravte mapování portů, například:

# 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

Pokud porty raději vůbec nechcete mapovat, použijte wrangler login --device, který nespouští callback server.

Výchozí wrangler login tok vyžaduje, aby se váš prohlížeč dokázal připojit k dočasnému místnímu serveru na localhost:8976. V některých prostředích, například u vzdálených SSH relací, kontejnerů bez přesměrovaných portů, GitHub Codespaces nebo jinak omezených sítí, není tato callback URL z prohlížeče dosažitelná a nastavení příslušných obchozích řešení pro vzdálené počítače a kontejnery může být obtížné.

V takových případech předejte --device pro použití OAuth 2.0 Device Authorization Grant ↗ místo toho. Tento postup nespouští lokální callback server. Wrangler místo toho vypíše do terminálu ověřovací URL a krátký uživatelský kód, otevře ověřovací URL ve výchozím prohlížeči a dotazuje Cloudflare na přístupový token, zatímco žádost schvalujete.

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:

  WDJB-MJHT

You have 5 minutes to approve this request.

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

URL adresa, kterou Wrangler otevře ve vašem prohlížeči, už má vyplněný uživatelský kód, takže stačí kód potvrdit a schválit požadavek. Wrangler vždy vypíše i čistou ověřovací URL adresu a uživatelský kód, takže požadavek můžete schválit na telefonu nebo jiném zařízení, případně kód zadat ručně, pokud se prohlížeč nedá otevřít.

Wrangler ukončí dotazování po 5 minutách, nebo dříve, pokud Cloudflare nastaví kratší platnost uživatelského kódu. Pokud kód vyprší dřív, než ho schválíte, spusťte wrangler login --device znovu a získejte nový.

Předejte --browser=false zabráníte tomu, aby Wrangler za vás otevřel prohlížeč, a URL adresu pro ověření zkopírujete sami:

npx wrangler login --device --browser=false

--callback-host a --callback-port konfigurují dočasný lokální callback server, který tento postup nepoužívá. Wrangler tuto kombinaci odmítne chybou, místo aby příznaky ignoroval:

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.

Ve výchozím nastavení Wrangler ukládá přístupový token OAuth a refresh token, které vrací wrangler login v prostém textovém souboru TOML v globálním konfiguračním adresáři Wrangler (obvykle ~/.config/.wrangler/config/default.toml). Předejte --use-keyring abyste přešli na bezpečnější způsob ukládání, který využívá klíčenku vašeho operačního systému:

npx wrangler login --use-keyring

Když --use-keyring je povoleno, Wrangler zapíše přihlašovací údaje do AES-256-GCM ↗-šifrovaný soubor (default.enc, vedle staršího default.toml umístění) a uloží 32bajtový šifrovací klíč do klíčenky vašeho operačního systému:

• macOS používá vestavěný Keychain ↗ prostřednictvím /usr/bin/security.
• Linux používá libsecret ↗ prostřednictvím secret-tool CLI z libsecret-tools balíček. Wrangler vypíše instalační nápovědu pro danou distribuci, pokud secret-tool není k dispozici.
• Windows používá Credential Manager ↗ prostřednictvím @napi-rs/keyring ↗, který Wrangler nainstaluje líně při první aktivaci (jednorázové stažení přibližně 1,9 MB). V neinteraktivních prostředích, jako je CI, nainstalujte binding předem pomocí npm install -g @napi-rs/keyring@<version> nebo zůstat na výchozí nešifrované cestě.

Pokud při prvním zapnutí této funkce existuje soubor s přihlašovacími údaji v čistém textu, Wrangler jej načte, zašifruje jeho obsah a uloží do nového .enc soubor a smaže soubor v čistém textu.

Volba se uchovává napříč jednotlivými spuštěními Wrangler. Chcete-li ověřit, kde jsou přihlašovací údaje aktuálně uloženy, spusťte 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)

Chcete-li se z toho opět odhlásit, předejte --no-use-keyring:

npx wrangler login --no-use-keyring

Odhlášení mazání zašifrovaný soubor a záznam v klíčence. Wrangler záměrně nedešifruje stávající přihlašovací údaje na disk: zápis v čitelné podobě během deaktivace by popřel ochranu dat v klidu, kterou jste se právě rozhodli vypnout. Následný proces přihlášení zapíše nové přihlašovací údaje do nešifrovaného souboru TOML.

Proměnná prostředí CLOUDFLARE_AUTH_USE_KEYRING přepisuje trvalé nastavení pro jedno volání:

# 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

Když je proměnná prostředí nastavena na true a backend klíčenky (keychain) není dostupný (například secret-tool na Linuxu chybí), Wrangler skončí s chybou místo tichého přechodu na soubor s prostým textem. Pokud je nastavena pouze trvalá preference, Wrangler přejde na soubor s prostým textem a jednorázově vypíše upozornění, aby vás nefunkční klíčenka nikdy nevyřadila z provozu.

--use-keyring opt-in nemění způsob, jakým se určují API tokeny: CLOUDFLARE_API_TOKEN a CLOUDFLARE_API_KEY/CLOUDFLARE_EMAIL mají nadále přednost před uloženými přihlašovacími údaji OAuth a Spouštění Wrangler v CI/CD pokyny stále platí pro neinteraktivní prostředí.

Odebere autorizaci nástroje Wrangler k přístupu k vašemu účtu. Tento příkaz zneplatní váš aktuální token OAuth a smaže uložené přihlašovací údaje. Když úložiště Keychain je aktivní, odstraní se jak zašifrovaný soubor s přihlašovacími údaji, tak záznam ve svazku klíčů (keychain).

wrangler logout

Následující globální příznaky fungují u každého příkazu:

• --help boolean
  • Zobrazí nápovědu.
• --config string (Pages toto nepodporují)
  • Cesta k vašemu Konfigurační soubor Wrangler.
• --cwd string
  • Spustit, jako by byl Wrangler spuštěn v zadaném adresáři místo aktuálního pracovního adresáře.

Pokud používáte CLOUDFLARE_API_TOKEN místo OAuth a odhlásit se můžete smazáním API tokenu v Cloudflare dashboardu:

1. V dashboardu Cloudflare přejděte na API tokeny účtu stránce.

   Přejděte na API tokeny účtu ↗

2. Klikněte na nabídku tří teček u vašeho tokenu Wrangler.

3. Vyberte Smazat.

Správa ověřování, včetně pojmenovaných autentizační profily pro práci napříč více účty.

Načtěte svůj aktuální ověřovací token nebo přihlašovací údaje pro použití v jiných nástrojích a skriptech.

wrangler auth token [OPTIONS]

• --json boolean volitelné
  • Vrátí výstup jako JSON s informacemi o typu tokenu. Tím se také zpřístupní načtení přihlašovacích údajů API klíče nebo e-mailu.

Příkaz vrátí aktuálně nakonfigurovanou metodu ověření, a to v tomto pořadí priority:

• API token z CLOUDFLARE_API_TOKEN proměnná prostředí
• API klíč/e-mail z CLOUDFLARE_API_KEY a CLOUDFLARE_EMAIL proměnné prostředí (vyžaduje --json příznak, protože tato metoda používá dvě hodnoty místo jednoho tokenu)
• Token OAuth z wrangler login (automaticky obnoveno po vypršení platnosti)

Při použití --json, výstup obsahuje typ tokenu:

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

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

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

Chyba je vrácena, pokud není k dispozici žádná metoda ověření, nebo pokud je API key/email nakonfigurován bez --json.

Následující globální příznaky fungují u každého příkazu:

• --help boolean
  • Zobrazí nápovědu.
• --config string (Pages toto nepodporují)
  • Cesta k vašemu Konfigurační soubor Wrangler.
• --cwd string
  • Spustit, jako by byl Wrangler spuštěn v zadaném adresáři místo aktuálního pracovního adresáře.

auth create

Vytvoření nebo opětovné ověření pojmenovaného auth profilu

npx wrangler auth create [NAME]

• [NAME]string povinné

  Název ověřovacího profilu

• --browserboolean výchozí: true

  Automaticky otevřít odkaz OAuth v prohlížeči

• --scopesstring

  Vybrat sadu příslušných rozsahů OAuth při přihlašování

• --callback-hoststring výchozí: localhost

  Použijte IP adresu nebo adresu hostitele pro dočasný callback server pro přihlášení.

• --callback-portnumber výchozí: 8976

  Použijte port pro dočasný callback server pro přihlášení.

auth activate

Přiřazení pojmenovaného ověřovacího profilu k adresáři

npx wrangler auth activate [NAME] [DIR]

• [NAME]string povinné

  Název ověřovacího profilu, který se má aktivovat

• [DIR]string

  Adresář, ke kterému se má profil svázat (výchozí je aktuální adresář)

auth deactivate

Odebrat vazbu ověřovacího profilu z adresáře

npx wrangler auth deactivate [DIR]

• [DIR]string

  Adresář, který se má odpojit (výchozí je aktuální adresář). Musí se jednat přesně o adresář, ke kterému byl profil svázán.

auth list

Vypsat všechny profily ověřování

npx wrangler auth list

auth delete

Odstranit pojmenovaný profil ověření

npx wrangler auth delete [NAME]

• [NAME]string povinné

  Název ověřovacího profilu, který se má odstranit

whoami

🕵️ Načíst své uživatelské informace

npx wrangler whoami

• --accountstring

  Zobrazí informace o členství pro zadaný účet (id nebo název).

• --jsonboolean výchozí: false

  Vrátí informace o uživateli jako JSON. Pokud uživatel není ověřen, ukončí se s nenulovým stavovým kódem.

Cloudflare shromažďuje anonymní data o používání za účelem zlepšování Wrangler. Více se dozvíte v našich zásady zpracování dat ↗.

Sdílení dat o používání můžete kdykoli spravovat pomocí těchto příkazů.

Zakázat shromažďování telemetrie pro Wrangler.

wrangler telemetry disable

Povolte sběr telemetrie pro Wrangler.

wrangler telemetry enable

Zkontrolujte, zda je aktuálně povoleno shromažďování telemetrie. Vrácený výsledek je specifický pro adresář, ve kterém jste příkaz spustili.

Tímto se vyřeší globální stav nastavený wrangler telemetry disable / enable, proměnná prostředí WRANGLER_SEND_METRICS, a send_metrics klíč v Konfigurační soubor Wrangler.

wrangler telemetry status

Následující globální příznaky fungují u každého příkazu:

• --help boolean
  • Zobrazí nápovědu.
• --config string (Pages toto nepodporují)
  • Cesta k vašemu Konfigurační soubor Wrangler.
• --cwd string
  • Spustit, jako by byl Wrangler spuštěn v zadaném adresáři místo aktuálního pracovního adresáře.

Vygenerujte skripty pro doplňování příkazů Wrangler v shellu. Díky doplňování v shellu můžete při psaní stisknutím klávesy Tab automaticky doplňovat příkazy, podpříkazy a přepínače.

wrangler complete <SHELL>

• SHELL string povinné
  • Shell, pro který se mají generovat doplňování příkazů. Podporované hodnoty: bash, zsh, fish, powershell.

Vygenerujte skript pro doplňování a přidejte ho do konfiguračního souboru svého shellu:

wrangler complete bash >> ~/.bashrc

wrangler complete zsh >> ~/.zshrc

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

wrangler complete powershell >> $PROFILE

Po dokončení nastavení stiskněte klávesu Tab pro automatické doplňování příkazů, podpříkazů a příznaků:

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

Následující globální příznaky fungují u každého příkazu:

• --help boolean
  • Zobrazí nápovědu.
• --config string (Pages toto nepodporují)
  • Cesta k vašemu Konfigurační soubor Wrangler.
• --cwd string
  • Spustit, jako by byl Wrangler spuštěn v zadaném adresáři místo aktuálního pracovního adresáře.