Skip to content

Commit f0969b1

Browse files
D-K-PD-K-P
authored
Merge branch 'main' into docs/task-examples-ffmpeg-sharp-vercel
2 parents 1669ee2 + 9a3eab5 commit f0969b1

38 files changed

+344
-220
lines changed

‎.changeset/flat-bees-jog.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎.changeset/poor-starfishes-act.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ jobs:
6969
commit: "chore: Update version for release"
7070
title: "chore: Update version for release"
7171
publish: pnpm run changeset:release
72-
createGithubReleases: false
72+
createGithubReleases: true
7373
env:
7474
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7575
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

‎apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.v3.$projectParam.runs.electric.$runParam/route.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1155,7 +1155,7 @@ function ConnectedDevWarning() {
11551155
<Paragraph variant="small">
11561156
Runs usually start within 2 seconds in{" "}
11571157
<EnvironmentLabel environment={{ type: "DEVELOPMENT" }} />. Check you're running the
1158-
CLI: <InlineCode className="whitespace-nowrap">npx trigger.dev@beta dev</InlineCode>
1158+
CLI: <InlineCode className="whitespace-nowrap">npx trigger.dev@latest dev</InlineCode>
11591159
</Paragraph>
11601160
</div>
11611161
</Callout>

‎docs/cli-deploy-commands.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "CLI deploy options"
3-
sidebarTitle: "Deploy"
3+
sidebarTitle: "deploy"
44
description: "Use these options to help deploy your tasks to Trigger.dev."
55
---
66

‎docs/cli-deploy.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ title: "CLI deploy command"
33
description: "The `trigger.dev deploy` command can be used to manually deploy."
44
---
55

6-
import ComingSoon from '/snippets/coming-soon-generic.mdx';
76
import CliDeployCommands from '/snippets/cli-commands-deploy.mdx';
87

98
<CliDeployCommands/>
10-
11-
{/* todo add options, remove the reference docs */}

‎docs/cli-dev-commands.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "CLI dev command"
3-
sidebarTitle: "Dev"
3+
sidebarTitle: "dev"
44
description: "The `trigger.dev dev` command is used to run your tasks locally."
55
---
66

‎docs/cli-init-commands.mdx

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: "CLI init command"
3-
sidebarTitle: "Init"
3+
sidebarTitle: "init"
44
description: "Use these options when running the CLI `init` command."
55
---
66

7+
import CommonOptions from '/snippets/cli-options-common.mdx';
8+
79
Run the command like this:
810

911
<CodeGroup>
@@ -49,25 +51,8 @@ yarn dlx trigger.dev@latest init
4951
Additional arguments to pass to the package manager. Accepts CSV for multiple args.
5052
</ParamField>
5153

52-
<ParamField body="Login profile" type="--profile">
53-
The login profile to use. Defaults to "default".
54-
</ParamField>
54+
### Common options
5555

56-
<ParamField body="API URL" type="--api-url | -a">
57-
Override the default API URL. If not specified, it uses `https://api.trigger.dev`.
58-
</ParamField>
59-
60-
<ParamField body="Log level" type="--log-level | -l">
61-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
62-
does not affect the log level of your trigger.dev tasks. Defaults to "log".
63-
</ParamField>
56+
These options are available on most commands.
6457

65-
<ParamField body="Skip telemetry" type="--skip-telemetry">
66-
Opt-out of sending telemetry data.
67-
</ParamField>
68-
69-
## Standard options
70-
71-
<ParamField body="Help" type="--help | -h">
72-
Shows the help information for the command.
73-
</ParamField>
58+
<CommonOptions />

‎docs/cli-introduction.mdx

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,23 @@ title: "Introduction"
33
description: "The Trigger.dev CLI has a number of options and commands to help you develop locally, self host, and deploy your tasks."
44
---
55

6-
## Standard options
6+
import HelpOption from '/snippets/cli-options-help.mdx';
7+
import VersionOption from '/snippets/cli-options-version.mdx';
78

8-
<ParamField body="Help" type="--help | -h">
9-
Displays a list of all help commands.
10-
</ParamField>
9+
## Options
1110

12-
<ParamField body="Version" type="--version | -v">
13-
Displays the version number.
14-
</ParamField>
11+
<HelpOption />
12+
<VersionOption />
1513

1614
## Commands
1715

18-
| Command | Description |
19-
| :------------------------------------------------------- | :--------------------------------------------------------------------- |
20-
| [Login](/cli-login-commands) | Login with Trigger.dev so you can perform authenticated actions. |
21-
| [Init](/cli-init-commands) | Initialize your existing project for development with Trigger.dev. |
22-
| [Dev](/cli-dev-commands) | Run your Trigger.dev tasks locally. |
23-
| [Deploy](/cli-deploy-commands) | Deploy your Trigger.dev v3 project to the cloud. |
24-
| [Whoami](/cli-whoami-commands) | Display the current logged in user and project details. |
25-
| [Logout](/cli-logout-commands) | Logout of Trigger.dev. |
26-
| [List-profiles](/cli-list-profiles-commands) | List all of your CLI profiles. |
27-
| [Update](/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |
16+
| Command | Description |
17+
| :------------------------------------------- | :----------------------------------------------------------------- |
18+
| [login](/cli-login-commands) | Login with Trigger.dev so you can perform authenticated actions. |
19+
| [init](/cli-init-commands) | Initialize your existing project for development with Trigger.dev. |
20+
| [dev](/cli-dev-commands) | Run your Trigger.dev tasks locally. |
21+
| [deploy](/cli-deploy-commands) | Deploy your Trigger.dev v3 project to the cloud. |
22+
| [whoami](/cli-whoami-commands) | Display the current logged in user and project details. |
23+
| [logout](/cli-logout-commands) | Logout of Trigger.dev. |
24+
| [list-profiles](/cli-list-profiles-commands) | List all of your CLI profiles. |
25+
| [update](/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |

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

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
---
2-
title: "CLI list profiles command"
3-
sidebarTitle: "List profiles"
2+
title: "CLI list-profiles command"
3+
sidebarTitle: "list-profiles"
44
description: "Use these options when using the `list-profiles` CLI command."
55
---
66

7+
import LogLevelOption from "/snippets/cli-options-log-level.mdx";
8+
import SkipTelemetryOption from "/snippets/cli-options-skip-telemetry.mdx";
9+
import HelpOption from "/snippets/cli-options-help.mdx";
10+
import VersionOption from "/snippets/cli-options-version.mdx";
11+
712
Run the command like this:
813

914
<CodeGroup>
@@ -24,17 +29,14 @@ yarn dlx trigger.dev@latest list-profiles
2429

2530
## Options
2631

27-
<ParamField body="Log level" type="--log-level | -l">
28-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
29-
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
30-
</ParamField>
32+
### Common options
33+
34+
These options are available on most commands.
35+
36+
<LogLevelOption />
3137

32-
<ParamField body="Skip telemetry" type="--skip-telemetry">
33-
Opt-out of sending telemetry data.
34-
</ParamField>
38+
<SkipTelemetryOption />
3539

36-
## Standard options
40+
<HelpOption />
3741

38-
<ParamField body="Help" type="--help | -h">
39-
Shows the help information for the command.
40-
</ParamField>
42+
<VersionOption />

‎docs/cli-login-commands.mdx

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: "CLI login command"
3-
sidebarTitle: "Login"
3+
sidebarTitle: "login"
44
description: "Use these options when logging in to Trigger.dev using the CLI."
55
---
66

7+
import CommonOptions from '/snippets/cli-options-common.mdx';
8+
79
Run the command like this:
810

911
<CodeGroup>
@@ -24,29 +26,8 @@ yarn dlx trigger.dev@latest login
2426

2527
## Options
2628

27-
<ParamField body="Login profile" type="--profile">
28-
Specifies the login profile to use. If not provided, it defaults to "default".
29-
</ParamField>
30-
31-
<ParamField body="API URL" type="-a | --api-url">
32-
Overrides the default API URL. If not specified, it uses `https://api.trigger.dev`.
33-
</ParamField>
34-
35-
<ParamField body="Log level" type="-l | --log-level">
36-
Sets the CLI log level. Available options are `debug`, `info`, `log`, `warn`, `error`, and `none`.
37-
This setting doesn't affect the log level of your trigger.dev tasks. The default is `log`.
38-
</ParamField>
39-
40-
<ParamField body="Skip telemetry" type="--skip-telemetry">
41-
Opts out of sending telemetry data.
42-
</ParamField>
43-
44-
## Standard options
29+
### Common options
4530

46-
<ParamField body="Version" type="--version | -v">
47-
Displays the version number of the CLI.
48-
</ParamField>
31+
These options are available on most commands.
4932

50-
<ParamField body="Help" type="--help | -h">
51-
Shows the help information for the command.
52-
</ParamField>
33+
<CommonOptions />

‎docs/cli-logout-commands.mdx

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: "CLI logout command"
3-
sidebarTitle: "Logout"
3+
sidebarTitle: "logout"
44
description: "Use these options when using the `logout` CLI command."
55
---
66

7+
import CommonOptions from '/snippets/cli-options-common.mdx';
8+
79
Run the command like this:
810

911
<CodeGroup>
@@ -24,25 +26,8 @@ yarn dlx trigger.dev@latest logout
2426

2527
## Options
2628

27-
<ParamField body="Login profile" type="--profile">
28-
The login profile to use. Defaults to `default`.
29-
</ParamField>
30-
31-
<ParamField body="API URL" type="--api-url | -a">
32-
Override the API URL. Defaults to `https://api.trigger.dev`.
33-
</ParamField>
34-
35-
<ParamField body="Log level" type="--log-level | -l">
36-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
37-
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
38-
</ParamField>
39-
40-
<ParamField body="Skip telemetry" type="--skip-telemetry">
41-
Opt-out of sending telemetry data.
42-
</ParamField>
29+
### Common options
4330

44-
## Standard options
31+
These options are available on most commands.
4532

46-
<ParamField body="Help" type="--help | -h">
47-
Shows the help information for the command.
48-
</ParamField>
33+
<CommonOptions />

‎docs/cli-update-commands.mdx

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
---
22
title: "CLI update command"
3-
sidebarTitle: "Update"
3+
sidebarTitle: "update"
44
description: "Use these options when using the `update` CLI command."
55
---
66

7+
import LogLevelOption from "/snippets/cli-options-log-level.mdx";
8+
import SkipTelemetryOption from "/snippets/cli-options-skip-telemetry.mdx";
9+
import HelpOption from "/snippets/cli-options-help.mdx";
10+
import VersionOption from "/snippets/cli-options-version.mdx";
11+
712
Run the command like this:
813

914
<CodeGroup>
@@ -24,17 +29,14 @@ yarn dlx trigger.dev@latest update
2429

2530
## Options
2631

27-
<ParamField body="Log level" type="--log-level | -l">
28-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
29-
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
30-
</ParamField>
32+
### Common options
33+
34+
These options are available on most commands.
35+
36+
<LogLevelOption />
3137

32-
<ParamField body="Skip telemetry" type="--skip-telemetry">
33-
Opt-out of sending telemetry data.
34-
</ParamField>
38+
<SkipTelemetryOption />
3539

36-
## Standard options
40+
<HelpOption />
3741

38-
<ParamField body="Help" type="--help | -h">
39-
Shows the help information for the command.
40-
</ParamField>
42+
<VersionOption />

‎docs/cli-whoami-commands.mdx

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: "CLI whoami command"
3-
sidebarTitle: "Whoami"
3+
sidebarTitle: "whoami"
44
description: "Use these options to display the current logged in user and project details."
55
---
66

7+
import CommonOptions from '/snippets/cli-options-common.mdx';
8+
79
Run the command like this:
810

911
<CodeGroup>
@@ -24,25 +26,8 @@ yarn dlx trigger.dev@latest whoami
2426

2527
## Options
2628

27-
<ParamField body="Login profile" type="--profile">
28-
The login profile to use. Defaults to `default`.
29-
</ParamField>
30-
31-
<ParamField body="API URL" type="--api-url | -a">
32-
Override the API URL. Defaults to `https://api.trigger.dev`.
33-
</ParamField>
34-
35-
<ParamField body="Log level" type="--log-level | -l">
36-
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
37-
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
38-
</ParamField>
39-
40-
<ParamField body="Skip telemetry" type="--skip-telemetry">
41-
Opt-out of sending telemetry data.
42-
</ParamField>
29+
### Common options
4330

44-
## Standard options
31+
These options are available on most commands.
4532

46-
<ParamField body="Help" type="--help | -h">
47-
Shows the help information for the command.
48-
</ParamField>
33+
<CommonOptions />

0 commit comments

Comments
 (0)