UNPKG

trigger.dev

Version:

A Command-Line Interface for Trigger.dev projects

52 lines (37 loc) 4.2 kB
<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"> <img alt="Trigger.dev logo" src="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public"> </picture> [![npm version](https://img.shields.io/npm/v/trigger.dev.svg)](https://www.npmjs.com/package/trigger.dev) [![npm downloads](https://img.shields.io/npm/dm/trigger.dev.svg)](https://www.npmjs.com/package/trigger.dev) [![GitHub stars](https://img.shields.io/github/stars/triggerdotdev/trigger.dev?style=social)](https://github.com/triggerdotdev/trigger.dev) [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/) [![License: ](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Open Source](https://img.shields.io/badge/Open%20Source-%E2%9D%A4-red)](https://github.com/triggerdotdev/trigger.dev) [Discord](https://trigger.dev/discord) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger.dev/docs) | [Examples](https://trigger.dev/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](https://www.npmjs.com/package/@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 | Command | Description | | :------------------------------------------------------------------- | :----------------------------------------------------------------- | | [login](https://trigger.dev/docs/cli-login-commands) | Login with Trigger.dev so you can perform authenticated actions. | | [init](https://trigger.dev/docs/cli-init-commands) | Initialize your existing project for development with Trigger.dev. | | [dev](https://trigger.dev/docs/cli-dev-commands) | Run your Trigger.dev tasks locally. | | [deploy](https://trigger.dev/docs/cli-deploy-commands) | Deploy your Trigger.dev v3 project to the cloud. | | [whoami](https://trigger.dev/docs/cli-whoami-commands) | Display the current logged in user and project details. | | [logout](https://trigger.dev/docs/cli-logout-commands) | Logout of Trigger.dev. | | [list-profiles](https://trigger.dev/docs/cli-list-profiles-commands) | List all of your CLI profiles. | | [preview archive](https://trigger.dev/docs/cli-preview-archive) | Archive a preview branch. | | [promote](https://trigger.dev/docs/cli-promote-commands) | Promote a previously deployed version to the current version. | | [switch](https://trigger.dev/docs/cli-switch) | Switch between CLI profiles. | | [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. | ## CLI documentation For more information on the CLI, please refer to our [docs](https://trigger.dev/docs/cli-introduction). ## Support If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help.