Updated readmes (#2408)
* readme wip * Added new commands * Simplified readme * Added docs links and improved about * Added nice header and updated links * Consistent headers * Copy update
This commit is contained in:
Dan
+26
-30
@@ -1,10 +1,30 @@
|
||||
<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>
|
||||
|
||||
[](https://www.npmjs.com/package/trigger.dev)
|
||||
[](https://www.npmjs.com/package/trigger.dev)
|
||||
[](https://github.com/triggerdotdev/trigger.dev)
|
||||
[](https://www.typescriptlang.org/)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](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.
|
||||
|
||||
Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.
|
||||
## 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
|
||||
|
||||
@@ -17,38 +37,14 @@ Trigger.dev is an open source platform that makes it easy to create event-driven
|
||||
| [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. |
|
||||
|
||||
## MCP Server
|
||||
## CLI documentation
|
||||
|
||||
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open protocol that allows you to provide custom tools
|
||||
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...
|
||||
|
||||
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
|
||||
it to trigger tasks via natural language, view task runs, view logs, debug issues with task runs, etc...
|
||||
|
||||
### Starting the Trigger.dev MCP Server
|
||||
|
||||
To start the Trigger.dev MCP server, simply pass the `--mcp` flag to the `dev` command:
|
||||
|
||||
```bash
|
||||
trigger dev --mcp
|
||||
```
|
||||
|
||||
By default it runs on port `3333`. You can change this by passing the `--mcp-port` flag:
|
||||
|
||||
```bash
|
||||
trigger dev --mcp --mcp-port 3334
|
||||
```
|
||||
|
||||
### Configuring your MCP client
|
||||
|
||||
This depends on what tool you are using. For Cursor, the configuration is in the [.cursor/mcp.json](../../.cursor/mcp.json) file
|
||||
and should be good to go as long as you use the default MCP server port.
|
||||
|
||||
Check out [Cursor's docs](https://docs.cursor.com/context/model-context-protocol) for further details.
|
||||
|
||||
Tip: try out [Cursor's YOLO mode](https://docs.cursor.com/context/model-context-protocol#yolo-mode) for a seamless experience :D
|
||||
For more information on the CLI, please refer to our [docs](https://trigger.dev/docs/cli-introduction).
|
||||
|
||||
## Support
|
||||
|
||||
|
||||
@@ -4,28 +4,48 @@
|
||||
<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>
|
||||
|
||||
### Open source background jobs with no timeouts
|
||||
|
||||
[Discord](https://trigger.dev/discord) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger.dev/docs)
|
||||
[](https://www.npmjs.com/package/@trigger.dev/sdk)
|
||||
[](https://www.npmjs.com/package/@trigger.dev/sdk)
|
||||
[](https://github.com/triggerdotdev/trigger.dev)
|
||||
[](https://www.typescriptlang.org/)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://github.com/triggerdotdev/trigger.dev)
|
||||
|
||||
[](https://twitter.com/triggerdotdev)
|
||||
[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>
|
||||
|
||||
# Official TypeScript SDK for Trigger.dev
|
||||
|
||||
The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your project.
|
||||
The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your projects.
|
||||
|
||||
## About
|
||||
## About Trigger.dev
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Core features
|
||||
|
||||
- Task creation and execution
|
||||
- CLI for development and deployment
|
||||
- Build system with extensions
|
||||
- Management API for runs, schedules, and environment variables
|
||||
|
||||
## Key Components:
|
||||
|
||||
- Tasks: Background jobs written in TypeScript/JavaScript
|
||||
- CLI: Commands for login, init, dev, deploy
|
||||
- Build Extensions: Customize builds (Prisma, Python, FFmpeg, etc.)
|
||||
- Management API: Programmatic control over runs and resources
|
||||
|
||||
## Getting started
|
||||
|
||||
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.
|
||||
There are two ways to get started:
|
||||
|
||||
## SDK usage
|
||||
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.
|
||||
2. [Manual setup](https://trigger.dev/docs/manual-setup) in your existing project.
|
||||
|
||||
## SDK documentation
|
||||
|
||||
For more information on our SDK, refer to our [docs](https://trigger.dev/docs/introduction).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user