In this guide we will:

  1. Create a trigger.config.ts file and a /trigger directory with an example task.
  2. Get you to run the task using the CLI.
  3. Show you how to view the run logs for that task.

Create a account

You can either:


Create your first project

Once you’ve created an account, follow the steps in the app to:

  1. Complete your account details.
  2. Create your first Organization and Project.

Run the CLI `init` command

The easiest way to get started it to use the CLI. It will add 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:

npx init

It will do a few things:

  1. Log you into the CLI if you're not already logged in.
  2. Create a trigger.config.ts file in the root of your project.
  3. Ask where you'd like to create the /trigger directory.
  4. Create the /trigger directory with an example task, /trigger/example.[ts/js].

Run the CLI `dev` command

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

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

npx dev

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 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.


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 tasks that are running and links to the run log.

Next steps