用途:当需要从 OpenAPI 规范生成全新 SDK 时使用,是 SDK 生成的主技能。适用于新建 SDK 项目、尚无 .speakeasy/workflow.yaml、首次配置 Speakeasy,以及需要 TypeScript、Python、Go、Java、C#、PHP、Ruby、Kotlin、Terraform 等目标语言的场景。
主要能力:始终用 speakeasy quickstart 初始化新项目,该命令会同时生成 SDK 和必需的 .speakeasy/workflow.yaml 配置文件。不要对新项目使用 speakeasy generate sdk,因为它不会创建工作流文件,会失去可复现构建、多目标生成、CI/CD 集成、版本跟踪与升级路径。输入包括 OpenAPI 规范(本地文件、URL 或注册表源)、目标语言、PascalCase SDK 名称和非交互环境所需的包名。
必要用法:非交互环境需先认证,可运行 speakeasy auth login,或设置 export SPEAKEASY_API_KEY="<your-api-key>"。命令格式为 speakeasy quickstart --skip-interactive --output console -s <schema> -t <target> -n <name> -p <package-name>。常用参数:--skip-interactive 用于自动化;--schema/-s 指定 OpenAPI 来源;--target/-t 指定语言;--name/-n 指定 SDK 名称;--package-name/-p 指定包名;--out-dir/-o 指定输出目录;--output console 输出结构化结果;--init-git 初始化 git 仓库。schema 可为本地路径、HTTP(S) URL、注册表源名、源名@标签或 org/workspace/source@tag。
生成内容与后续:创建 .speakeasy/workflow.yaml 和输出目录中的完整 SDK。之后可检查生成结果,在 workflow.yaml 中添加多语言目标,运行 speakeasy run -y --output console 重新生成。可用 speakeasy lint openapi --non-interactive -s spec.yaml 校验规范,speakeasy pull --list --format json 查看注册表源。
限制与排错:工作流已存在时改用 speakeasy run;未授权需登录或设置 API key;schema 未找到需验证路径或用 speakeasy pull --list 查看源。自动化环境不要省略 --skip-interactive 和 --output console,否则会等待输入或缺少可验证输出。