Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1155,7 +1155,7 @@ function ConnectedDevWarning() {
<Paragraph variant="small">
Runs usually start within 2 seconds in{" "}
<EnvironmentLabel environment={{ type: "DEVELOPMENT" }} />. Check you're running the
CLI: <InlineCode className="whitespace-nowrap">npx trigger.dev@beta dev</InlineCode>
CLI: <InlineCode className="whitespace-nowrap">npx trigger.dev@latest dev</InlineCode>
</Paragraph>
</div>
</Callout>
Expand Down
2 changes: 1 addition & 1 deletion docs/cli-deploy-commands.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "CLI deploy options"
sidebarTitle: "Deploy"
sidebarTitle: "deploy"
description: "Use these options to help deploy your tasks to Trigger.dev."
---

Expand Down
3 changes: 0 additions & 3 deletions docs/cli-deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "CLI deploy command"
description: "The `trigger.dev deploy` command can be used to manually deploy."
---

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

<CliDeployCommands/>

{/* todo add options, remove the reference docs */}
2 changes: 1 addition & 1 deletion docs/cli-dev-commands.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "CLI dev command"
sidebarTitle: "Dev"
sidebarTitle: "dev"
description: "The `trigger.dev dev` command is used to run your tasks locally."
---

Expand Down
27 changes: 6 additions & 21 deletions docs/cli-init-commands.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "CLI init command"
sidebarTitle: "Init"
sidebarTitle: "init"
description: "Use these options when running the CLI `init` command."
---

import CommonOptions from '/snippets/cli-options-common.mdx';

Run the command like this:

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

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

<ParamField body="API URL" type="--api-url | -a">
Override the default API URL. If not specified, it uses `https://api.trigger.dev`.
</ParamField>

<ParamField body="Log level" type="--log-level | -l">
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
does not affect the log level of your trigger.dev tasks. Defaults to "log".
</ParamField>
These options are available on most commands.

<ParamField body="Skip telemetry" type="--skip-telemetry">
Opt-out of sending telemetry data.
</ParamField>

## Standard options

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
<CommonOptions />
32 changes: 15 additions & 17 deletions docs/cli-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,23 @@ title: "Introduction"
description: "The Trigger.dev CLI has a number of options and commands to help you develop locally, self host, and deploy your tasks."
---

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

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

<ParamField body="Version" type="--version | -v">
Displays the version number.
</ParamField>
<HelpOption />
<VersionOption />

## Commands

| Command | Description |
| :------------------------------------------------------- | :--------------------------------------------------------------------- |
| [Login](/cli-login-commands) | Login with Trigger.dev so you can perform authenticated actions. |
| [Init](/cli-init-commands) | Initialize your existing project for development with Trigger.dev. |
| [Dev](/cli-dev-commands) | Run your Trigger.dev tasks locally. |
| [Deploy](/cli-deploy-commands) | Deploy your Trigger.dev v3 project to the cloud. |
| [Whoami](/cli-whoami-commands) | Display the current logged in user and project details. |
| [Logout](/cli-logout-commands) | Logout of Trigger.dev. |
| [List-profiles](/cli-list-profiles-commands) | List all of your CLI profiles. |
| [Update](/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |
| Command | Description |
| :------------------------------------------- | :----------------------------------------------------------------- |
| [login](/cli-login-commands) | Login with Trigger.dev so you can perform authenticated actions. |
| [init](/cli-init-commands) | Initialize your existing project for development with Trigger.dev. |
| [dev](/cli-dev-commands) | Run your Trigger.dev tasks locally. |
| [deploy](/cli-deploy-commands) | Deploy your Trigger.dev v3 project to the cloud. |
| [whoami](/cli-whoami-commands) | Display the current logged in user and project details. |
| [logout](/cli-logout-commands) | Logout of Trigger.dev. |
| [list-profiles](/cli-list-profiles-commands) | List all of your CLI profiles. |
| [update](/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |
28 changes: 15 additions & 13 deletions docs/cli-list-profiles-commands.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
---
title: "CLI list profiles command"
sidebarTitle: "List profiles"
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>
Expand All @@ -24,17 +29,14 @@ yarn dlx trigger.dev@latest list-profiles

## Options

<ParamField body="Log level" type="--log-level | -l">
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
</ParamField>
### Common options

These options are available on most commands.

<LogLevelOption />

<ParamField body="Skip telemetry" type="--skip-telemetry">
Opt-out of sending telemetry data.
</ParamField>
<SkipTelemetryOption />

## Standard options
<HelpOption />

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
<VersionOption />
31 changes: 6 additions & 25 deletions docs/cli-login-commands.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "CLI login command"
sidebarTitle: "Login"
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>
Expand All @@ -24,29 +26,8 @@ yarn dlx trigger.dev@latest login

## Options

<ParamField body="Login profile" type="--profile">
Specifies the login profile to use. If not provided, it defaults to "default".
</ParamField>

<ParamField body="API URL" type="-a | --api-url">
Overrides the default API URL. If not specified, it uses `https://api.trigger.dev`.
</ParamField>

<ParamField body="Log level" type="-l | --log-level">
Sets the CLI log level. Available options are `debug`, `info`, `log`, `warn`, `error`, and `none`.
This setting doesn't affect the log level of your trigger.dev tasks. The default is `log`.
</ParamField>

<ParamField body="Skip telemetry" type="--skip-telemetry">
Opts out of sending telemetry data.
</ParamField>

## Standard options
### Common options

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

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
<CommonOptions />
27 changes: 6 additions & 21 deletions docs/cli-logout-commands.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "CLI logout command"
sidebarTitle: "Logout"
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>
Expand All @@ -24,25 +26,8 @@ yarn dlx trigger.dev@latest logout

## Options

<ParamField body="Login profile" type="--profile">
The login profile to use. Defaults to `default`.
</ParamField>

<ParamField body="API URL" type="--api-url | -a">
Override the API URL. Defaults to `https://api.trigger.dev`.
</ParamField>

<ParamField body="Log level" type="--log-level | -l">
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
</ParamField>

<ParamField body="Skip telemetry" type="--skip-telemetry">
Opt-out of sending telemetry data.
</ParamField>
### Common options

## Standard options
These options are available on most commands.

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
<CommonOptions />
26 changes: 14 additions & 12 deletions docs/cli-update-commands.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
---
title: "CLI update command"
sidebarTitle: "Update"
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>
Expand All @@ -24,17 +29,14 @@ yarn dlx trigger.dev@latest update

## Options

<ParamField body="Log level" type="--log-level | -l">
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
</ParamField>
### Common options

These options are available on most commands.

<LogLevelOption />

<ParamField body="Skip telemetry" type="--skip-telemetry">
Opt-out of sending telemetry data.
</ParamField>
<SkipTelemetryOption />

## Standard options
<HelpOption />

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
<VersionOption />
27 changes: 6 additions & 21 deletions docs/cli-whoami-commands.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "CLI whoami command"
sidebarTitle: "Whoami"
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>
Expand All @@ -24,25 +26,8 @@ yarn dlx trigger.dev@latest whoami

## Options

<ParamField body="Login profile" type="--profile">
The login profile to use. Defaults to `default`.
</ParamField>

<ParamField body="API URL" type="--api-url | -a">
Override the API URL. Defaults to `https://api.trigger.dev`.
</ParamField>

<ParamField body="Log level" type="--log-level | -l">
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
does not affect the log level of your trigger.dev tasks. Defaults to `log`.
</ParamField>

<ParamField body="Skip telemetry" type="--skip-telemetry">
Opt-out of sending telemetry data.
</ParamField>
### Common options

## Standard options
These options are available on most commands.

<ParamField body="Help" type="--help | -h">
Shows the help information for the command.
</ParamField>
<CommonOptions />
Loading
Loading