Workflows は、Workers 向けコマンドラインインターフェースである Wrangler を使ったローカル開発に対応しています。Wrangler が動かすのは、Cloudflare がグローバルに動かす Workflows とは異なる、エミュレート版です。
Workflows をローカルで開発するには、次が必要です。
- Wrangler v3.89.0 ↗ 以降。
- Node.js のバージョン
18.0.0以降。権限の問題を避け、Node のバージョンを切り替えるには、Volta ↗ や nvm ↗ などの Node バージョンマネージャーの利用を検討してください。 - Workflows や Cloudflare Workers が初めての場合は、Workflows ガイド を参照して
wranglerをインストールし、最初の Workflows をデプロイしてください。
ターミナルを開き、次のコマンドを実行してローカル開発セッションを開始します。
# Confirm we are using wrangler v3.89.0+
npx wrangler --version⛅️ wrangler 3.89.0ローカル開発セッションを開始します。
# Start a local dev session:
npx wrangler dev------------------
Your worker has access to the following bindings:
- Workflows:
- MY_WORKFLOW: MyWorkflow
⎔ Starting local server...
[wrangler:inf] Ready on http://127.0.0.1:8787/ローカル開発セッションは、本番で Workflows が動く環境を反映した、スタンドアロンのローカル専用環境を作ります。本番へデプロイする 前に Workflows をテストできます。
ローカル開発セッションの設定方法は、wrangler dev のドキュメント を参照してください。
wrangler dev セッションの実行中は、wrangler workflows コマンド に --local フラグを付けて、ローカルの Workflow インスタンスを操作できます。
たとえば、ローカルの Workflows を一覧するには次を実行します。
npx wrangler workflows list --localローカルで Workflow を起動するには次を実行します。
npx wrangler workflows trigger my-workflow --local特定のインスタンスを確認するには次を実行します。
npx wrangler workflows instances describe my-workflow <INSTANCE_ID> --localすべてのコマンドは、特定の wrangler dev セッションを対象にする --port を受け付けます(デフォルトは 8787)。
Local Explorer は、開発中にローカルの Workflow インスタンスを表示・管理するためのブラウザベースのインターフェースです。CLI コマンドを実行する代わりに、ブラウザで Local Explorer を開いて、Workflows を直接操作できます。
wrangler dev セッションの実行中に、ターミナルで e を押すと Local Explorer が開きます。または、ブラウザで http://localhost:8787/cdn-cgi/local/explorer を開きます。
Local Explorer では次ができます。
- プロジェクトに定義されたすべての Workflows と、そのインスタンスを表示する。
- 各インスタンスのステップ履歴と現在のステータスを確認する。
- 新しい Workflow 実行を起動し、実行中のインスタンスにイベントを送る。
- インスタンスの一時停止、再開、終了、再起動。
- 特定のインスタンスを削除するか、すべてを一度にクリアする。
Local Explorer には、Wrangler バージョン 4.82.1 以降、または Cloudflare Vite plugin バージョン 1.32.0 以降が必要です。
Workflows は リモートバインディング としては使えません。npx wrangler dev --remote でも使えません。