Matt Aitken
de302858f8
* Started building out the docs navigation * Drafted out a lot of the docs pages. With just titles and descriptions with a coming soon message for now. * A ton more scaffolded pages with titles, descriptions, coming soon/incomplete docs messages * Created the remaining page stubs * Introduction page improvements * Lots of docs changes, mostly the task overview page * Moved some bits around * Task overview fleshed out * Triggering docs page * Regular task page * CLi dev docs * Docs for debugging locally * Environment variables docs * Added env var images * Deployment guides * Updated the title of “Integrations” to “Deployment integrations” to make it less confusing * Lots more docs pages * Changed the language to JavaScript * Fixed typos about queues and added a simple code sample * Moved the local debugger docs into the CLI dev page * Added the CLI deploy options * Delete the local debugger page * Updated the logging page with structured logging * Added the new CLI deploy options * Change to h4 for one of the options * Errors page * WIP on retrying * Retrying guide * Wait docs pages * Queuing docs simplified, partial written * Queuing and concurrency docs * Run tests docs * New combined error and retrying page * Errors and retrying page updated * More docs * Added a possible configurations coming soon table * Created a limits page * Added warnings about how you need to get early access * Minor fixes for the docs
89 lines
2.2 KiB
Plaintext
89 lines
2.2 KiB
Plaintext
---
|
|
title: "CLI deploy command"
|
|
description: "The `trigger.dev deploy` command can be used to manually deploy."
|
|
---
|
|
|
|
You run the command like this:
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npx trigger.dev@v3 deploy
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm dlx trigger.dev@v3 deploy
|
|
```
|
|
|
|
```bash yarn
|
|
yarn dlx trigger.dev@v3 deploy
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
It performs a few steps to deploy:
|
|
|
|
1. Typechecks the code.
|
|
2. Compiles and bundles the code.
|
|
3. Checks that [environment variables](/v3/deploy-environment-variables) are set.
|
|
4. Deploys the code to the cloud.
|
|
5. 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-image` to push to the default registry.
|
|
|
|
#### Registry `--registry`
|
|
|
|
<Snippet file="coming-soon-slim.mdx" />
|
|
|
|
The registry to push the image to when using --self-hosted.
|
|
|
|
#### Push image `--push-image`
|
|
|
|
<Snippet file="coming-soon-slim.mdx" />
|
|
|
|
When using the --self-hosted flag, push the image to the default registry. (defaults to false when not using --registry)
|
|
|
|
#### Tag the image `--tag`
|
|
|
|
<Snippet file="coming-soon-slim.mdx" />
|
|
|
|
Specify the tag to use when pushing the image to the registry.
|
|
|
|
{/* todo add options, remove the reference docs */}
|