James Ritchie
972b5e34b8
* WIP creating a CLI section * WIP adding more CLI commands in a new section * New CLI section with introduction and more CLI commands * More improvement to the CLI options * Each CLI command has its own page * fixed broken links * Removed outdated copy
102 lines
2.7 KiB
Plaintext
102 lines
2.7 KiB
Plaintext
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
|
|
|
|
<ParamField body="Config file" type="--config | -c">
|
|
The name of the config file, found at [path].
|
|
</ParamField>
|
|
|
|
<ParamField body="Project ref" type="--project-ref | -p">
|
|
The project ref. Required if there is no config file.
|
|
</ParamField>
|
|
|
|
<ParamField body="Debugger" type="--debugger">
|
|
You can use this 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>
|
|
</ParamField>
|
|
|
|
<ParamField body="Debug OpenTelemetry" type="--debug-otel">
|
|
Enable OpenTelemetry debugging.
|
|
</ParamField>
|
|
|
|
<ParamField body="Skip update check" type="--skip-update-check">
|
|
Skip checking for `@trigger.dev` package updates.
|
|
</ParamField>
|
|
|
|
<ParamField body="Login profile" type="--profile">
|
|
The login profile to use. Defaults to `default`.
|
|
</ParamField>
|
|
|
|
<ParamField body="API URL" type="--api-url | -a">
|
|
Override the API URL. Defaults to `https://api.trigger.dev`.
|
|
</ParamField>
|
|
|
|
<ParamField body="Log level" type="--log-level | -l">
|
|
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This does not affect the log level of your trigger.dev tasks. Defaults to `log`.
|
|
</ParamField>
|
|
|
|
<ParamField body="Skip telemetry" type="--skip-telemetry">
|
|
Opt-out of sending telemetry data.
|
|
</ParamField>
|
|
|
|
## Standard options
|
|
|
|
<ParamField body="Help" type="--help | -h">
|
|
Shows the help information for the command.
|
|
</ParamField>
|
|
|
|
## Concurrently running the terminal
|
|
|
|
Install the concurrently package as a dev dependency:
|
|
|
|
```ts
|
|
concurrently --raw --kill-others npm:dev:remix npm:dev:trigger
|
|
```
|
|
|
|
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",
|
|
//...
|
|
}
|
|
``` |