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
Copy file name to clipboardExpand all lines: packages/cli-v3/README.md
+5-30Lines changed: 5 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,9 @@ A CLI that allows you to create, run locally and deploy Trigger.dev background t
4
4
5
5
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
6
7
-
Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.
7
+
## About Trigger.dev
8
+
9
+
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 trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling.
8
10
9
11
## Commands
10
12
@@ -22,36 +24,9 @@ Trigger.dev is an open source platform that makes it easy to create event-driven
22
24
|[switch](https://trigger.dev/docs/cli-switch)| Switch between CLI profiles. |
23
25
|[update](https://trigger.dev/docs/cli-update-commands)| Updates all `@trigger.dev/*` packages to match the CLI version. |
24
26
25
-
## MCP Server
26
-
27
-
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open protocol that allows you to provide custom tools
28
-
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...
29
-
30
-
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
31
-
it to trigger tasks via natural language, view task runs, view logs, debug issues with task runs, etc...
32
-
33
-
### Starting the Trigger.dev MCP Server
34
-
35
-
To start the Trigger.dev MCP server, simply pass the `--mcp` flag to the `dev` command:
36
-
37
-
```bash
38
-
trigger dev --mcp
39
-
```
40
-
41
-
By default it runs on port `3333`. You can change this by passing the `--mcp-port` flag:
42
-
43
-
```bash
44
-
trigger dev --mcp --mcp-port 3334
45
-
```
46
-
47
-
### Configuring your MCP client
48
-
49
-
This depends on what tool you are using. For Cursor, the configuration is in the [.cursor/mcp.json](../../.cursor/mcp.json) file
50
-
and should be good to go as long as you use the default MCP server port.
51
-
52
-
Check out [Cursor's docs](https://docs.cursor.com/context/model-context-protocol) for further details.
27
+
## Documentation
53
28
54
-
Tip: try out [Cursor's YOLO mode](https://docs.cursor.com/context/model-context-protocol#yolo-mode) for a seamless experience :D
29
+
For more information on the CLI, please refer to our [docs](https://trigger.dev/docs/cli-introduction).
Copy file name to clipboardExpand all lines: packages/trigger-sdk/README.md
+20-3Lines changed: 20 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,15 +18,32 @@
18
18
19
19
# Official TypeScript SDK for Trigger.dev
20
20
21
-
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.
22
22
23
23
## About Trigger.dev
24
24
25
-
Trigger.dev is a 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 trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling.
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 trace visibility, 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
26
40
27
41
## Getting started
28
42
29
-
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.
0 commit comments