2 min read

vercel alias

Learn how to apply custom domain aliases to your Vercel deployments using the vercel alias CLI command.
Table of Contents

The vercel alias command allows you to apply custom domains to your deployments.

When a new deployment is created (with our Git Integration, Vercel CLI, or the REST API), the platform will automatically apply any custom domains configured in the project settings.

Any custom domain that doesn't have a custom preview branch configured (there can only be one Production Branch and it's configured separately in the project settings) will be applied to production deployments created through any of the available sources.

Custom domains that do have a custom preview branch configured, however, only get applied when using the Git Integration.

If you're not using the Git Integration, vercel alias is a great solution if you still need to apply custom domains based on Git branches, or other heuristics.

The vercel alias command is not the recommended way to promote production deployments to specific domains. Instead, you can use the following commands:

In general, the command allows for assigning custom domains to any deployment.

Make sure to not include the HTTP protocol (e.g. https://) for the [custom-domain] parameter.

terminal
vercel alias set [deployment-url] [custom-domain]

Using the vercel alias command to assign a custom domain to a deployment.

terminal
vercel alias rm [custom-domain]

Using the vercel alias command to remove a custom domain from a deployment.

terminal
vercel alias ls

Using the vercel alias command to list custom domains that were assigned to deployments.

These are options that only apply to the vercel alias command.

The --yes option can be used to bypass the confirmation prompt when removing an alias.

terminal
vercel alias rm [custom-domain] --yes

Using the vercel alias rm command with the --yes option.

The --limit option can be used to specify the maximum number of aliases returned when using ls. The default value is 20 and the maximum is 100.

terminal
vercel alias ls --limit 100

Using the vercel alias ls command with the --limit option.

The following global options can be passed when using the vercel alias command:

For more information on global options and their usage, refer to the options section.

Last updated on July 13, 2024