@trigger.dev/sdk 0.0.0-python-preview-20250226140121 → 0.0.0-rc-4-8-0-20261021151928

package/docs/cli-list-profiles-commands.mdx

@@ -0,0 +1,42 @@
+---
+title: "CLI list-profiles command"
+sidebarTitle: "list-profiles"
+description: "Use these options when using the `list-profiles` CLI command."
+---
+
+import LogLevelOption from "/snippets/cli-options-log-level.mdx";
+import SkipTelemetryOption from "/snippets/cli-options-skip-telemetry.mdx";
+import HelpOption from "/snippets/cli-options-help.mdx";
+import VersionOption from "/snippets/cli-options-version.mdx";
+
+Run the command like this:
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest list-profiles
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest list-profiles
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest list-profiles
+```
+
+</CodeGroup>
+
+## Options
+
+### Common options
+
+These options are available on most commands.
+
+<LogLevelOption />
+
+<SkipTelemetryOption />
+
+<HelpOption />
+
+<VersionOption />

package/docs/cli-login-commands.mdx

@@ -0,0 +1,53 @@
+---
+title: "CLI login command"
+sidebarTitle: "login"
+description: "Use these options when logging in to Trigger.dev using the CLI."
+---
+
+import CommonOptions from '/snippets/cli-options-common.mdx';
+
+Run the command like this:
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest login
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest login
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest login
+```
+
+</CodeGroup>
+
+## Options
+
+<ParamField body="No browser" type="--no-browser">
+  Do not open the browser. Print the URL only.
+</ParamField>
+
+<ParamField body="Email" type="--email <email>">
+  Prefill the email on the login page.
+</ParamField>
+
+<ParamField body="Name" type="--name <name>">
+  Set your name after authorization. Only applies to a new account that has not set its details yet.
+</ParamField>
+
+<ParamField body="Cancel pending" type="--cancel-pending">
+  Cancel a pending login and keep the current account.
+</ParamField>
+
+<ParamField body="No wait" type="--no-wait">
+  Save the authorization and exit so login can be resumed later.
+</ParamField>
+
+### Common options
+
+These options are available on most commands.
+
+<CommonOptions />

package/docs/cli-logout-commands.mdx

@@ -0,0 +1,33 @@
+---
+title: "CLI logout command"
+sidebarTitle: "logout"
+description: "Use these options when using the `logout` CLI command."
+---
+
+import CommonOptions from '/snippets/cli-options-common.mdx';
+
+Run the command like this:
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest logout
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest logout
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest logout
+```
+
+</CodeGroup>
+
+## Options
+
+### Common options
+
+These options are available on most commands.
+
+<CommonOptions />

package/docs/cli-preview-archive.mdx

@@ -0,0 +1,59 @@
+---
+title: "CLI preview archive command"
+sidebarTitle: "preview archive"
+description: "The `trigger.dev preview archive` command can be used to archive a preview branch."
+---
+
+import ProjectPathArg from "/snippets/cli-args-project-path.mdx";
+import CommonOptions from "/snippets/cli-options-common.mdx";
+import ProjectRefOption from "/snippets/cli-options-project-ref.mdx";
+import EnvFileOption from "/snippets/cli-options-env-file.mdx";
+import ConfigFileOption from "/snippets/cli-options-config-file.mdx";
+import SkipUpdateCheckOption from "/snippets/cli-options-skip-update-check.mdx";
+import BranchOption from "/snippets/cli-options-branch.mdx";
+
+Run the command like this:
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest preview archive
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest preview archive
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest preview archive
+```
+
+</CodeGroup>
+
+It will archive the preview branch, automatically detecting the branch name from git. You can manually specify the branch using the `--branch` option.
+
+## Arguments
+
+```
+npx trigger.dev@latest preview archive [path]
+```
+
+<ProjectPathArg />
+
+## Options
+
+<BranchOption />
+
+<ConfigFileOption />
+
+<ProjectRefOption />
+
+<EnvFileOption />
+
+<SkipUpdateCheckOption />
+
+### Common options
+
+These options are available on most commands.
+
+<CommonOptions />

