Files
triggerdotdev--trigger.dev/packages/cli-v3
Eric Allam ba71f959e2 v3: Runs List Management SDK and SDK improvements (#1133)
* Improved the existing runs API

* WIP next runs API

* Improve the returned ApiPromise to add ability to return response

* More WIP

* WI{

* Added offset/limit pagination stuff like the cursor one, and converted all API methods to use ApiPromise

* More run API stuff

- Adding schedule  output from the retrieveRun endpoint
- Ability to filter by schedule and isTest

* Remove env from retrieve run in openAPI

* prefer duplication over merge

* WIP docs

* Use spread to DRY up some run API schemas

* Finish the overview docs

* Adding changeset

* Fixed typecheck errors

* Typo fix

* Re-export zodfetch from core so the v3 CLI can use it

* Fixed type errors

---------

Co-authored-by: Matt Aitken <matt@mattaitken.com>
2024-05-31 11:02:28 +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