James Ritchie
fade22015f
* Adds new features table to top of v4 upgrade guide * Adds wait idempotency to wait-until, wait-for, and wait-for-token pages * Adds new priority docs page and updates the v4 upgrade guide * Adds new task lifecycle hooks * Removes the message about requiring tasks to be exported * Adds new global lifecycle hooks section * Moves sections from upgrade guide into the table * Adds hidden task page * Improves the global lifecycle hooks section * Updates middleware and locals section * Adds new useWaitToken page to the react hooks section * Adds a new ai.tool section * Moves Docker (legacy) page into self-hosting section * Removes known issues from v4 upgrade guide * Replace “toolTask” with “ai.tool” in the Streams page example * Renames guide to “Migrating from v3” and adds redirect * Remove references to v4 * Removes changelog from migration guide * The installation guide now references `@latest update` * Changes all references from `/sdk/v3` to `/sdk` * Updates @v4-beta to @latest * Fixed broken link * Fixes broken link * Adds an upgrade to v4 using AI section * Fixes 2 broken links * Adds an entry for targetting preview branches * Updates the run statuses * Adds boolean helpers section to the runs and realtime pages * Updates the concurrency page * Updates the test page to include the new options * Adds SDK and curl options for the preview branch targeting * Updates new bulk actions page * Remove the releasing concurrency section * Got rid of some more @v4-beta mentions * Improved rate limit docs * Improved migrating docs * Removed commented sections of the docs * useWaitToken hook * Fixed the description * Fix for missing test image --------- Co-authored-by: Matt Aitken <matt@mattaitken.com> Co-authored-by: Dan <8297864+D-K-P@users.noreply.github.com>
47 lines
1020 B
Plaintext
47 lines
1020 B
Plaintext
---
|
|
title: Overview
|
|
sidebarTitle: Overview
|
|
description: Using the Trigger.dev management API
|
|
---
|
|
|
|
## Installation
|
|
|
|
The management API is available through the same `@trigger.dev/sdk` package used in defining and triggering tasks. If you have already installed the package in your project, you can skip this step.
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npm i @trigger.dev/sdk@latest
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm add @trigger.dev/sdk@latest
|
|
```
|
|
|
|
```bash yarn
|
|
yarn add @trigger.dev/sdk@latest
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
## Usage
|
|
|
|
All `v3` functionality is provided through the `@trigger.dev/sdk` module. You can import the entire module or individual resources as needed.
|
|
|
|
```ts
|
|
import { configure, runs } from "@trigger.dev/sdk";
|
|
|
|
configure({
|
|
// this is the default and if the `TRIGGER_SECRET_KEY` environment variable is set, can omit calling configure
|
|
secretKey: process.env["TRIGGER_SECRET_KEY"],
|
|
});
|
|
|
|
async function main() {
|
|
const runs = await runs.list({
|
|
limit: 10,
|
|
status: ["COMPLETED"],
|
|
});
|
|
}
|
|
|
|
main().catch(console.error);
|
|
``` |