trigger-setup

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Trigger.dev Setup

Trigger.dev 项目设置

Get Trigger.dev running in your project in minutes.

几分钟内让Trigger.dev在你的项目中运行起来。

When to Use

适用场景

Adding Trigger.dev to an existing project
Creating your first task
Setting up trigger.config.ts
Connecting to Trigger.dev cloud

向现有项目中添加Trigger.dev
创建你的第一个任务
设置trigger.config.ts
连接到Trigger.dev云服务

Prerequisites

前置条件

Node.js 18+ or Bun
A Trigger.dev account (https://cloud.trigger.dev)

Node.js 18+ 或 Bun
一个Trigger.dev账户（https://cloud.trigger.dev）

Quick Start

快速开始

1. Install the SDK

1. 安装SDK

bash

npm install @trigger.dev/sdk

bash

npm install @trigger.dev/sdk

2. Initialize Your Project

2. 初始化你的项目

bash

npx trigger init

This creates:

```
trigger.config.ts
```
- project configuration
```
trigger/
```
directory - where your tasks live
```
trigger/example.ts
```
- a sample task

bash

npx trigger init

这会创建：

```
trigger.config.ts
```
- 项目配置文件
```
trigger/
```
目录 - 你的任务存放位置
```
trigger/example.ts
```
- 一个示例任务

3. Configure trigger.config.ts

3. 配置trigger.config.ts

import { defineConfig } from "@trigger.dev/sdk";

export default defineConfig({
  project: "proj_xxxxx", // From dashboard
  dirs: ["./trigger"],
});

import { defineConfig } from "@trigger.dev/sdk";

export default defineConfig({
  project: "proj_xxxxx", // 来自控制台
  dirs: ["./trigger"],
});

4. Create Your First Task

4. 创建你的第一个任务

// trigger/my-task.ts
import { task } from "@trigger.dev/sdk";

export const myFirstTask = task({
  id: "my-first-task",
  run: async (payload: { name: string }) => {
    console.log(`Hello, ${payload.name}!`);
    return { message: `Processed ${payload.name}` };
  },
});

// trigger/my-task.ts
import { task } from "@trigger.dev/sdk";

export const myFirstTask = task({
  id: "my-first-task",
  run: async (payload: { name: string }) => {
    console.log(`Hello, ${payload.name}!`);
    return { message: `Processed ${payload.name}` };
  },
});

5. Start Development Server

5. 启动开发服务器

bash

npx trigger dev

bash

npx trigger dev

6. Trigger Your Task

6. 触发你的任务

From your app code:

import { tasks } from "@trigger.dev/sdk";
import type { myFirstTask } from "./trigger/my-task";

await tasks.trigger<typeof myFirstTask>("my-first-task", {
  name: "World",
});

Or from the Trigger.dev dashboard "Test" tab.

从你的应用代码中：

import { tasks } from "@trigger.dev/sdk";
import type { myFirstTask } from "./trigger/my-task";

await tasks.trigger<typeof myFirstTask>("my-first-task", {
  name: "World",
});

或者从Trigger.dev控制台的“测试”标签页触发。

Project Structure

项目结构

your-project/
├── trigger.config.ts    # Required - project config
├── trigger/             # Required - task files
│   ├── my-task.ts
│   └── another-task.ts
├── package.json
└── ...

your-project/
├── trigger.config.ts    # 必填 - 项目配置文件
├── trigger/             # 必填 - 任务文件目录
│   ├── my-task.ts
│   └── another-task.ts
├── package.json
└── ...

Environment Variables

环境变量

Create

.env

or set in your environment:

bash

TRIGGER_SECRET_KEY=tr_dev_xxxxx  # From dashboard > API Keys

创建

.env

文件或在环境中设置：

bash

TRIGGER_SECRET_KEY=tr_dev_xxxxx  # 来自控制台 > API密钥

Common Issues

常见问题

"No tasks found"

“未找到任务”

Ensure tasks are exported from files in
```
dirs
```
folders
Check
```
trigger.config.ts
```
points to correct directories

确保任务从
```
dirs
```
文件夹中的文件导出
检查
```
trigger.config.ts
```
指向正确的目录

"Project not found"

“未找到项目”

Verify
```
project
```
in config matches dashboard
Check
```
TRIGGER_SECRET_KEY
```
is set

验证配置中的
```
project
```
与控制台中的一致
检查是否已设置
```
TRIGGER_SECRET_KEY
```

"Task not registered"

“任务未注册”

Restart
```
npx trigger dev
```
after adding new tasks
Tasks must use
```
task()
```
or
```
schemaTask()
```
from
```
@trigger.dev/sdk
```

添加新任务后重启
```
npx trigger dev
```
任务必须使用
```
@trigger.dev/sdk
```
中的
```
task()
```
或
```
schemaTask()
```

Next Steps

后续步骤

Add retry logic → see trigger-tasks skill
Configure build extensions → see trigger-config skill
Build AI workflows → see trigger-agents skill
Add real-time UI → see trigger-realtime skill

添加重试逻辑 → 查看trigger-tasks技能
配置构建扩展 → 查看trigger-config技能
构建AI工作流 → 查看trigger-agents技能
添加实时UI → 查看trigger-realtime技能