Back to Trigger

Trigger.dev CLI

packages/cli-v3/README.md

4.4.54.1 KB
Original Source
<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public"> <source media="(prefers-color-scheme: light)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/3f5ad4c1-c4c8-4277-b622-290e7f37bd00/public"> </picture>

Discord | Website | Issues | Docs | Examples

</div>

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.

About Trigger.dev

Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with full observability, managed queues, and elastic infrastructure which handles the horizontal scaling.

Commands

CommandDescription
loginLogin with Trigger.dev so you can perform authenticated actions.
initInitialize your existing project for development with Trigger.dev.
devRun your Trigger.dev tasks locally.
deployDeploy your Trigger.dev v3 project to the cloud.
whoamiDisplay the current logged in user and project details.
logoutLogout of Trigger.dev.
list-profilesList all of your CLI profiles.
preview archiveArchive a preview branch.
promotePromote a previously deployed version to the current version.
switchSwitch between CLI profiles.
updateUpdates all @trigger.dev/* packages to match the CLI version.

CLI documentation

For more information on the CLI, please refer to our docs.

Support

If you have any questions, please reach out to us on Discord and we'll be happy to help.