Remix setup guide

Prerequisites

A Remix project
A Trigger.dev account with a project created
Node.js 18 or later

Initial setup

Run the CLI init command

In the root of your Remix project, run:

npx trigger.dev@latest init

pnpm dlx trigger.dev@latest init

yarn dlx trigger.dev@latest init

This creates trigger.config.ts and a sample task at src/trigger/example.ts.

Start the dev server

Run the Trigger.dev dev server (keep your Remix dev server running in a separate terminal):

npx trigger.dev@latest dev

pnpm dlx trigger.dev@latest dev

yarn dlx trigger.dev@latest dev

Run a test

Open the Trigger.dev dashboard, navigate to your project, and use the Test page to trigger the hello-world task.

View your run

Click through to the run page to see live logs and the task output.

Set your secret key locally

Add your TRIGGER_SECRET_KEY to the .env file in the root of your Remix project. Get your DEV secret key from the API Keys page in the dashboard: Find your DEV API key under API Keys in the Trigger.dev dashboard.

Triggering tasks from Remix

Create an API route

Create app/routes/api.hello-world.ts:

app/routes/api.hello-world.ts

import type { helloWorldTask } from "../../src/trigger/example";
import { tasks } from "@trigger.dev/sdk";

export async function loader() {
  const handle = await tasks.trigger<typeof helloWorldTask>("hello-world", "James");

  return new Response(JSON.stringify(handle), {
    headers: { "Content-Type": "application/json" },
  });
}

Test your route

With both the Remix dev server and the Trigger.dev dev server running, visit http://localhost:5173/api/hello-world. The task will be triggered and the run handle returned as JSON.

Add environment variables

Add any environment variables your tasks require to the Trigger.dev dashboard under Environment Variables before deploying.

Deploying your task

npx trigger.dev@latest deploy

pnpm dlx trigger.dev@latest deploy

yarn dlx trigger.dev@latest deploy

Deploying to Vercel Edge Functions

The @trigger.dev/sdk package supports the edge runtime out of the box. Use a type-only import for the task to ensure compatibility.

Update your API route for edge

app/routes/api.hello-world.ts

import { tasks } from "@trigger.dev/sdk";
import type { helloWorldTask } from "../../src/trigger/example";
//      👆 type-only import

export const config = {
  runtime: "edge",
};

export async function action({ request }: { request: Request }) {
  const payload = await request.json();
  const handle = await tasks.trigger<typeof helloWorldTask>("hello-world", payload);
  return new Response(JSON.stringify(handle), {
    headers: { "Content-Type": "application/json" },
  });
}

Create or update vercel.json

vercel.json

{
  "buildCommand": "npm run vercel-build",
  "devCommand": "npm run dev",
  "framework": "remix",
  "installCommand": "npm install",
  "outputDirectory": "build/client"
}

Update package.json scripts

Add the vercel-build script which copies static assets to the expected output path:

package.json

{
  "scripts": {
    "build": "remix vite:build",
    "dev": "remix vite:dev",
    "start": "remix-serve ./build/server/index.js",
    "typecheck": "tsc",
    "vercel-build": "remix vite:build && cp -r ./public ./build/client"
  }
}

Deploy to Vercel

Push your code to a Git repository, then create a new project in the Vercel dashboard and connect it to your repo.

Add your secret key to Vercel

In your Vercel project settings, add the environment variable:

TRIGGER_SECRET_KEY=your-secret-key

Get your production secret key from the API Keys page in the Trigger.dev dashboard.

Test in production

After deploying, send a POST request to verify the task triggers correctly:

curl -X POST https://your-app.vercel.app/api/hello-world \
  -H "Content-Type: application/json" \
  -d '{"name": "James"}'

The runtime: "edge" configuration improves cold-start times on Vercel’s Edge Network. The type-only import (import type) ensures the task code itself is never bundled into the edge function — only the type information is used at compile time.

Guides

Example Projects

Example Tasks

Prerequisites

Initial setup

Set your secret key locally

Triggering tasks from Remix

Add environment variables

Deploying your task

Deploying to Vercel Edge Functions

Additional resources

Build extensions

Deployment guide

​Prerequisites

​Initial setup

​Set your secret key locally

​Triggering tasks from Remix

​Add environment variables

​Deploying your task

​Deploying to Vercel Edge Functions

​Additional resources

Build extensions

Deployment guide

Prerequisites

Initial setup

Set your secret key locally

Triggering tasks from Remix

Add environment variables

Deploying your task

Deploying to Vercel Edge Functions

Additional resources