用途:在现有项目中从零接入 Trigger.dev。目标状态是 SDK 已安装、trigger.config.ts 指向项目 ref、/trigger 目录中至少有一个导出的任务,且 trigger dev 运行后任务出现在控制台。
主要能力与用法:最快路径是 CLI 向导,可完成下列机械步骤,并可选安装 MCP server 与相关技能:npx trigger.dev@latest init。init 不适用时(monorepo、需扩展现有配置、非交互环境)改用手动步骤。
手动步骤:1) 认证(需人工):npx trigger.dev@latest login,自托管加 --api-url https://your-trigger-instance.com。2) 安装依赖,运行时依赖与开发依赖版本需与 CLI 一致:npm add @trigger.dev/sdk@latest;npm add --save-dev @trigger.dev/build@latest。3) 在项目根目录写 trigger.config.ts(JS 为 trigger.config.mjs),project 与 dirs 为必填,可用 runtime: "bun",构建扩展来自 @trigger.dev/build 放入 build.extensions。4) 在 dirs 对应目录导出命名任务:import { task } from "@trigger.dev/sdk"; export const helloWorld = task({ id: "hello-world", run: async (payload: { name: string }) => ({ message: Hello ${payload.name}! }) });。5) 将 trigger.config.ts 加入 tsconfig.json 的 include,并把 .trigger 加入 .gitignore。6) 设置密钥(需人工):将 TRIGGER_SECRET_KEY 设为控制台 API Keys 页的 DEV key,自托管另设 TRIGGER_API_URL。7) 运行 npx trigger.dev@latest dev 并保持运行。
从应用触发:使用仅类型导入避免打包任务代码,按 id 触发:import { tasks } from "@trigger.dev/sdk"; import type { helloWorld } from "@/trigger/example"; const handle = await tasks.trigger<typeof helloWorld>("hello-world", { name: "Ada" });,运行处需设置 TRIGGER_SECRET_KEY。
适用场景与限制:适用于现有项目从零接入,支持 monorepo(共享包或直接装到应用,从含 trigger.config.ts 的目录运行 trigger dev)。认证与控制台读取密钥两步必须由人完成,无法无头执行,应先向用户说明并等待。常见错误:CLI 与 SDK 大版本不一致会破坏 dev/deploy;不要从 @trigger.dev/sdk/v3 导入或使用 client.defineJob();任务须为配置目录内的命名导出;后端代码不要导入任务实例,应用类型导入;忘设 TRIGGER_SECRET_KEY 会导致从应用触发失败。未提供内容:具体收费与价格、控制台界面细节、支持平台清单暂未提供。