Matt Aitken
3a35d60091
* The v3 init command defaults to the “@v3” tag * Change it to beta * Updated the docs and in-app docs * Updated GitHub action
120 lines
3.0 KiB
Plaintext
120 lines
3.0 KiB
Plaintext
---
|
|
title: "Quick start"
|
|
description: "How to get started in 3 minutes using the CLI and SDK."
|
|
---
|
|
|
|
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.
|
|
|
|
<Steps titleSize="h3">
|
|
|
|
<Step title="Create a Trigger.dev account">
|
|
|
|
You can either:
|
|
|
|
- Use the [Trigger.dev Cloud](https://cloud.trigger.dev).
|
|
- Or [self-host](/v3/open-source-self-hosting) the service.
|
|
|
|
</Step>
|
|
|
|
<Step title="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.
|
|
|
|
<Warning>
|
|
Make sure you create a "Version 3" project. You might need to [request early
|
|
access](https://trigger.dev/v3-early-access).
|
|
</Warning>
|
|
|
|
</Step>
|
|
|
|
<Step title="Run the CLI `init` command">
|
|
|
|
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:
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npx trigger.dev@beta init
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm dlx trigger.dev@beta init
|
|
```
|
|
|
|
```bash yarn
|
|
yarn dlx trigger.dev@beta init
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
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]`.
|
|
|
|
</Step>
|
|
|
|
<Step title="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 Trigger.dev platform to register your tasks, perform runs, and send data back and forth.
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npx trigger.dev@beta dev
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm dlx trigger.dev@beta dev
|
|
```
|
|
|
|
```bash yarn
|
|
yarn dlx trigger.dev@beta dev
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
</Step>
|
|
|
|
<Step title="Perform a run test 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.
|
|
|
|
</Step>
|
|
|
|
<Step title="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.
|
|
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## Next steps
|
|
|
|
<CardGroup>
|
|
<Card title="How to trigger your tasks" icon="bolt" href="/v3/triggering">
|
|
Learn how to trigger tasks from your code.
|
|
</Card>
|
|
<Card title="Writing tasks" icon="wand-magic-sparkles" href="/v3/tasks-overview">
|
|
Tasks are the core of Trigger.dev. Learn what they are and how to write them.
|
|
</Card>
|
|
</CardGroup>
|