Skip to content

Commit a3869e8

Browse files
isshaddadTrigger.dev RepoOps
isshaddad
authored and
Trigger.dev RepoOps
committed
docs: fix inaccuracies in CLI, config and deployment pages
Corrects the CLI, config, deployment and troubleshooting docs where they had drifted from the CLI and SDK. - CLI commands: adds missing options and arguments for `init`, `dev`, `deploy`, `promote`, `login`, `whoami`, `update`, `projects` and `env` (including `--branch` for preview environments), fixes wrong defaults, and renames `--force-local-build` to `--local-build`. - Build extensions: adds the missing extensions to the overview, fixes the Python `requirements` option, the Prisma binary target, Puppeteer imports and examples, and the `syncEnvVars` context and options. - Deployment: covers the GitHub integration as a deploy path, and points the Vercel snippet at the official Vercel integration. - Alerts, query and private networking: adds missing webhook fields, Query columns and tables, and fixes setup details. - Fixes broken links and anchors across these pages and a few guides. Mono-RevId: ce51189e8fc1d41ad566db57609f162b85c1e6a3
1 parent 5fab463 commit a3869e8

42 files changed

Lines changed: 314 additions & 84 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/cli-env-commands.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ description: "List, get, set, and pull environment variables for a Trigger.dev p
77
import CommonOptions from "/snippets/cli-options-common.mdx";
88
import ConfigFileOptions from "/snippets/cli-options-config-file.mdx";
99
import ProjectRefOptions from "/snippets/cli-options-project-ref.mdx";
10-
import BranchOptions from "/snippets/cli-options-branch.mdx";
1110

1211
These commands manage environment variables on a project environment. They default to `prod`. Use `--env staging` or `--env preview` (with `--branch`) for the other environments. There is no `dev` target: local `trigger dev` reads your local `.env`.
1312

@@ -82,7 +81,7 @@ npx trigger.dev@latest env set STRIPE_KEY sk_live_abc --secret
8281

8382
## env pull
8483

85-
Writes the project's environment variables to a local file. Defaults to `.env.local`. Fails if the file already exists unless you pass `--force`.
84+
Writes the project's environment variables to a local file. Defaults to `.env.local`. Asks you to confirm before overwriting an existing file unless you pass `--force`. `TRIGGER_` system variables are omitted.
8685

