vercel project
The vercel project command manages your Vercel Projects from the terminal: list, create, inspect, update, rename, and delete projects, pause and resume production traffic, plus configure framework and build settings, deployment checks, deployment protection, access groups, project members, Web Analytics, Speed Insights, Observability Plus, and project-scoped OIDC tokens.
vercel projects is an alias for the same command.
vercel project listUsing the vercel project list command to list projects in the current scope.
Subcommands that take a project argument (shown as [name], [project], or <name>) accept the project name (the name shown in the dashboard and vercel project list) or its ID, for example my-app or prj_abc123. When the argument is optional and you omit it, the linked project is used.
Show all projects in the selected scope. This is the default subcommand, so vercel project and vercel project list behave the same way.
vercel project list [options]| Option | Description |
|---|---|
--next | Show the next page of results. Pass the cursor that the previous page prints. |
--limit | Number of projects to return per page. The default is 20, and the maximum is 100. |
--json | Output the result as JSON. |
--update-required | Filter to projects affected by an upcoming Node.js runtime deprecation. |
--paused | Show only projects whose production traffic is paused. |
-q, --query | Filter projects by name (substring match). |
# Paginate results
vercel project list --next 1584722256178
# Projects affected by an upcoming Node.js deprecation, as JSON
vercel project list --update-required --json
# Substring filter
vercel project list --query my-app
# Projects whose production traffic is paused
vercel project list --pausedCreate a new project. The name argument is required; vercel project create with no name (or with more than one positional) prints a usage error and exits.
vercel project create <name>Project names must be lowercase and can include letters, digits, ., _, and -. They can't contain spaces. See Project name for the full rules.
Show details for a project by name. Defaults to the linked project.
vercel project inspect [name]# Inspect the linked project
vercel project inspect
# Inspect a project by name
vercel project inspect my-projectKeep a temporary project by removing its scheduled automatic deletion:
vercel project keep [project]Omit the project argument to keep the linked project, or pass a project name or ID. Sign in or authenticate with a token before running the command. When you name a project outside a linked directory in non-interactive mode, pass --scope explicitly to select its team.
The command applies the change without a confirmation prompt. If the project has no scheduled deletion, it reports that no change is needed and exits successfully.
# Keep the linked project
vercel project keep
# Keep a named project on a specific team
vercel project keep my-project --scope my-team
# Return the result as JSON
vercel project keep my-project --scope my-team --jsonUse --json, or --format=json, to write the result to stdout:
{
"id": "prj_example",
"name": "my-project",
"kept": true
}kept is true when the command removes a scheduled deletion and false when the project wasn't scheduled for deletion. Both outcomes exit successfully. Missing projects and insufficient permissions return a nonzero exit code.
Update the framework preset and build settings for a project. Only the settings you pass are changed; omitted settings remain unchanged. Defaults to the linked project. At least one setting option is required.
vercel project update [name] [options]| Option | Description |
|---|---|
--framework <SLUG> | Set the framework preset by slug (for example nextjs). Use other to clear the preset. |
--build-command <COMMAND> | Set the build command. |
--dev-command <COMMAND> | Set the development command. |
--install-command <COMMAND> | Set the install command. |
--output-directory <DIR> | Set the output directory. |
--root-directory <DIR> | Set the project root directory. |
--auto-detect <SETTING> | Reset a setting to automatic detection: build-command, dev-command, install-command, output-directory, or root-directory. Repeat the flag or pass a comma-separated list. Can't be combined with the explicit flag for the same setting. |
--fluid-compute | Turn on Fluid compute for the project. To turn it off, pass --no-fluid-compute. |
--function-cpu <TIER> | Set the default function CPU and memory tier, for example standard or performance. Changing this setting requires a Pro or Enterprise plan. |
--build-machine <TYPE> | Set the build machine type: basic, standard, enhanced, turbo, or elastic. Changing this setting requires a Pro or Enterprise plan. |
--elastic-concurrency | Turn on on-demand concurrent builds for the project. To turn them off, pass --no-elastic-concurrency. Turning them on requires a Pro or Enterprise plan. |
--node-version <VERSION> | Set the Node.js version, for example 24.x or 22.x. |
--sandbox-region <REGION> | Set the default region for sandboxes created in the project. Use "" to clear. |
--sandbox-failover-regions <REGIONS> | Set the comma-separated failover regions for sandboxes created in the project. Must not include the main region. Use "" to clear. Available on Pro and Enterprise plans, excluding Pro trials. |
-y, --yes | Apply the changes without a confirmation prompt. Settings that can affect charges (--function-cpu, --build-machine, and --elastic-concurrency) always ask for confirmation in an interactive terminal. |
--json | Output the result as JSON. |
vercel project update --framework nextjs
vercel project update my-project --framework vite
vercel project update my-project --build-command "pnpm build" --output-directory dist
vercel project update my-project --auto-detect build-command --auto-detect output-directory
vercel project update my-project --sandbox-region sfo1 --sandbox-failover-regions cle1,iad1
vercel project update my-project --framework other --jsonRename an existing project.
vercel project rename <name> <new-name>vercel project rename my-project my-renamed-projectDelete a project and all of its deployments. You can't undo this operation. In a terminal, the command shows the project's team and asks you to type the project name to confirm.
vercel project delete <name>To delete a project without the prompt, for example from a script, pass --confirm-name with the project name and --scope with the team:
vercel project delete my-app --confirm-name my-app --scope my-teamPermanently delete an immutable static asset from storage. Unlike cache
deletion, which flushes cached content that regenerates on
the next request, this deletes the stored asset itself for both the production
and preview environments: its URL serves a 410 Gone response for seven days,
then a 404, and the project's build hash salt rotates so your next deployment
emits different asset URLs. You cannot undo this operation.
The command only runs interactively and asks you to type the asset path to
confirm. The path must exactly match the stored asset path, start with
_vercel/immutable/ or _next/static/immutable/, and contain no leading
slash. See Deleting immutable static
assets for details,
including why deleting the asset does not delete the content.
vercel project dangerously-delete-immutable-static-asset _next/static/immutable/chunks/example.jsList, add, or remove deployment checks for a project.
vercel project checks [name]
vercel project checks add [name] [options]
vercel project checks remove <id> [name]# List checks for the linked project
vercel project checks
# Checks that block production alias assignment
vercel project checks --blocks deployment-alias
# Add a check from a JSON file
vercel project checks add my-app --file ./check.json
# Add a check with flags (requires integration/webhook setup in the body via --file or --source)
vercel project checks add --check-name "CI" --requires deployment-url --blocks deployment-alias
# Remove a check by ID
vercel project checks remove chk_abc123 my-appShow or toggle deployment protection settings for a project. Pass enable or disable as the action; omit both to show current settings.
Activating Password Protection for a project without it can incur charges. Review Password Protection pricing before activating it. Run the command in an interactive terminal and type the project name to confirm, or enable it in the dashboard. Updating an existing password and disabling protection don't require this activation confirmation. Scripts and agents must hand activation to a person.
For project-priced Pro teams, disabling Password Protection stops future charges for that project. Run vercel project protection disable [name] --password --scope my-team to disable it.
vercel project protection [action] [name] [options]| Option | Description |
|---|---|
--sso | Apply the action to SSO protection. |
--password | Apply the action to password protection. Requires an eligible plan. |
--protection-password <PASSWORD> | When enabling --password, set the password value. Maximum 72 characters. |
--customer-support-code-visibility | Apply the action to customer support code visibility protection. |
--skew | Apply the action to skew protection. |
--skew-max-age <SECONDS> | When enabling --skew, set the max age in seconds. Defaults to 2592000 (30 days). |
--protection-bypass | Apply the action to automation protection bypass secrets. |
--protection-bypass-secret <SECRET> | Optional bypass secret value. Required when disabling bypass. |
--git-fork-protection | Apply the action to Git fork protection. |
--json | Output the result as JSON. |
# Show protection settings for the linked project
vercel project protection
# Named project as JSON
vercel project protection my-app --json
# Toggle individual protections
vercel project protection enable my-app --password
vercel project protection disable my-app --password
vercel project protection enable my-app --customer-support-code-visibility
vercel project protection enable my-app --skew
vercel project protection enable my-app --skew --skew-max-age 604800
vercel project protection enable my-app --sso
vercel project protection enable my-app --git-fork-protection
# Bypass secret
vercel project protection enable my-app --protection-bypass
vercel project protection disable my-app --protection-bypass --protection-bypass-secret <secret>Aliases: member.
List, add, or remove project members for a project.
vercel project members [project] [options]
vercel project members add <project> <member> --role <role>
vercel project members remove <project> <member>For add and remove, both arguments are required and <member> can be an email address, username, or user ID. Adding a member requires a Pro or Enterprise team, and the member must already be a confirmed member of the team. Invite them first with vercel teams invite if needed. The available project roles also depend on the member's team role: Contributors can hold any project role, Developers can only be added as ADMIN, Security members as ADMIN or PROJECT_DEVELOPER, and team Members and Owners already have access to every project.
Both add and remove ask for confirmation and have no flag to skip it, so run them in an interactive terminal.
| Option | Description |
|---|---|
-q, --query | Filter project members by name, username, or email (list only). |
--next | Show the next page of results (list only). Pass the cursor that the previous page prints. |
--limit | Limit number of project members returned (1-100) (list only). |
--role | Required for add. Project role to grant: ADMIN, PROJECT_DEVELOPER, PROJECT_VIEWER, or PROJECT_GUEST. |
--json | Output the result as JSON. |
# List members for the linked project
vercel project members
# List members for a named project as JSON
vercel project members my-project --json
# Add a member to a project by email
vercel project members add my-project user@example.com --role PROJECT_VIEWER
# Add a member by username (the role is case-insensitive)
vercel project members add my-project octocat --role admin
# Remove a member from a project
vercel project members remove my-project user@example.com
# Remove a member by username
vercel project members remove my-project octocatList access groups for a project. Here [name] is the project (name or ID), not an access group; omit it to use the linked project.
vercel project access-groups [name] [options]| Option | Description |
|---|---|
-q, --query | Search access groups by name. |
--limit | Limit number of access groups returned (1-100). |
--next | Show the next page of results. Pass the cursor that the previous page prints. |
--json | Output the result as JSON. |
# List access groups for the linked project
vercel project access-groups
# List access groups for a named project as JSON
vercel project access-groups my-project --jsonShow member counts by team role for project access. Requires the access groups entitlement.
vercel project access-summary [name] [options]| Option | Description |
|---|---|
--json | Output the result as JSON. |
# Summary for the linked project
vercel project access-summary
# Summary for a named project as JSON
vercel project access-summary my-app --jsonEnable or disable Web Analytics for a project. The action can be enable or disable. When omitted, the command enables Web Analytics. When name is omitted, the command uses the linked project.
vercel project web-analytics [action] [name] [options]enable runs without a confirmation prompt. On Hobby, Web Analytics is free within the documented limits. On Pro and Enterprise, enabling incurs charges.
disable stops data collection for the project and asks for confirmation. To skip the prompt, pass --yes. For a project on a Pro or Enterprise team, also pass --scope with the team. The --json option only changes the output format and doesn't skip the confirmation.
| Option | Description |
|---|---|
-y, --yes | Skip the confirmation prompt for disable. |
--json | Output the result as JSON. |
# Enable for the linked project
vercel project web-analytics
# Enable for a named project
vercel project web-analytics enable my-project
# Disable for a named project
vercel project web-analytics disable my-project
# Disable without a prompt and print the result as JSON
vercel project web-analytics disable my-project --yes --scope my-team --jsonUpgrade a project to Speed Insights Plus, or downgrade to the Speed Insights free tier. The action can be enable or disable. When omitted, the command upgrades the project to Speed Insights Plus. When name is omitted, the command uses the linked project.
vercel project speed-insights [action] [name] [options]Both enable and disable ask for confirmation and have no flag to skip it, so run the command in an interactive terminal. enable upgrades the project to Speed Insights Plus. Vercel bills Speed Insights Plus usage on Pro and Enterprise. Teams on Hobby must upgrade to Pro before continuing. disable downgrades the project to the Speed Insights free tier.
Data collection continues under the free tier, subject to your team's allocation limits. To stop automatic collection from new visits to the updated deployment, remove Speed Insights instrumentation and redeploy.
The --json option only changes the output format, and the confirmation comes first. The JSON enabled field reports the project's Plus status. Data collection can continue when this field is false.
| Option | Description |
|---|---|
--json | Output the result as JSON. |
# Upgrade the linked project to Plus
vercel project speed-insights
# Upgrade a named project to Plus
vercel project speed-insights enable my-project
# Downgrade a named project to the free tier
vercel project speed-insights disable my-project
# Downgrade to the free tier and print the result as JSON
vercel project speed-insights disable my-project --jsonEnable or disable Observability Plus for a project. The action argument is required and must be enable or disable. When name is omitted, the command uses the linked project.
vercel project observability <action> [name] [options]Enabling Observability Plus incurs charges on your account and requires a Pro or Enterprise team. enable runs without a confirmation prompt. disable asks for confirmation. To skip the prompt, pass --yes, and for a team project also pass --scope with the team.
| Option | Description |
|---|---|
-y, --yes | Skip the confirmation prompt for disable. |
--json | Output the result as JSON. |
# Enable for the linked project
vercel project observability enable
# Disable for a named project
vercel project observability disable my-project
# Disable without a prompt and print the result as JSON
vercel project observability disable my-project --yes --scope my-team --jsonPause production traffic for a project. While paused, the production deployment stops serving traffic and visitors see an error page. Defaults to the linked project.
Because pausing takes production offline, the command always asks you to type the project name to confirm. There is no flag to skip the confirmation, so run the command in an interactive terminal.
vercel project pause [project] [options]| Option | Description |
|---|---|
--json | Output the result as JSON. |
# Pause the linked project
vercel project pause
# Pause a project by name
vercel project pause my-project
# Pause a project and print the result as JSON
vercel project pause my-project --jsonResume production traffic for a paused project. Defaults to the linked project. Resuming a single project doesn't ask for confirmation.
vercel project resume [project...] [options]To resume several projects at once, name each project, or pass --all to resume every paused project in the team. With --all, or when more than one of the named projects is paused, the command asks for confirmation once before it resumes them. The command skips projects that aren't paused. To see which projects are paused, run vercel project list --paused.
| Option | Description |
|---|---|
--all | Resume every paused project in the team. Can't be combined with project names. |
-y, --yes | Skip the confirmation prompt when you resume several projects. With --all, also pass --scope with the team. |
--json | Output the result as JSON. |
# Resume the linked project
vercel project resume
# Resume a project by name
vercel project resume my-project
# Resume every paused project in the team
vercel project resume --all
# Resume every paused project in a team without a prompt
vercel project resume --all --yes --scope my-team
# Resume a project and print the result as JSON
vercel project resume my-project --jsonGet a development OIDC token for a project. Useful when you need a project-scoped token from a script or CI environment without going through the dashboard.
vercel project token [name] [options]| Option | Description |
|---|---|
-y, --yes | Skip the confirmation prompt. |
--json | Output the result as JSON. |
# Token for the linked project
vercel project token
# Token for a named project
vercel project token my-project
# Token as JSON
vercel project token my-project --jsonThe following global options can be passed when using the vercel project command:
For more information on global options and their usage, refer to the options section.
Was this helpful?