ProjectSettings

August 10, 2026 ยท View on GitHub

Project settings that will be applied to the deployment. It is required for the first deployment of a project and will be saved for any following deployments

Example Usage

import { ProjectSettings } from "@vercel/sdk/models/createdeploymentmissingdeploymentstype.js";

let value: ProjectSettings = {
  buildCommand: "next build",
  installCommand: "pnpm install",
};

Fields

FieldTypeRequiredDescriptionExample
buildCommandstring:heavy_minus_sign:The build command for this project. When null is used this value will be automatically detectednext build
commandForIgnoringBuildStepstring:heavy_minus_sign:N/A
devCommandstring:heavy_minus_sign:The dev command for this project. When null is used this value will be automatically detected
frameworkmodels.Framework:heavy_minus_sign:The framework that is being used for this project. When null is used no framework is selected
installCommandstring:heavy_minus_sign:The install command for this project. When null is used this value will be automatically detectedpnpm install
nodeVersionmodels.NodeVersion:heavy_minus_sign:Override the Node.js version that should be used for this deployment
outputDirectorystring:heavy_minus_sign:The output directory of the project. When null is used this value will be automatically detected
rootDirectorystring:heavy_minus_sign:The name of a directory or relative path to the source code of your project. When null is used it will default to the project root
serverlessFunctionRegionstring:heavy_minus_sign:The region to deploy Serverless Functions in this project
skipGitConnectDuringLinkboolean:heavy_minus_sign:: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Opts-out of the message prompting a CLI user to connect a Git repository in vercel link.
sourceFilesOutsideRootDirectoryboolean:heavy_minus_sign:Indicates if there are source files outside of the root directory, typically used for monorepos