package/docs/cli-projects-commands.mdx

@@ -0,0 +1,74 @@
+---
+title: "CLI projects commands"
+sidebarTitle: "projects"
+description: "List, create, inspect, and rename Trigger.dev projects from the terminal."
+---
+
+import CommonOptions from "/snippets/cli-options-common.mdx";
+
+These commands act on the organizations and projects your account can access, so run
+[`login`](/cli-login-commands) first.
+
+## projects create
+
+Creates a project. You are prompted for the organization and name when the options are omitted.
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest projects create
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest projects create
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest projects create
+```
+
+</CodeGroup>
+
+<ParamField body="Organization" type="--org | -o">
+  The organization slug or ID to create the project in.
+</ParamField>
+
+<ParamField body="Name" type="--name | -n">
+  The name of the new project.
+</ParamField>
+
+## projects list
+
+Lists your projects with the runtime and version of their current Production deployment.
+
+```bash
+npx trigger.dev@latest projects list
+```
+
+<ParamField body="Needs update" type="--needs-update">
+  Only show projects using Node.js 21 in Production.
+</ParamField>
+
+## projects get
+
+Prints the name, ref, slug, organization, default runtime and region of a project.
+
+```bash
+npx trigger.dev@latest projects get proj_abc123
+```
+
+## projects rename
+
+Renames a project. The project ref does not change.
+
+```bash
+npx trigger.dev@latest projects rename proj_abc123 "My new name"
+```
+
+## Options
+
+### Common options
+
+These options are available on most commands.
+
+<CommonOptions />

package/docs/cli-promote-commands.mdx

@@ -0,0 +1,9 @@
+---
+title: "CLI promote command"
+sidebarTitle: "promote"
+description: "Use the promote command to promote a previously deployed version to the current version."
+---
+
+import CliPromoteCommands from "/snippets/cli-commands-promote.mdx";
+
+<CliPromoteCommands />

package/docs/cli-runs-commands.mdx

@@ -0,0 +1,95 @@
+---
+title: "CLI runs commands"
+sidebarTitle: "runs"
+description: "Use these commands to list, inspect, replay and cancel runs from your terminal."
+---
+
+import CommonOptions from "/snippets/cli-options-common.mdx";
+import ConfigFileOptions from "/snippets/cli-options-config-file.mdx";
+import ProjectRefOptions from "/snippets/cli-options-project-ref.mdx";
+
+## runs list
+
+Lists runs, newest first, in a table of ID, task, status, version, created time and duration.
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest runs list
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest runs list
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest runs list
+```
+
+</CodeGroup>
+
+<ParamField body="Limit" type="--limit">
+  The number of runs to list, up to 100. Defaults to 20.
+</ParamField>
+
+<ParamField body="Status" type="--status">
+  Only show runs with this status, e.g. `FAILED`.
+</ParamField>
+
+<ParamField body="Task" type="--task">
+  Only show runs for this task identifier.
+</ParamField>
+
+<ParamField body="Tag" type="--tag">
+  Only show runs with this tag.
+</ParamField>
+
+<ParamField body="Cursor" type="--cursor">
+  The pagination cursor printed at the end of the previous page.
+</ParamField>
+
+## runs get
+
+Prints the status, version, tags, timings, duration, cost and error of a single run.
+
+```bash
+npx trigger.dev@latest runs get run_abc123
+```
+
+## runs replay
+
+Triggers a new run with the same payload as an existing one, using the latest version of the task.
+
+```bash
+npx trigger.dev@latest runs replay run_abc123
+```
+
+## runs cancel
+
+Cancels a run that has not finished yet. You are asked to confirm first.
+
+```bash
+npx trigger.dev@latest runs cancel run_abc123
+```
+
+<ParamField body="Skip confirmation" type="--yes | -y">
+  Cancel without the confirmation prompt. Required in non-interactive environments such as CI.
+</ParamField>
+
+## Options
+
+<ParamField body="Environment" type="--env | -e">
+  The environment to use: `dev`, `prod`, `staging` or `preview`. Defaults to `prod`.
+</ParamField>
+
+<ConfigFileOptions />
+<ProjectRefOptions />
+<ParamField body="Branch" type="--branch | -b">
+  Required when using `--env preview`. Specify the branch, e.g. `--branch my-branch` or `-b my-branch`. With `--env dev`, it defaults to the same [dev branch](/deployment/dev-branches) as the dev command.
+</ParamField>
+
+### Common options
+
+These options are available on most commands.
+
+<CommonOptions />