8786
```bash
8887
npx trigger.dev@latest env pull
@@ -94,7 +93,7 @@ npx trigger.dev@latest env pull --output .env.trigger --force
9493
</ParamField>
9594

9695
<ParamField body="Force" type="--force">
97-
Overwrite the output file if it exists.
96+
Overwrite the output file if it exists, without asking.
9897
</ParamField>
9998

10099
## Options
@@ -105,7 +104,9 @@ npx trigger.dev@latest env pull --output .env.trigger --force
105104

106105
<ConfigFileOptions />
107106
<ProjectRefOptions />
108-
<BranchOptions />
107+
<ParamField body="Preview branch" type="--branch | -b">
108+
Required when using `--env preview`. Specify the branch, e.g. `--branch my-branch` or `-b my-branch`.
109+
</ParamField>
109110

110111
### Common options
111112

‎docs/cli-init-commands.mdx‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ yarn dlx trigger.dev@latest init
2424

2525
</CodeGroup>
2626

27+
## Arguments
28+
29+
<ParamField body="Project path" type="[path]">
30+
The path to the project. Defaults to `.`.
31+
</ParamField>
32+
2733
## Options
2834

2935
<ParamField body="Javascript" type="--javascript">
@@ -36,7 +42,7 @@ yarn dlx trigger.dev@latest init
3642
</ParamField>
3743

3844
<ParamField body="Package tag" type="--tag | -t">
39-
The version of the `@trigger.dev/sdk` package to install. Defaults to `latest`.
45+
The version of the `@trigger.dev/sdk` package to install. Defaults to the CLI version.
4046
</ParamField>
4147

4248
<ParamField body="Skip package install" type="--skip-package-install">
@@ -47,6 +53,26 @@ yarn dlx trigger.dev@latest init
4753
Override the existing config file if it exists.
4854
</ParamField>
4955

56+
<ParamField body="Project name" type="--project-name <name>">
57+
The name of the project to create when your account has no projects yet.
58+
</ParamField>
59+
60+
<ParamField body="Organization name" type="--org-name <name>">
61+
The organization to create the first project in. Matches an existing organization by name, or creates it if you have none.
62+
</ParamField>
63+
64+
<ParamField body="Runtime" type="-r, --runtime <runtime>">
65+
The runtime to use: `node`, `node-22`, `node-24`, `node-26` or `bun`. Defaults to `node-24`.
66+
</ParamField>
67+
68+
<ParamField body="Yes" type="-y, --yes">
69+
Skip all prompts. Requires `--project-ref`, or `--project-name` with `--org-name` for a new account.
70+
</ParamField>
71+
72+
<ParamField body="No browser" type="--no-browser">
73+
Do not open the browser during login. Print the URL only.
74+
</ParamField>
75+
5076
<ParamField body="Package arguments" type="--pkg-args">
5177
Additional arguments to pass to the package manager. Accepts CSV for multiple args.
5278
</ParamField>

‎docs/cli-login-commands.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,26 @@ yarn dlx trigger.dev@latest login
2626

2727
## Options
2828

29+
<ParamField body="No browser" type="--no-browser">
30+
Do not open the browser. Print the URL only.
31+
</ParamField>
32+
33+
<ParamField body="Email" type="--email <email>">
34+
Prefill the email on the login page.
35+
</ParamField>
36+
37+
<ParamField body="Name" type="--name <name>">
38+
Set your name after authorization. Only applies to a new account that has not set its details yet.
39+
</ParamField>
40+
41+
<ParamField body="Cancel pending" type="--cancel-pending">
42+
Cancel a pending login and keep the current account.
43+
</ParamField>
44+
45+
<ParamField body="No wait" type="--no-wait">
46+
Save the authorization and exit so login can be resumed later.
47+
</ParamField>
48+
2949
### Common options
3050

3151
These options are available on most commands.

‎docs/cli-projects-commands.mdx‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "CLI projects commands"
33
sidebarTitle: "projects"
4-
description: "Create, inspect, and rename Trigger.dev projects from the terminal."
4+
description: "List, create, inspect, and rename Trigger.dev projects from the terminal."
55
---
66

77
import CommonOptions from "/snippets/cli-options-common.mdx";
@@ -37,6 +37,18 @@ yarn dlx trigger.dev@latest projects create
3737
The name of the new project.
3838
</ParamField>
3939

40+
## projects list
41+
42+
Lists your projects with the runtime and version of their current Production deployment.
43+
44+
```bash
45+
npx trigger.dev@latest projects list
46+
```
47+
48+
<ParamField body="Needs update" type="--needs-update">
49+
Only show projects using Node.js 21 in Production.
50+
</ParamField>
51+
4052
## projects get
4153

4254
Prints the name, ref, slug, organization, default runtime and region of a project.

‎docs/cli-update-commands.mdx‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,25 @@ Run the command like this:
1414
<CodeGroup>
1515

1616
```bash npm
17-
npx trigger.dev@latest update
17+
npx trigger.dev@latest update [path]
1818
```
1919

2020
```bash pnpm
21-
pnpm dlx trigger.dev@latest update
21+
pnpm dlx trigger.dev@latest update [path]
2222
```
2323

2424
```bash yarn
25-
yarn dlx trigger.dev@latest update
25+
yarn dlx trigger.dev@latest update [path]
2626
```
2727

2828
</CodeGroup>
2929

30+
## Arguments
31+
32+
<ParamField body="Project path" type="[path]">
33+
The directory that contains the `package.json` file. Defaults to `.`.
34+
</ParamField>
35+
3036
## Options
3137

3238
### Common options

‎docs/cli-whoami-commands.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ yarn dlx trigger.dev@latest whoami
2626

2727
## Options
2828

29+
<ParamField body="Config file" type="-c, --config <config file>">
30+
The name of the config file.
31+
</ParamField>
32+
33+
<ParamField body="Project ref" type="-p, --project-ref <project ref>">
34+
The project ref. Overrides the project in the config file.
35+
</ParamField>
36+
37+
<ParamField body="Env file" type="--env-file <env file>">
38+
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.
39+
</ParamField>
40+
2941
### Common options
3042

3143
These options are available on most commands.

‎docs/config/extensions/audioWaveform.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ export default defineConfig({
1414
project: "<project ref>",
1515
// Your other config settings...
1616
build: {
17-
extensions: [audioWaveform()], // uses verson 1.1.0 of audiowaveform by default
17+
extensions: [audioWaveform()], // uses version 1.10.1 of audiowaveform by default
1818
},
1919
});
2020
```
21+
22+
To use a different version, pass the `version` and `checksum` options to `audioWaveform()`.
23+

