跳转到内容
搜索文档

本地开发

最后更新 查看 MarkdownAgent 设置

Workflows 支持使用 Wrangler(Workers 的命令行工具)进行本地开发。Wrangler 运行的是 Workflows 模拟版本,与 Cloudflare 在全球运行的版本有所不同。

前提条件

要在本地开发 Workflows,你需要:

  • Wrangler v3.89.0 或更高版本。

  • Node.js 版本 18.0.0 或更高。建议使用 Voltanvm 等 Node 版本管理器,以避免权限问题并切换 Node 版本。

  • 如果你是 Workflows 和/或 Cloudflare Workers 的新用户,请参阅 Workflows 指南 安装 wrangler 并部署你的第一个 Workflow。

启动本地开发会话

打开终端并运行以下命令以启动本地开发会话:

# 确认使用的是 wrangler v3.89.0+
npx wrangler --version
⛅️ wrangler 3.89.0

启动本地开发会话

# 启动本地开发会话:
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 文档 了解如何配置本地开发会话。

在本地管理 Workflows

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

所有命令都接受 --port 以指定特定的 wrangler dev 会话(默认为 8787)。

Local Explorer

Local Explorer 是一个基于浏览器的界面,用于在开发期间查看和管理本地 Workflow 实例。无需运行 CLI 命令,你可以在浏览器中打开 Local Explorer 并直接与 Workflows 交互。

wrangler dev 会话运行期间,在终端中按 e 打开 Local Explorer,或在浏览器中访问 http://localhost:8787/cdn-cgi/explorer

使用 Local Explorer 你可以:

  • 查看项目中定义的所有 Workflows 及其实例。
  • 检查每个实例的步骤历史和当前状态。
  • 触发新的 Workflow 运行并向运行中的实例发送事件。
  • 暂停、恢复、终止和重启实例。
  • 删除特定实例或一次性清除所有实例。

Local Explorer 需要 Wrangler 版本 4.82.1 或更高,或 Cloudflare Vite 插件 版本 1.32.0 或更高。

已知问题

Workflows 不支持作为远程绑定(binding) 使用,也不支持在使用 npx wrangler dev --remote 时使用。

这篇文档对您有帮助吗?