James Ritchie
6270abaab8
* Make the tooltip text color grey so it’s readable again the primary color * Setup and styling for the Guides section * Better Guides icon * Improved the prerequisites * WIP Nextjs guide and new folder structures * Copy updates * Useful next steps is now a snippet * Better icons for the next steps section * Renamed the “prerequisites” snippet * Node.js guide * Added a “Creating a project” guide * New snippet for prerequisites * New Remix guide * Added Remix to the side bar * Tweaked icons for creating a project page * Added the hello world step to the onboarding steps * Better “useful next steps” snippet card links * Moved prerequisites * Fixing links to images * Moved v2 migration page to guides * Removed dead link * Attempt fix for redirect * Fixed redirects * Getting started section includes link to roadmap * Removed icon from side menu * Deleted all v2 pages (excluding updating mint.json) * Removed v2 pages, redirects and versions from mint.json * Deleted v2 snippets * Deleted un-used pages * Set of more useful coming soon snippets * All snippets use the updated format * updated folder “v3/“ with “/pages” * Moved all main docs files to the route and updated the redirect * Fixed URLs in the mdx pages to the new route path * URL goes to the proper pricing page * Better delayed runs image * Attempt fix for self hosting page not redirecting
92 lines
2.4 KiB
Plaintext
92 lines
2.4 KiB
Plaintext
---
|
|
title: "CLI deploy command"
|
|
description: "The `trigger.dev deploy` command can be used to manually deploy."
|
|
---
|
|
|
|
import ComingSoon from '/snippets/coming-soon-generic.mdx';
|
|
|
|
You run the command like this:
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npx trigger.dev@beta deploy
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm dlx trigger.dev@beta deploy
|
|
```
|
|
|
|
```bash yarn
|
|
yarn dlx trigger.dev@beta deploy
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<Warning>Will fail in CI if any version mismatches are detected. Ensure everything runs locally first using the [dev](/cli-dev) command and don't bypass the version checks!</Warning>
|
|
|
|
It performs a few steps to deploy:
|
|
|
|
1. Optionally updates packages when running locally.
|
|
2. Typechecks the code.
|
|
3. Compiles and bundles the code.
|
|
4. Checks that [environment variables](/deploy-environment-variables) are set.
|
|
5. Deploys the code to the cloud.
|
|
6. Registers the tasks as a new version in the environment (prod by default).
|
|
|
|
## Options
|
|
|
|
### Environment `--env` or `-e`
|
|
|
|
Defaults to `prod` but you can specify `staging`.
|
|
|
|
### Skip typecheck `--skip-typecheck` or `-T`
|
|
|
|
Skips the pre-build typecheck step.
|
|
|
|
### Build platform `--build-platform`
|
|
|
|
The platform to build the deployment image for. Defaults to `linux/amd64`.
|
|
|
|
### Log level `--log-level` or `-l`
|
|
|
|
The log level to use (debug, info, log, warn, error, none). Defaults to `log`.
|
|
|
|
### Set config filename `--config` or `-c`
|
|
|
|
The name of the config file, found where the command is run from. Defaults to `trigger.config.ts`.
|
|
|
|
### Set the projectRef `--project-ref` or `-p`
|
|
|
|
The project ref. Required if there is no config file.
|
|
|
|
### Self-hosted options
|
|
|
|
These options are usually only relevant to self-hosters or for local development.
|
|
|
|
#### Skip deploying the image `--skip-deploy` or `-D`
|
|
|
|
Load the built image into your local docker.
|
|
|
|
#### Self-hosted (builds locally) `--self-hosted`
|
|
|
|
Builds and loads the image using your local docker. Use the `--registry` option to specify the registry to push the image to when using `--self-hosted`, or just use `--push` to push to the default registry.
|
|
|
|
#### Registry `--registry`
|
|
|
|
<ComingSoon />
|
|
|
|
The registry to push the image to when using --self-hosted.
|
|
|
|
#### Push image `--push`
|
|
|
|
When using the --self-hosted flag, push the image to the default registry. (defaults to false when not using --registry)
|
|
|
|
#### Tag the image `--tag`
|
|
|
|
<ComingSoon />
|
|
|
|
Specify the tag to use when pushing the image to the registry.
|
|
|
|
{/* todo add options, remove the reference docs */}
|