workflow

环境要求

• 已安装 Node.js 与 npm（能执行 npm / npx 命令）
• 一个已存在的 JavaScript 或 TypeScript 项目（README 说明为在现有项目中安装）
• 如使用 Next.js，需准备 next.config.ts 配置文件
• 部署到生产环境需 Vercel 账号，或自托管时使用 Postgres 后端 / 自定义 World

安装与启动步骤

1. 1安装 Workflow SDK

   在现有项目根目录执行安装，把 workflow 包加入依赖；安装后包内自带完整文档，编码 Agent 可读本地版本匹配的指南。

   npm install workflow

   复制

2. 2配置框架集成

   按所用框架配置集成。README 以 Next.js 为例：在 next.config.ts 中用 withWorkflow 包裹导出配置。其他框架见官方 getting-started 指南。

   import { withWorkflow } from 'workflow/next';
   
   export default withWorkflow({});

   复制

3. 3启动工作流

   在 API 路由、Server Action 或其他服务端代码中，从 workflow/api 导入 start，传入工作流函数与参数即可触发执行。

   import { start } from 'workflow/api';
   import { onboardUser } from './workflows/onboard-user';
   
   await start(onboardUser, ['hello@example.com']);

   复制

4. 4运行应用

   按项目原有方式启动开发服务器，让上面的服务端代码生效。

   npm run dev

   复制

5. 5打开观测界面

   另开一个终端运行本地可观测 UI，查看工作流执行状态；本地开发使用内置后端，无需任何配置。

   npx workflow web

   复制

关键配置

如何确认成功

应用启动后另开终端执行 npx workflow web，能打开本地观测 UI 并看到工作流执行记录即为成功。

常见问题

注意事项

• README 只提供 Next.js 的集成示例，其他框架需查阅官方 getting-started 文档确认。
• 本地观测 UI 需在另一个终端单独启动，不要和 npm run dev 混在同一进程里。
• 工作流必须从服务端代码（API 路由、Server Action 等）启动，不能在前端直接调用。