package/docs/cli-switch.mdx

@@ -0,0 +1,43 @@
+---
+title: "CLI switch command"
+sidebarTitle: "switch"
+description: "The `trigger.dev switch` command can be used to switch between profiles."
+---
+
+import ProjectPathArg from "/snippets/cli-args-project-path.mdx";
+import CommonOptions from "/snippets/cli-options-common.mdx";
+import ProjectRefOption from "/snippets/cli-options-project-ref.mdx";
+import EnvFileOption from "/snippets/cli-options-env-file.mdx";
+import ConfigFileOption from "/snippets/cli-options-config-file.mdx";
+import SkipUpdateCheckOption from "/snippets/cli-options-skip-update-check.mdx";
+import BranchOption from "/snippets/cli-options-branch.mdx";
+
+Run the command like this:
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest switch [profile]
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest switch [profile]
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest switch [profile]
+```
+
+</CodeGroup>
+
+It will switch to the specified profile. If no profile is specified, it will list all available profiles and run interactively.
+
+## Arguments
+
+```
+npx trigger.dev@latest switch [profile]
+```
+
+<ParamField body="Profile" type="[profile]">
+  The profile to switch to. If not specified, it will list all available profiles and run interactively.
+</ParamField>

package/docs/cli-tasks-commands.mdx

@@ -0,0 +1,95 @@
+---
+title: "CLI tasks commands"
+sidebarTitle: "tasks"
+description: "Use these commands to trigger tasks from your terminal."
+---
+
+import CommonOptions from "/snippets/cli-options-common.mdx";
+import ConfigFileOptions from "/snippets/cli-options-config-file.mdx";
+import ProjectRefOptions from "/snippets/cli-options-project-ref.mdx";
+
+## tasks trigger
+
+Triggers a task and prints the run ID and its dashboard URL. It runs in the `dev` environment unless you pass `--env`, so start the [dev command](/cli-dev-commands) first.
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest tasks trigger hello-world --payload '{"name":"Ada"}'
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest tasks trigger hello-world --payload '{"name":"Ada"}'
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest tasks trigger hello-world --payload '{"name":"Ada"}'
+```
+
+</CodeGroup>
+
+Add `--wait` to wait for the run to finish. It prints the run's output, or its error and exits with code 1 if the run failed, which makes it useful in scripts and for coding agents testing a task:
+
+```bash
+npx trigger.dev@latest tasks trigger hello-world --payload '{"name":"Ada"}' --wait
+```
+
+The command fails without creating a run if the current version has no task with that ID. In `dev`, it warns you when the dev command isn't running, because the run waits in the queue until it starts.
+
+<ParamField body="Payload" type="--payload">
+  The payload as JSON, e.g. `--payload '{"name":"Ada"}'`. Without it, the task gets no payload.
+</ParamField>
+
+<ParamField body="Payload file" type="--payload-file">
+  Read the payload from a JSON file instead.
+</ParamField>
+
+<ParamField body="Wait" type="--wait">
+  Wait for the run to finish, then print its output or error.
+</ParamField>
+
+<ParamField body="Timeout" type="--timeout">
+  With `--wait`, stop waiting after this many seconds and exit with code 1.
+</ParamField>
+
+<ParamField body="Tag" type="--tag">
+  A tag to add to the run. Repeat it to add more than one, e.g. `--tag cli --tag test`.
+</ParamField>
+
+<ParamField body="Idempotency key" type="--idempotency-key">
+  If a run with this key already exists, return it instead of creating a new one. See [idempotency](/idempotency).
+</ParamField>
+
+<ParamField body="Delay" type="--delay">
+  Wait before running, e.g. `30s`, `5m` or an ISO 8601 date.
+</ParamField>
+
+<ParamField body="TTL" type="--ttl">
+  Expire the run if it hasn't started within this time, e.g. `10m`.
+</ParamField>
+
+<ParamField body="Queue" type="--queue">
+  The queue to run in, instead of the queue set on the task.
+</ParamField>
+
+<ParamField body="Machine" type="--machine">
+  The machine to run on, e.g. `small-2x`. See [machines](/machines). Has no effect in `dev`.
+</ParamField>
+
+## Options
+
+<ParamField body="Environment" type="--env | -e">
+  The environment to use: `dev`, `prod`, `staging` or `preview`. Defaults to `dev`.
+</ParamField>
+
+<ConfigFileOptions />
+<ProjectRefOptions />
+<ParamField body="Branch" type="--branch | -b">
+  The branch to use. Required with `--env preview`. In `dev`, it defaults to the same [dev branch](/deployment/dev-branches) as the dev command.
+</ParamField>
+
+### Common options
+
+These options are available on most commands.
+
+<CommonOptions />

