在 `node_modules` 中尚未存在 `workflow` 包时,安装并配置 Vercel Workflow SDK。适用于用户针对 Next.js、Express、Hono、Fastify、NestJS、Nitro、Nuxt、Astro、SvelteKit 或 Vite 项目提出“安装 workflow”、“设置 workflow”、“添加持久化工作流”、“配置 workflow sdk”或“初始化 workflow”等需求时。
workflow-init
在安装 workflow 之前完成 Vercel Workflow SDK 的初始搭建。获取用户所用框架的官方入门指南。
决策流程
0) 基础检查(Sanity check)
读取 package.json。若 workflow 已经在依赖项中,告知用户直接使用 /workflow 命令(该命令会读取 node_modules/workflow/docs/ 下对应版本的文档)。仅在缺少 workflow 时继续以下步骤。
1) 确定所用框架
非交互模式: 若用户在 Prompt 中明确指明了框架,直接使用该框架。
自动检测: 检查 package.json 中的依赖项以及项目配置文件,按顺序使用第一个匹配到的框架:
- Next.js - 包含
next依赖或next.config.*文件 - Nuxt - 包含
nuxt依赖或nuxt.config.*文件 - SvelteKit - 包含
@sveltejs/kit依赖或svelte.config.*文件 - Astro - 包含
astro依赖或astro.config.*文件 - NestJS - 包含
@nestjs/core依赖或nest-cli.json文件 - Nitro - 包含
nitro依赖或nitro.config.*文件 - Express - 包含
express依赖 - Fastify - 包含
fastify依赖 - Hono - 包含
hono依赖 - Vite - 包含
vite依赖(且未匹配上述框架)
如果未匹配到任何框架,或同时匹配到多个框架,请让用户手动选择。
2) 获取并遵循入门指南
抓取下表中的其中一个 URL,并逐步按照指南进行操作:
每份指南涵盖以下内容:安装依赖、配置框架、创建首个工作流、创建路由处理函数(route handler)、运行与验证。
3) 验证配置
- 按照指南启动开发服务器。
- 使用指南中提供的
curl命令触发示例接口。 - 确认日志中显示了工作流及对应步骤(steps)的执行过程。
- 可选操作:运行
npx workflow web或npx workflow inspect runs。
4) 尚未建立项目/框架?
若当前不存在任何框架,询问用户的构建需求:
- Web 应用:Next.js / Nuxt / SvelteKit / Astro
- API 服务:Express / Fastify / Hono
- 轻量级服务:Nitro 或 Vite
随后遵照所选框架指南中的 "Create Your Project" 章节进行操作。
概念咨询(安装前)
若用户在安装前询问相关概念性问题,请抓取以下文档:
引导后续使用
配置完成后,告知用户:后续开发请使用 /workflow——该命令会读取打包在 node_modules/workflow/docs/ 中的版本化文档。






