Files
triggerdotdev--trigger.dev/packages/cli-v3
Eric Allam cf13fbdf32 Updating docs for the move from beta -> latest (with new build system) (#1299)
* Add triggerAndWait().unwrap() to more easily get at the output or throw the subtask error

* Add taskId and runId to SubtaskUnwrapError

* WIP docs update beta -> latest

* trigger.dev init now adds @trigger.dev/build to devDependencies

* How it works doc

* Restructure some docs and update the cli commands

* Config file docs, plus aptGet and ffmpeg extensions

* Update to latest from beta docs

* Add runtime to templates

* Add --runtime option to the init CLI command

* A bunch more doc updates after feedback

* Document triggerAndWait with unwrap and result types

* beta -> latest in the webapp

* CLI update check no longer references beta

* Add major release

* Leave changeset beta, back to normal package release

* Fixed default dirs option in init command

* exclude windows-yarn variation of cli e2e tests because it’s buggy

* Remove cache to try and fix yarn e2e test workflow errors
2024-09-16 15:30:32 +01:00
..
2024-06-28 15:51:17 +01:00

Trigger.dev CLI

A CLI that allows you to create, run locally and deploy Trigger.dev background tasks.

Note: this only works with Trigger.dev v3 projects and later. For older projects use the @trigger.dev/cli package.

Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.

Usage

Login

Logs that machine into Trigger.dev by creating a new Personal Access Token and storing it on the local machine. Once you're logged in you can perform the other actions below.

npx trigger.dev@latest login
Option Short option Description
--api-url -a Set the API URL for Trigger.dev, defaults to https://api.trigger.dev

Update

Will update all of your @trigger.dev packages in your package.json to the latest version.

npx trigger.dev@latest update

You can pass the path to the folder that your package.json file lives in:

npx trigger.dev@latest update ./myapp
Option Short option Description
--to -t The version to update to (ex: 2.1.4), defaults to "latest"

Who Am I?

Shows the current user that is logged in.

npx trigger.dev@latest whoami
Option Short option Description
--api-url -a Set the API URL for Trigger.dev, defaults to https://api.trigger.dev