mcpField
W
workflow-init

workflow-init

github.com/vercel开发2.5k3.8k 次安装今天更新
代码仓库

关于 workflow-init

用于尚未安装 Vercel Workflow SDK 的项目的初始化技能。它会检测或询问项目框架,遵循对应的官方入门指南,并验证初始配置。

主要功能

  1. 01检查是否已安装 Workflow
  2. 02检测项目所用框架
  3. 03遵循对应的初始化指南
  4. 04验证示例工作流

适用场景

  1. 01在现有框架项目中配置 Workflow
  2. 02初始化前选择受支持的框架
  3. 03测试首个工作流端点

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/vercel/workflow --skill workflow-init

安装后在 Claude Code 中输入/workflow-init确认已加载。

详细介绍

workflow-init

在安装 workflow 之前,初始设置 Vercel Workflow SDK。获取适用于用户所用框架的官方入门指南。

决策流程

0) 基本检查

读取 package.json。如果 workflow 已是依赖项,告知用户改用 /workflow(它会读取 node_modules/workflow/docs/ 中按版本整理的文档)。只有在缺少 workflow 时才继续。

1) 确定框架

非交互式: 如果用户在提示中指定了框架,直接使用该框架。

自动检测: 检查 package.json 中的依赖项和配置文件。使用第一个匹配项:

  1. Next.js - 存在 next 依赖项或 next.config.*
  2. Nuxt - 存在 nuxt 依赖项或 nuxt.config.*
  3. SvelteKit - 存在 @sveltejs/kit 依赖项或 svelte.config.*
  4. Astro - 存在 astro 依赖项或 astro.config.*
  5. NestJS - 存在 @nestjs/core 依赖项或 nest-cli.json
  6. Nitro - 存在 nitro 依赖项或 nitro.config.*
  7. Express - 存在 express 依赖项
  8. Fastify - 存在 fastify 依赖项
  9. Hono - 存在 hono 依赖项
  10. Vite - 存在 vite 依赖项(且未匹配以上框架)

如果没有匹配项或存在多个匹配项,请让用户选择。

2) 获取并遵循入门指南

获取以下 URL 中的一个,并逐步遵循指南:

框架URL
Next.jshttps://workflow-sdk.dev/docs/getting-started/next
Expresshttps://workflow-sdk.dev/docs/getting-started/express
Honohttps://workflow-sdk.dev/docs/getting-started/hono
Fastifyhttps://workflow-sdk.dev/docs/getting-started/fastify
NestJShttps://workflow-sdk.dev/docs/getting-started/nestjs
Nitrohttps://workflow-sdk.dev/docs/getting-started/nitro
Nuxthttps://workflow-sdk.dev/docs/getting-started/nuxt
Astrohttps://workflow-sdk.dev/docs/getting-started/astro
SvelteKithttps://workflow-sdk.dev/docs/getting-started/sveltekit
Vitehttps://workflow-sdk.dev/docs/getting-started/vite

每份指南都涵盖:安装依赖、配置框架、创建第一个工作流、创建路由处理程序、运行并验证。

3) 验证设置
  • 按照指南启动开发服务器。
  • 使用指南提供的 curl 调用示例端点。
  • 确认日志显示工作流和步骤正在执行。
  • 可选:npx workflow web 或 npx workflow inspect runs。
4) 还没有框架?

如果不存在框架,请询问用户想要哪种:

  • Web 应用:Next.js / Nuxt / SvelteKit / Astro
  • API 服务:Express / Fastify / Hono
  • 精简服务:Nitro 或 Vite

然后遵循所选指南中的“创建项目”部分。

概念问题(安装前)

如果用户在安装前提出概念性问题,请获取:

后续步骤

设置完成后,告知用户:后续开发请使用 /workflow——它会读取 node_modules/workflow/docs/ 中附带的按版本整理的文档。

评论

支持 Markdown