deploy

vercel deploy

Learn how to deploy your Vercel projects using the vercel deploy CLI command.

Table of Contents

The vercel deploy command deploys Vercel projects, executable from the project's root directory or by specifying a path. You can omit 'deploy' in vercel deploy, as vercel is the only command that operates without a subcommand. This document will use 'vercel' to refer to vercel deploy.

Usage

terminal

vercel

Using the vercel command from the root of a Vercel project directory.

Extended usage

terminal

vercel --cwd [path-to-project]

Using the vercel command and supplying a path to the root directory of the Vercel project.

terminal

vercel deploy --prebuilt

Using the vercel command to deploy a prebuilt Vercel project, typically with vercel build. See vercel build and Build Output API for more details.

Standard output usage

When deploying, stdout is always the Deployment URL.

terminal

vercel > deployment-url.txt

Using the vercel command to deploy and write stdout to a text file. When deploying, stdout is always the Deployment URL.

Deploying to a custom domain

In the following example, you create a bash script that you include in your CI/CD workflow. The goal is to have all preview deployments be aliased to a custom domain so that developers can bookmark the preview deployment URL. Note that you may need to define the scope when using vercel alias

deployDomain.sh

# save stdout and stderr to files
vercel deploy >deployment-url.txt 2>error.txt
 
# check the exit code
code=$?
if [ $code -eq 0 ]; then
    # Now you can use the deployment url from stdout for the next step of your workflow
    deploymentUrl=`cat deployment-url.txt`
    vercel alias $deploymentUrl my-custom-domain.com
else
    # Handle the error
    errorMessage=`cat error.txt`
    echo "There was an error: $errorMessage"
fi

The script deploys your project and assigns the deployment URL saved in stdout to the custom domain using vercel alias.

Standard error usage

If you need to check for errors when the command is executed such as in a CI/CD workflow, use stderr. If the exit code is anything other than 0, an error has occurred. The following example demonstrates a script that checks if the exit code is not equal to 0:

checkDeploy.sh

# save stdout and stderr to files
vercel deploy >deployment-url.txt 2>error.txt
 
# check the exit code
code=$?
if [ $code -eq 0 ]; then
    # Now you can use the deployment url from stdout for the next step of your workflow
    deploymentUrl=`cat deployment-url.txt`
    echo $deploymentUrl
else
    # Handle the error
    errorMessage=`cat error.txt`
    echo "There was an error: $errorMessage"
fi

Unique options

These are options that only apply to the vercel command.

Build env

The --build-env option, shorthand -b, can be used to provide environment variables to the build step.

terminal

vercel --build-env KEY1=value1 --build-env KEY2=value2

Using the vercel command with the --build-env option.

Yes

The --yes option can be used to skip questions you are asked when setting up a new Vercel project. The questions will be answered with the provided defaults, inferred from vercel.json and the folder name.

terminal

vercel --yes

Using the vercel command with the --yes option.

Env

The --env option, shorthand -e, can be used to provide environment variables at runtime.

terminal

vercel --env KEY1=value1 --env KEY2=value2

Using the vercel command with the --env option.

Name

The --name option has been deprecated in favor of Vercel project linking, which allows you to link a Vercel project to your local codebase when you run vercel.

The --name option, shorthand -n, can be used to provide a Vercel project name for a deployment.

terminal

vercel --name foo

Using the vercel command with the --name option.

Prod

The --prod option can be used to create a deployment for a production domain specified in the Vercel project dashboard.

terminal

vercel --prod

Using the vercel command with the --prod option.

Skip Domain

This CLI option will override the Auto-assign Custom Production Domains project setting.

Must be used with --prod. The --skip-domain option will disable the automatic promotion (aliasing) of the relevant domains to a new production deployment. You can use vercel promote to complete the domain-assignment process later.

terminal