package/docs/cli-update-commands.mdx

@@ -0,0 +1,48 @@
+---
+title: "CLI update command"
+sidebarTitle: "update"
+description: "Use these options when using the `update` CLI command."
+---
+
+import LogLevelOption from "/snippets/cli-options-log-level.mdx";
+import SkipTelemetryOption from "/snippets/cli-options-skip-telemetry.mdx";
+import HelpOption from "/snippets/cli-options-help.mdx";
+import VersionOption from "/snippets/cli-options-version.mdx";
+
+Run the command like this:
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest update [path]
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest update [path]
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest update [path]
+```
+
+</CodeGroup>
+
+## Arguments
+
+<ParamField body="Project path" type="[path]">
+  The directory that contains the `package.json` file. Defaults to `.`.
+</ParamField>
+
+## Options
+
+### Common options
+
+These options are available on most commands.
+
+<LogLevelOption />
+
+<SkipTelemetryOption />
+
+<HelpOption />
+
+<VersionOption />

package/docs/cli-whoami-commands.mdx

@@ -0,0 +1,45 @@
+---
+title: "CLI whoami command"
+sidebarTitle: "whoami"
+description: "Use these options to display the current logged in user and project details."
+---
+
+import CommonOptions from '/snippets/cli-options-common.mdx';
+
+Run the command like this:
+
+<CodeGroup>
+
+```bash npm
+npx trigger.dev@latest whoami
+```
+
+```bash pnpm
+pnpm dlx trigger.dev@latest whoami
+```
+
+```bash yarn
+yarn dlx trigger.dev@latest whoami
+```
+
+</CodeGroup>
+
+## Options
+
+<ParamField body="Config file" type="-c, --config <config file>">
+  The name of the config file.
+</ParamField>
+
+<ParamField body="Project ref" type="-p, --project-ref <project ref>">
+  The project ref. Overrides the project in the config file.
+</ParamField>
+
+<ParamField body="Env file" type="--env-file <env file>">
+  Path to a `.env` file to read `TRIGGER_PROJECT_REF` from. Defaults to `.env`, `.env.development`, `.env.local`, `.env.development.local` and `dev.vars` in the current directory.
+</ParamField>
+
+### Common options
+
+These options are available on most commands.
+
+<CommonOptions />

package/docs/community.mdx

@@ -0,0 +1,6 @@
+---
+title: "Discord Community"
+url: "https://trigger.dev/discord"
+---
+
+Please [join our community on Discord](https://trigger.dev/discord) to ask questions, share your projects, and get help from other developers.