Quick start

How to get started in 3 minutes using the CLI and SDK.

1. Create a Trigger.dev account

   Sign up at Trigger.dev Cloud (or self-host). The onboarding flow will guide you through creating your first organization and project.

2. Run the CLI `init` command

   The easiest way to get started is to use the CLI. It will add Trigger.dev to your existing project, create a /trigger folder and give you an example task.

   Run this command in the root of your project to get started:

   npm

   npx trigger.dev@latest init
   

   It will do a few things:

   Our Trigger.dev MCP server gives your AI assistant direct access to Trigger.dev tools; search docs, trigger tasks, deploy projects, and monitor runs. We recommend installing it for the best developer experience.

   1. Ask if you want to install the Trigger.dev MCP server for your AI assistant.
   2. Log you into the CLI if you’re not already logged in.
   3. Ask you to select your project.
   4. Install the required SDK packages.
   5. Ask where you’d like to create the /trigger directory and create it with an example task.
   6. Create a trigger.config.ts file in the root of your project.

   Install the “Hello World” example task when prompted. We’ll use this task to test the setup.

3. Run the CLI `dev` command

   The CLI dev command runs a server for your tasks. It watches for changes in your /trigger directory and communicates with the Trigger.dev platform to register your tasks, perform runs, and send data back and forth.

   It can also update your @trigger.dev/* packages to prevent version mismatches and failed deploys. You will always be prompted first.

   npm

   npx trigger.dev@latest dev
   
4. Perform a test run using the dashboard

   The CLI dev command spits out various useful URLs. Right now we want to visit the Test page.

   You should see our Example task in the list , select it. Most tasks have a “payload” which you enter in the JSON editor , but our example task doesn’t need any input.

   You can configure options on the run , view recent payloads , and create run templates .

   Press the “Run test” button .

   
5. View your run

   Congratulations, you should see the run page which will live reload showing you the current state of the run.

   

   If you go back to your terminal you’ll see that the dev command also shows the task status and links to the run log.

   

Next steps

Building with AI

Learn how to build Trigger.dev projects using AI coding assistants

How to trigger your tasks

Learn how to trigger tasks from your code.

Writing tasks

Tasks are the core of Trigger.dev. Learn what they are and how to write them.

Guides and example projects

Guides and examples for triggering tasks from your code.