How to get started in 3 minutes using the CLI and SDK.
In this guide we will:
trigger.config.ts
file and a /trigger
directory with an example task.You can either:
Once you’ve created an account, follow the steps in the app to:
Make sure you create a “Version 3” project. You might need to request early access.
The easiest way to get started it 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:
It will do a few things:
trigger.config.ts
file in the root of your project./trigger
directory./trigger
directory with an example task, /trigger/example.[ts/js]
.The CLI dev
command runs a server for your tasks. It will 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.
The CLI dev
command spits out various useful URLs. Right now we want to visit the Test page it provided.
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.
Press the "Run test" button.
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 tasks that are running and links to the run log.
Learn how to trigger tasks from your code.
Tasks are the core of Trigger.dev. Learn what they are and how to write them.