James Ritchie
0d4e3e70c1
* tasks no longer inside a group in the side menu (and added “cron”) * Delay using a timezone * Added React Not Defined error to the troubleshooting page * Improved the React common problem * Link to v2 docs * New Development section and entry in Common Problems * Concurrently running the terminal * Fixed the .env weirdness * Added section on creating PATs for Github actions * Improved the Machine spec and limits page * Quick start steps now have nice images * Added a diagram for the lifecycle functions * Added note about onFailure * CRON -> cron/Cron * Updated the cli-dev steps for the concurrently package * Fixed capital letter * Updated diagram text * Removed dead page
93 lines
1.9 KiB
Plaintext
93 lines
1.9 KiB
Plaintext
---
|
||
title: "CLI dev command"
|
||
description: "The `trigger.dev dev` command is used to run your tasks locally."
|
||
---
|
||
|
||
This runs a server on your machine that can execute Trigger.dev tasks:
|
||
|
||
<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>
|
||
|
||
It will first perform an update check to prevent version mismatches, failed deploys, and other errors. You will always be prompted first.
|
||
|
||
You will see in the terminal that the server is running and listening for requests. When you run a task, you will see it in the terminal along with a link to view it in the dashboard.
|
||
|
||
It is worth noting that each task runs in a separate Node process. This means that if you have a long-running task, it will not block other tasks from running.
|
||
|
||
## Options
|
||
|
||
### Attaching a local debugger
|
||
|
||
You can use the `--debugger` flag to run the server in debug mode. This will allow you to attach a debugger to the server and debug your tasks.
|
||
|
||
<CodeGroup>
|
||
|
||
```bash npm
|
||
npx trigger.dev@beta dev --debugger
|
||
```
|
||
|
||
```bash pnpm
|
||
pnpm dlx trigger.dev@beta dev --debugger
|
||
```
|
||
|
||
```bash yarn
|
||
yarn dlx trigger.dev@beta dev --debugger
|
||
```
|
||
|
||
</CodeGroup>
|
||
|
||
### Concurrently running the terminal
|
||
|
||
The concurrently package allows you to run multiple package.json scripts at the same time – in this case, your site and Trigger.dev.
|
||
|
||
<Steps>
|
||
|
||
<Step title="Install the concurrently package as a dev dependency">
|
||
|
||
<CodeGroup>
|
||
|
||
```bash npm
|
||
npm i concurrently -D
|
||
```
|
||
|
||
```bash pnpm
|
||
pnpm i concurrently -D
|
||
```
|
||
|
||
```bash yarn
|
||
yarn i concurrently -D
|
||
```
|
||
|
||
</CodeGroup>
|
||
|
||
</Step>
|
||
|
||
<Step title="Update your package.json">
|
||
|
||
Then add something like this in your package.json scripts. This assumes you're running Next.js so swap that bit out if you're not:
|
||
|
||
```json
|
||
"scripts": {
|
||
"dev": "concurrently --raw --kill-others npm:dev:*",
|
||
"dev:next": "next dev",
|
||
"dev:trigger": "npx trigger.dev@beta dev",
|
||
//...
|
||
}
|
||
```
|
||
|
||
</Step>
|
||
|
||
</Steps> |