Vercel

Vercel configuration file

Type object
File match vercel.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/vercel/latest.json
Source https://openapi.vercel.sh/vercel.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

$schema string

Ignored. Can be set to get completions, validations and documentation in some editors.

alias string | string[]

Aliases that will get assigned when the deployment is READY and the target is production. The client needs to make a GET request to its API to ensure the assignment

build object

An object containing another object with information to be passed to the Build Process

1 nested properties
env object

An object containing the deployment's environment variable names and values to be passed to Builds. Secrets can be referenced by prefixing the value with @

builds object[]

A list of build descriptions whose src references valid source files.

minItems=0maxItems=128
cleanUrls boolean

When set to true, all HTML files and Serverless Functions will have their extension removed. When visiting a path that ends with the extension, a 308 response will redirect the client to the extensionless path.

env object

An object containing the deployment's environment variable names and values. Secrets can be referenced by prefixing the value with @

passiveRegions string[]

An array of the passive regions the deployment's Serverless Functions should be deployed to that can be failed over to during a lambda outage

minItems=1maxItems=4
functionFailoverRegions string[]

Same as passiveRegions. An array of the passive regions the deployment's Serverless Functions should be deployed to so we can failover to these regions on lambda outages

minItems=1maxItems=4
functions object

An object describing custom options for your Serverless Functions. Each key must be glob pattern that matches the paths of the Serverless Functions you would like to customize (like api/*.js or api/test.js).

git object
2 nested properties
deploymentEnabled boolean | object

Specifies the branches that will not trigger an auto-deployment when committing to them. Any non specified branch is true by default.

exclusivity object

If specified, the git repository will be exclusive to the specificed Team IDs. Teams that are not specified in the list will not be able to link new projects or create new deployments.

1 nested properties
teams string[]

A list of allowed Team IDs.

minItems=1maxItems=10
github object
4 nested properties
autoAlias boolean

When set to false, Vercel for GitHub will not deploy the given project regardless of the GitHub app being installed.

autoJobCancelation boolean

When set to false, Vercel for GitHub will always build pushes in sequence without cancelling a build for the most recent commit.

enabled boolean

When set to false, Vercel for GitHub will not apply the alias upon merge.

silent boolean

[deprecated] Please use the Project Settings in the dashboard instead: https://vercel.link/46vERTS When set to true, Vercel for GitHub will stop commenting on pull requests and commits.

headers object[]

A list of header definitions.

maxItems=2048
images object
10 nested properties
sizes number[] required
minItems=1maxItems=50
contentDispositionType enum
Values: "inline" "attachment"
contentSecurityPolicy string
minLength=1maxLength=256
dangerouslyAllowSVG boolean
domains string[]
minItems=0maxItems=50
formats enum[]
minItems=1maxItems=4
localPatterns object[]
minItems=0maxItems=25
minimumCacheTTL integer
min=1max=315360000
qualities integer[]
minItems=1maxItems=20
remotePatterns object[]
minItems=0maxItems=50
name string

A name for the deployment

public boolean

Whether a deployment's source and logs are available publicly

redirects object[]

A list of redirect definitions.

maxItems=2048
bulkRedirectsPath string | null

The path to a file containing bulk redirects; supports JSON, JSONL, and CSV

maxLength=256
regions string[]

An array of the regions the deployment's Serverless Functions should be deployed to

minItems=1maxItems=1000
rewrites object[]

A list of rewrite definitions.

maxItems=2048
routes object | object[]

A list of routes objects used to rewrite paths to point towards other internal or external paths

scope string

This property determines the scope (user or team) under which the project will be deployed by Vercel CLI.

trailingSlash boolean

When false, visiting a path that ends with a forward slash will respond with a 308 status code and redirect to the path without the trailing slash.

version integer
min=2max=2
wildcard object[]
minItems=1maxItems=25
buildCommand string | null

The build command for this project. When null is used this value will be automatically detected

maxLength=256
ignoreCommand string | null
maxLength=256
devCommand string | null

The dev command for this project. When null is used this value will be automatically detected

maxLength=256
framework null | string

The framework that is being used for this project. When null is used no framework is selected

Values: "blitzjs" "nextjs" "gatsby" "remix" "react-router" "astro" "hexo" "eleventy" "docusaurus-2" "docusaurus" "preact" "solidstart-1" "solidstart" "dojo" "ember" "vue" "scully" "ionic-angular" "angular" "polymer" "svelte" "sveltekit" "sveltekit-1" "ionic-react" "create-react-app" "gridsome" "umijs" "sapper" "saber" "stencil" "nuxtjs" "redwoodjs" "hugo" "jekyll" "brunch" "middleman" "zola" "hydrogen" "vite" "tanstack-start" "vitepress" "vuepress" "parcel" "fastapi" "flask" "fasthtml" "django" "sanity-v3" "sanity" "storybook" "nitro" "hono" "express" "h3" "koa" "nestjs" "elysia" "fastify" "xmcp" "python" "ruby" "rust" "node" "go" "services" null
installCommand string | null

The install command for this project. When null is used this value will be automatically detected

maxLength=256
outputDirectory string | null

The output directory of the project. When null is used this value will be automatically detected

maxLength=256
crons object[]

An array of cron jobs that should be created for production Deployments.

maxItems=100
relatedProjects string[]

An array of projectIds to associate with the current project.

maxItems=10
fluid boolean

Enables Fluid compute for the project. It's enabled by default for new projects.

bunVersion string

Enables Bun for the project and specifies the version to use.

experimentalApplications Record<string, object>

Enables configuration of multiple applications in a single repository. Map of application name to application configuration.

experimentalDeps Record<string, object>

Defines dependencies for single-service projects. Map of dependency key to dependency configuration.

experimentalServices Record<string, object>

Enables configuration of multiple services in a single deployment. Map of service name to service configuration.

experimentalServiceGroups Record<string, string[]>

Enables grouping of services. Map of service group name to an array of service names belonging to that group.