Framework environment variables
Vercel Environment variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed.Frameworks typically use a prefix in order to expose environment variables to the browser.
The following prefixed environment variables will be available during the build step, based on the project's selected framework preset.
The environment that the app is deployed and running on. The value can be either production, preview, or development.
NEXT_PUBLIC_VERCEL_ENV=productionThe domain name of the generated deployment URL. Example: *.vercel.app. The value does not include the protocol schemehttps://.
NEXT_PUBLIC_VERCEL_URL=my-site.vercel.appThe domain name of the generated Git branch URL. Example: *-git-*.vercel.app. The value does not include the protocol scheme https://.
NEXT_PUBLIC_VERCEL_BRANCH_URL=my-site-git-improve-about-page.vercel.appA production domain name of the project. We select the shortest production custom domain, or vercel.app domain if no custom domain is available. Note, that this is always set, even in preview deployments. This is useful to reliably generate links that point to production such as OG-image URLs. The value does not include the protocol scheme https://.
NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL=my-site.comThe Protection Bypass for Automation value, if the secret has been generated in the project's Deployment Protection settings.
NEXT_PUBLIC_VERCEL_AUTOMATION_BYPASS_SECRET=secretThe Git Provider the deployment is triggered from.
NEXT_PUBLIC_VERCEL_GIT_PROVIDER=githubThe origin repository the deployment is triggered from.
NEXT_PUBLIC_VERCEL_GIT_REPO_SLUG=my-siteThe account that owns the repository the deployment is triggered from.
NEXT_PUBLIC_VERCEL_GIT_REPO_OWNER=acmeThe ID of the repository the deployment is triggered from.
NEXT_PUBLIC_VERCEL_GIT_REPO_ID=117716146The git branch of the commit the deployment was triggered by.
NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF=improve-about-pageThe git SHA of the commit the deployment was triggered by.
NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA=fa1eade47b73733d6312d5abfad33ce9e4068081The message attached to the commit the deployment was triggered by.
NEXT_PUBLIC_VERCEL_GIT_COMMIT_MESSAGE=Update about pageThe username attached to the author of the commit that the project was deployed by.
NEXT_PUBLIC_VERCEL_GIT_COMMIT_AUTHOR_LOGIN=johndoeThe name attached to the author of the commit that the project was deployed by.
NEXT_PUBLIC_VERCEL_GIT_COMMIT_AUTHOR_NAME=John DoeThe pull request id the deployment was triggered by. If a deployment is created on a branch before a pull request is made, this value will be an empty string.
NEXT_PUBLIC_VERCEL_GIT_PULL_REQUEST_ID=23Many frontend frameworks require prefixes on environment variable names to make them available to the client, such as NEXT_PUBLIC_ for Next.js or PUBLIC_ for SvelteKit. Vercel adds these prefixes automatically for your production and preview deployments, but not for your local development environment.
Framework environment variables are not prefixed when pulled into your local development environment with vercel env pull. For example, VERCEL_ENV will not be prefixed to NEXT_PUBLIC_VERCEL_ENV.
To use framework-prefixed environment variables locally:
- Define them in your project settings with the appropriate prefix
- Scope them to
Development - Pull them into your local environment with Vercel CLI using the
vercel env pullcommand
Was this helpful?