Cli Commands Deploy - Trigger

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:

bash

npx trigger.dev@latest deploy

bash

pnpm dlx trigger.dev@latest deploy

bash

yarn dlx trigger.dev@latest deploy

</CodeGroup> <Warning> This will fail in CI if any version mismatches are detected. Ensure everything runs locally first using the [dev](/cli-dev-commands) command and don't bypass the version checks! </Warning>

It performs a few steps to deploy:

Optionally updates packages when running locally.
Compiles and bundles the code.
Deploys the code to the Trigger.dev instance.
Registers the tasks as a new version in the environment (prod by default).

Deploying from CI

When deploying from CI/CD environments such as GitHub Actions, GitLab CI, or Jenkins, you need to authenticate non-interactively by setting the TRIGGER_ACCESS_TOKEN environment variable. Please see the CI / GitHub Actions guide for more information.

Arguments

npx trigger.dev@latest deploy [path]

Options

<ConfigFileOption /> <ProjectRefOption /> <EnvFileOption /> <SkipUpdateCheckOption /> <ParamField body="Environment" type="--env | -e"> Defaults to `prod` but you can specify `staging` or `preview`. If you specify `preview` we will try and automatically detect the branch name from git. </ParamField> <BranchOption /> <ParamField body="Dry run" type="--dry-run"> Create a deployable build but don't deploy it. Prints out the build path so you can inspect it. </ParamField> <ParamField body="Skip promotion" type="--skip-promotion"> Skips automatically promoting the newly deployed version to the "current" deploy. </ParamField> <ParamField body="Skip syncing env vars" type="--skip-sync-env-vars"> Turn off syncing environment variables with the Trigger.dev instance. </ParamField> <ParamField body="Local build" type="--local-build"> Force building the deployment image locally using your local Docker. This is automatic when self-hosting. </ParamField>

Common options

These options are available on most commands.

Self-hosting

When self-hosting, builds are performed locally by default. Once you've logged in to your self-hosted instance using the CLI, you can deploy with:

bash

npx trigger.dev@latest deploy

For CI/CD environments, set TRIGGER_ACCESS_TOKEN and TRIGGER_API_URL environment variables. See the GitHub Actions guide for more details.