You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A CLI that allows you to create, run locally and deploy Trigger.dev background tasks.
4
22
5
23
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.
6
24
7
-
Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.
25
+
## About Trigger.dev
26
+
27
+
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.
8
28
9
29
## Commands
10
30
@@ -17,38 +37,14 @@ Trigger.dev is an open source platform that makes it easy to create event-driven
17
37
|[whoami](https://trigger.dev/docs/cli-whoami-commands)| Display the current logged in user and project details. |
18
38
|[logout](https://trigger.dev/docs/cli-logout-commands)| Logout of Trigger.dev. |
19
39
|[list-profiles](https://trigger.dev/docs/cli-list-profiles-commands)| List all of your CLI profiles. |
40
+
|[preview archive](https://trigger.dev/docs/cli-preview-archive)| Archive a preview branch. |
41
+
|[promote](https://trigger.dev/docs/cli-promote-commands)| Promote a previously deployed version to the current version. |
42
+
|[switch](https://trigger.dev/docs/cli-switch)| Switch between CLI profiles. |
20
43
|[update](https://trigger.dev/docs/cli-update-commands)| Updates all `@trigger.dev/*` packages to match the CLI version. |
21
44
22
-
## MCP Server
23
-
24
-
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open protocol that allows you to provide custom tools
25
-
to agentic LLM clients, like [Claude for Desktop](https://docs.anthropic.com/en/docs/claude-for-desktop/overview), [Cursor](https://www.cursor.com/), [Windsurf](https://windsurf.com/), etc...
26
-
27
-
The Trigger.dev CLI can expose an MCP server and enable you interact with Trigger.dev in agentic LLM workflows. For example, you can use
28
-
it to trigger tasks via natural language, view task runs, view logs, debug issues with task runs, etc...
29
-
30
-
### Starting the Trigger.dev MCP Server
31
-
32
-
To start the Trigger.dev MCP server, simply pass the `--mcp` flag to the `dev` command:
33
-
34
-
```bash
35
-
trigger dev --mcp
36
-
```
37
-
38
-
By default it runs on port `3333`. You can change this by passing the `--mcp-port` flag:
39
-
40
-
```bash
41
-
trigger dev --mcp --mcp-port 3334
42
-
```
43
-
44
-
### Configuring your MCP client
45
-
46
-
This depends on what tool you are using. For Cursor, the configuration is in the [.cursor/mcp.json](../../.cursor/mcp.json) file
47
-
and should be good to go as long as you use the default MCP server port.
48
-
49
-
Check out [Cursor's docs](https://docs.cursor.com/context/model-context-protocol) for further details.
45
+
## CLI documentation
50
46
51
-
Tip: try out [Cursor's YOLO mode](https://docs.cursor.com/context/model-context-protocol#yolo-mode) for a seamless experience :D
47
+
For more information on the CLI, please refer to our [docs](https://trigger.dev/docs/cli-introduction).
The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your project.
21
+
The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your projects.
19
22
20
-
## About
23
+
## About Trigger.dev
21
24
22
-
Trigger.dev is an open source platform and SDK which allows you to create long-running background jobs. Write normal async code, deploy, and never hit a timeout.
25
+
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.
26
+
27
+
## Core features
28
+
29
+
- Task creation and execution
30
+
- CLI for development and deployment
31
+
- Build system with extensions
32
+
- Management API for runs, schedules, and environment variables
33
+
34
+
## Key Components:
35
+
36
+
- Tasks: Background jobs written in TypeScript/JavaScript
- Management API: Programmatic control over runs and resources
23
40
24
41
## Getting started
25
42
26
-
The quickest way to get started is to create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes.
43
+
There are two ways to get started:
44
+
45
+
1. Create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes.
46
+
2.[Manual setup](https://trigger.dev/docs/manual-setup) in your existing project.
27
47
28
-
## SDK usage
48
+
## SDK documentation
29
49
30
50
For more information on our SDK, refer to our [docs](https://trigger.dev/docs/introduction).
0 commit comments