github-featured/triggerdotdev--trigger.dev
2
0
Fork 0
Code Issues Pull Requests Deployments Models Agent Notes Packages Projects Releases Wiki Activity

README updates (#1408)

Browse Source 
* Main README edits

* SDK readme edits

* CLI readme edits

* Create cool-keys-sit.md

---------

Co-authored-by: Eric Allam <eric@trigger.dev>
This commit is contained in:
Dan
2024-10-14 16:39:19 +01:00
committed by GitHub
parent 1c80a74885
commit a6de3f0ff3
4 changed files with 72 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/cool-keys-sit.md
+6
View File
@@ -0,0 +1,6 @@
---
"trigger.dev": patch
"@trigger.dev/sdk": patch
---
README updates
README.md
+21 -6
View File
@@ -15,13 +15,20 @@
## About Trigger.dev
Trigger.dev is an open source platform and SDK which allows you to create long-running background jobs with no timeouts. Write normal async code, deploy, and never hit a timeout.
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.
#### Features:
### Key features:
- JavaScript and TypeScript SDK
- Write reliable code by default
- No timeouts
- Retries (with exponential backoff)
- Queues and concurrency controls
- Schedules and crons
- Full Observability; logs, live trace views, advanced filtering
- Custom alerts, get notified by email, Slack or webhooks
- No infrastructure to manage
- Elastic (scaling)
- Works with your existing tech stack
## In your codebase
@@ -45,7 +52,7 @@ export const helloWorld = task({
## Deployment
Use our SDK to write tasks in your codebase. There's no infrastructure to manage, your tasks automatically scale and connect to our cloud. Or you can always [self-host](https://trigger.dev/docs/v3/open-source-self-hosting#overview).
Use our SDK to write tasks in your codebase. There's no infrastructure to manage, your tasks automatically scale and connect to our cloud. Or you can always self-host.
## Environments
@@ -59,11 +66,19 @@ View every task in every run so you can tell exactly what happened. We provide a
# Getting started
Visit our docs [here](https://trigger.dev/docs/v3/introduction) for a full guide on how to get started with Trigger.dev.
The quickest way to get started is to create an account and project in our [web app](https://cloud.trigger.dev), and follow the instructions in the onboarding. Build and deploy your first task in minutes.
## Self-host
### Useful links:
If you prefer to self-host, you can follow our [self-hosting guide](https://trigger.dev/docs/v3/open-source-self-hosting#overview).
- [Quick start](https://trigger.dev/docs/quick-start) - get up and running in minutes
- [How it works](https://trigger.dev/docs/v3/how-it-works) - understand how Trigger.dev works under the hood
- [Guides and examples](https://trigger.dev/docs/guides/introduction) - walk-through guides and code examples for popular frameworks and use cases
## Self-hosting
If you prefer to self-host Trigger.dev, you can follow our [self-hosting guide](https://trigger.dev/docs/v3/open-source-self-hosting#overview).
We also have a dedicated self-hosting channel in our [Discord server](https://trigger.dev/discord) for support.
## Development
packages/cli-v3/README.md
+13 -40
View File
@@ -6,46 +6,19 @@ Note: this only works with Trigger.dev v3 projects and later. For older projects
Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.
## Usage
## Commands
### Login
| 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. |
| [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |
Logs that machine into Trigger.dev by creating a new Personal Access Token and storing it on the local machine. Once you're logged in you can perform the other actions below.
## Support
```sh
npx trigger.dev@latest login
```
| Option | Short option | Description |
| ----------- | ------------ | -------------------------------------------------------------------- |
| `--api-url` | `-a` | Set the API URL for Trigger.dev, defaults to https://api.trigger.dev |
### Update
Will update all of your @trigger.dev packages in your package.json to the latest version.
```sh
npx trigger.dev@latest update
```
You can pass the path to the folder that your package.json file lives in:
```sh
npx trigger.dev@latest update ./myapp
```
| Option | Short option | Description |
| ------ | ------------ | ---------------------------------------------------------- |
| `--to` | `-t` | The version to update to (ex: 2.1.4), defaults to "latest" |
### Who Am I?
Shows the current user that is logged in.
```sh
npx trigger.dev@latest whoami
```
| Option | Short option | Description |
| ----------- | ------------ | -------------------------------------------------------------------- |
| `--api-url` | `-a` | Set the API URL for Trigger.dev, defaults to https://api.trigger.dev |
If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help.
packages/trigger-sdk/README.md
+32 -1
View File
@@ -1,3 +1,34 @@
<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>
### 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)
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/triggerdotdev.svg?style=social&label=Follow%20%40trigger.dev)](https://twitter.com/triggerdotdev)
</div>
# Official TypeScript SDK for Trigger.dev
View the full documentation for the [here](https://trigger.dev/docs)
The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your project.
## About
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.
## 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.
## SDK usage
For more information on our SDK, refer to our [docs](https://trigger.dev/docs/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.