‎docs/config/extensions/overview.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ Trigger.dev provides a set of built-in extensions that you can use to customize
5151
| [prismaExtension](/config/extensions/prismaExtension) | Using prisma in your Trigger.dev tasks |
5252
| [pythonExtension](/config/extensions/pythonExtension) | Execute Python scripts in your project |
5353
| [puppeteer](/config/extensions/puppeteer) | Use Puppeteer in your Trigger.dev tasks |
54+
| [playwright](/config/extensions/playwright) | Use Playwright in your Trigger.dev tasks |
55+
| [lightpanda](/config/extensions/lightpanda) | Use Lightpanda in your Trigger.dev tasks |
5456
| [ffmpeg](/config/extensions/ffmpeg) | Use FFmpeg in your Trigger.dev tasks |
5557
| [aptGet](/config/extensions/aptGet) | Install system packages in your build image |
5658
| [additionalFiles](/config/extensions/additionalFiles) | Copy additional files to your build image |

‎docs/config/extensions/prismaExtension.mdx‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ prismaExtension({
641641
```prisma
642642
generator client {
643643
provider = "prisma-client-js"
644-
binaryTargets = ["native", "linux-arm64-openssl-3.0.x"]
644+
binaryTargets = ["native", "debian-openssl-3.0.x"]
645645
}
646646
```
647647

@@ -885,7 +885,7 @@ export const db = new PrismaClient({
885885
generator client {
886886
provider = "prisma-client-js"
887887
output = "../src/generated/prisma"
888-
binaryTargets = ["native", "linux-arm64-openssl-3.0.x"]
888+
binaryTargets = ["native", "debian-openssl-3.0.x"]
889889
}
890890
891891
datasource db {
@@ -913,7 +913,6 @@ datasource db {
913913
prismaExtension({
914914
mode: "engine-only",
915915
version: "6.19.0",
916-
binaryTarget: "linux-arm64-openssl-3.0.x",
917916
});
918917
```
919918

‎docs/config/extensions/puppeteer.mdx‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ sidebarTitle: "puppeteer"
44
description: "Use the puppeteer build extension to enable support for Puppeteer in your project"
55
---
66

7+
import ScrapingWarning from "/snippets/web-scraping-warning.mdx";
8+
79
<ScrapingWarning />
810

911
To use Puppeteer in your project, add these build settings to your `trigger.config.ts` file:
@@ -21,10 +23,6 @@ export default defineConfig({
2123
});
2224
```
2325

24-
And add the following environment variable in your Trigger.dev dashboard on the Environment Variables page:
25-
26-
```bash
27-
PUPPETEER_EXECUTABLE_PATH: "/usr/bin/google-chrome-stable",
28-
```
26+
The extension installs Chrome and sets `PUPPETEER_EXECUTABLE_PATH=/usr/bin/google-chrome-stable` for deployed builds automatically, so you do not need to set it. Don't set it in your Dev environment: the extension does nothing in Dev, and locally Puppeteer uses the browser it downloads on install.
2927

3028
Follow [this example](/guides/examples/puppeteer) to get setup with Trigger.dev and Puppeteer in your project.

0 commit comments

Comments
 (0)