Skip to content
Docs

vercel integration

The vercel integration command manages marketplace integrations. Use it to provision resources, browse available integrations, view setup guides, check billing balances, and manage individual resources with the nested resource subcommand.

It supports the following subcommands:

  • add: Provision a new resource from a marketplace integration
  • accept-terms: Accept marketplace legal terms and install an integration on the team
  • list: List installed resources
  • installations: List marketplace integration installations for the team
  • discover: Browse available marketplace integrations
  • categories: List available marketplace categories
  • guide: View getting started guides and code snippets
  • balance: Check balances and thresholds
  • open: Open a provider's dashboard via SSO
  • update: Update a marketplace integration installation
  • remove: Uninstall an integration
  • resource: Manage individual resources (connect, disconnect, delete, create-threshold, claim, inspect)

For the <integration-name> in commands below, use the integration's URL slug. You can find the slug in the Marketplace URL. For example, for https://vercel.com/marketplace/neon, the slug is neon. You can also browse available integrations with the integration discover command.

This command provisions a new resource from a marketplace integration. If the integration isn't installed on your team yet, it installs it first.

Also available as vercel install.

In a terminal, this command prompts for choices like which product to provision and whether to accept the integration's terms. You can provide options as flags to reduce prompts. In non-interactive environments (CI pipelines, scripted usage), provide required options via flags. The command detects non-interactive terminals and skips interactive prompts.

terminal
vercel integration add <integration-name>

Provision a new resource from a marketplace integration.

You can target a specific product from a multi-product integration using the slash syntax:

terminal
vercel integration add <integration>/<product>

Provision a specific product from a multi-product integration.

Run vercel integration add <integration-name> --help to see available products, metadata options, and billing plans an integration offers.

OptionShorthandDescription
--nameCustom name for the resource. Auto-generated if not provided.
--metaMetadata as KEY=VALUE. Can be repeated for multiple keys.
--billing-planBilling plan ID to use for the resource.
--environment-eEnvironments to connect. Accepts production, preview, development, or a Custom Environment slug or ID from the linked project. Can be repeated. Defaults to all three built-in environments.
--prefixPrefix for environment variable names. The prefix is used as-is, so include a trailing underscore if you want a separator (e.g., --prefix NEON2_ creates NEON2_DATABASE_URL). Must start with a letter and contain only letters, digits, and underscores.
--jsonOutput as JSON.
--no-connectSkip connecting the resource to the current project. Also skips env pull.
--no-env-pullSkip running vercel env pull after provisioning.
--installationInstallation ID to use when multiple installations exist for the same integration.
--claim, --no-claimWhether to claim the new resource when it is a sandbox. --claim claims it immediately after provisioning without prompting. --no-claim skips the offer to claim it and prints a hint about how to claim it later. If you pass neither and run the command in a terminal without --json, it asks whether to claim it.

Passing both --claim and --no-claim exits with code 2 and the error Cannot use both --claim and --no-claim.. In non-interactive environments, if you provision a sandbox resource without --claim or --no-claim, the command prints a hint pointing to claim instead of prompting.

Custom Environment slugs and IDs must belong to the linked project. If you pass a slug, the CLI resolves the slug to the environment's stable ID before sending the connection request. If you omit --environment, the command connects production, preview, and development. The default does not include Custom Environments.

After provisioning a resource, the command:

  1. Prints a link to the resource in the Vercel dashboard
  2. Connects the resource to the currently linked project (unless --no-connect is set)
  3. Runs vercel env pull to sync environment variables (unless --no-env-pull or --no-connect is set)
terminal
# Provision a resource interactively
vercel integration add neon
 
# Target a specific product from a multi-product integration
vercel integration add acme/acme-redis
 
# Provision with a custom resource name
vercel integration add neon --name my-database
 
# Provision with metadata options
vercel integration add neon --meta region=us-east-1
vercel integration add neon --meta region=us-east-1 --meta version=16
 
# Provision with a specific billing plan
vercel integration add neon --billing-plan pro
 
# Connect to specific environments only
vercel integration add neon --environment production
vercel integration add neon -e production -e preview
 
# Connect to a Custom Environment in the linked project
vercel integration add neon --environment staging
 
# Provision without connecting to the current project
vercel integration add neon --no-connect
 
# Provision without pulling environment variables
vercel integration add neon --no-env-pull
 
# Use a prefix for environment variable names
vercel integration add neon --prefix NEON2_
 
# Skip the claim offer when provisioning a sandbox resource (good for CI)
vercel integration add shopify --no-claim
 
# Show available products and metadata keys
vercel integration add neon --help

This command accepts a marketplace integration's legal terms and installs the integration on the current team without provisioning a product resource. Use this when you only need the team-level installation; add installs the integration and provisions a resource in one step.

This command requires an interactive terminal and human confirmation. For the neon integration only, you can pass --yes to accept the terms without the confirmation prompt. This command does not replace integrations that require a browser flow or device attestation.

terminal
vercel integration accept-terms <integration>

Accept marketplace terms and install an integration on the team.

ArgumentRequiredDescription
integrationYesIntegration slug (for example, neon) or ID.
OptionShorthandDescription
--yes-yAccept the terms without a confirmation prompt. Only supported for the neon integration.
--jsonOutput as JSON.
terminal
# Accept terms interactively and install on the team
vercel integration accept-terms neon
 
# Accept terms without a prompt (neon only)
vercel integration accept-terms neon --yes
 
# Output result as JSON
vercel integration accept-terms neon --json

This command lists installed resources with their associated integrations. By default, shows resources for the currently linked project.

Alias: vercel integration ls

terminal
vercel integration list [project]

List integration resources for the current project.

The output includes the name, status, product, integration, and connected projects for each resource. Unclaimed sandbox marketplace resources are marked with a yellow [SANDBOX] tag in the Status column. When the listing contains one or more sandbox resources, a hint below the table shows how many can be claimed and points to claim.

When you pass --json, each sandbox resource includes a claim_status: "sandbox" field. The field is omitted for non-sandbox resources.

ArgumentRequiredDescription
projectNoProject name to filter resources by, for example my-app (the name shown in the dashboard and vercel project list). Uses the linked project if omitted.
OptionShorthandDescription
--integrationFilter resources to a specific integration.
--all-aList all resources regardless of project. Cannot be used with [project].
--jsonOutput as JSON.
terminal
# List resources for the current project
vercel integration list
 
# Filter to a specific project by name
vercel integration list my-app
 
# Filter to a specific integration
vercel integration list --integration neon
 
# List all resources across the team
vercel integration list --all
 
# Output as JSON
vercel integration list --json

This command lists marketplace integration installations for the current team. Use this when you need to see the team-level account-scope state (what integrations are installed) rather than the project-scope resources that list shows.

terminal
vercel integration installations [options]

List marketplace integration installations for the team.

Alias: vercel integration installation.

OptionShorthandDescription
--integrationLimit to installations of this integration. Accepts a slug or ID.
--jsonOutput as JSON.
terminal
# List all marketplace installations for the team
vercel integration installations
 
# Filter by integration slug
vercel integration installations --integration neon
 
# JSON output
vercel integration installations --json

This command lists available marketplace integrations and their products. Use this to find integrations you can install. Pass an optional query to filter results.

terminal
vercel integration discover [query]

Browse available marketplace integrations.

For multi-product integrations, each product appears separately with a compound slug (for example, aws/aws-dynamodb). Single-product integrations where the product slug matches the integration slug show only the integration slug.

ArgumentRequiredDescription
queryNoFilter integrations by substring against the integration slug, product slug, name, or description.
OptionShorthandDescription
--categoryFilter integrations by category. Can be repeated to match any value from a list (e.g., --category storage --category ai).
--jsonOutput as JSON.

Run vercel integration categories to see the available category values.

terminal
# Browse all available integrations
vercel integration discover
 
# Filter by search term
vercel integration discover postgres
vercel integration discover aws
 
# Filter integrations by category
vercel integration discover --category storage
 
# Match any of multiple categories (repeat the flag)
vercel integration discover --category storage --category ai
vercel integration discover --category commerce --category payments --category authentication
 
# Output as JSON
vercel integration discover --json

This command lists the categories that marketplace integrations are grouped into. Use the output to find valid values for discover --category.

terminal
vercel integration categories

List the categories available for filtering marketplace integrations.

The output includes the category slug (the value you pass to --category) and the category title.

OptionShorthandDescription
--jsonOutput as JSON.
terminal
# List all marketplace categories
vercel integration categories
 
# Output as JSON
vercel integration categories --json

This command shows getting started guides and code snippets for using a marketplace integration in your project.

terminal
vercel integration guide <integration-name>

View setup guides for a marketplace integration.

You can also target a specific product from a multi-product integration:

terminal
vercel integration guide <integration>/<product>
OptionShorthandDescription
--frameworkSelect a framework guide without prompts (e.g., nextjs, remix, astro, nuxtjs, sveltekit).
terminal
# View guides for an integration
vercel integration guide neon
 
# View guides for a specific product
vercel integration guide aws/aws-dynamodb
 
# View the Next.js guide without prompts
vercel integration guide neon --framework nextjs

This command shows the balances and thresholds for a marketplace integration, including prepayment details.

terminal
vercel integration balance <integration-name>

View billing balances and auto-recharge thresholds for a marketplace integration.

This command only applies to integrations that support prepayment billing plans.

OptionShorthandDescription
--jsonOutput as JSON.
terminal
# View balances for an integration
vercel integration balance neon
 
# Output as JSON
vercel integration balance neon --json

This command opens the provider's dashboard for an integration or a specific resource via SSO.

terminal
vercel integration open <integration-name> [resource-name]

Open the provider's dashboard via single sign-on.

When called without a resource name, it opens the integration's dashboard. When called with a resource name, it opens the dashboard for that specific resource.

OptionShorthandDescription
--jsonOutput the SSO link as JSON.
terminal
# Open the integration's dashboard
vercel integration open neon
 
# Open a specific resource's dashboard
vercel integration open neon my-neon-database
 
# Get the SSO link as JSON (useful in scripts)
vercel integration open neon --json

This command updates an existing marketplace integration installation. Use it to change the billing plan or the set of projects that can access the integration.

update does not handle install, remove, or connect flows. Use integration add to install, integration remove to uninstall, and integration resource, env pull, or related commands to manage resources. UI-only flows (browser OAuth, consent screens, marketplace purchase) may not map one-to-one to a single CLI flag; pass --billing-plan and --authorization when the product requires them for billing changes.

terminal
vercel integration update <integration> [options]

Update an existing marketplace integration installation.

ArgumentRequiredDescription
integrationYesIntegration slug (for example, neon) or ID.
OptionShorthandDescription
--billing-plan-Billing plan ID for integrations that support installation-level billing plans.
--authorization-Billing authorization ID when the platform requires it for plan changes.
--projects-Project ID allowed to use this installation. Pass all for all projects. Repeatable.
--installation-Configuration ID when multiple marketplace installations exist for this integration.
--json-Output as JSON.
terminal
# Grant all team projects access to the integration
vercel integration update neon --projects all
 
# Limit access to specific projects
vercel integration update neon --projects prj_abc --projects prj_def
 
# Change installation billing plan
vercel integration update acme --billing-plan pro
 
# Select installation when several exist
vercel integration update neon --installation icfg_xxx --projects all
 
# Output result as JSON
vercel integration update neon --projects all --json
 
# Non-interactive (JSON success and errors on stdout)
vercel integration update neon --projects all --non-interactive

Uninstalls a marketplace integration from your team. You must delete all resources from the integration before running this command.

terminal
vercel integration remove <integration-name>

Uninstall a marketplace integration.

OptionShorthandDescription
--yes-ySkip the confirmation prompt.
--jsonOutput as JSON.

Non-interactive environments and JSON output mode require the --yes flag.

terminal
# Uninstall an integration
vercel integration remove neon
 
# Uninstall without confirmation
vercel integration remove neon --yes
 
# Output as JSON
vercel integration remove neon --json --yes

The vercel integration resource command manages individual resources provisioned from marketplace integrations: connect resources to projects, disconnect them, delete them, configure auto-recharge thresholds, claim sandbox resources, and show a resource's details and live status.

It supports the following subcommands:

  • connect: Connect a resource to a project
  • disconnect: Disconnect a resource from a project
  • delete: Delete a resource
  • create-threshold: Set up auto-recharge for prepaid resources
  • claim: Claim a sandbox marketplace resource
  • inspect: Show a resource's details and live status

In the examples below, <resource-name> (for example, my-database) is the name of a marketplace resource you've already provisioned. Run vercel integration list to see the names of your resources. <project> (for example, my-project) is a project's name or ID. Run vercel project list to list them, or find a project's ID in the Vercel dashboard under Settings → General.

This command connects an existing marketplace resource to a project. If you don't specify a project, the command connects to the currently linked project.

terminal
vercel integration resource connect <resource-name> [project]

Connect a marketplace resource to a project.

ArgumentRequiredDescription
resource-nameYesName of the resource to connect (for example, my-database).
projectNoProject name (for example, my-project) or project ID (for example, prj_abc123) to connect to. Uses the linked project if omitted.
OptionShorthandDescription
--environment-eEnvironments to connect. Accepts production, preview, development, or a Custom Environment slug or ID from the target project. Can be repeated. Defaults to all three built-in environments.
--prefixPrefix for environment variable names. The prefix is used as-is, so include a trailing underscore if you want a separator (e.g., --prefix NEON2_ creates NEON2_DATABASE_URL). Must start with a letter and contain only letters, digits, and underscores.
--yes-ySkip the confirmation prompt.
--jsonOutput as JSON. Requires --yes.

Non-interactive environments and JSON output mode require the --yes flag. When --yes is missing in non-interactive mode, the command prints a JSON error with reason: "confirmation_required" and a next array containing the suggested command, then exits with code 1.

Custom Environment slugs and IDs must belong to the target project. If you pass a slug, the CLI resolves the slug to the environment's stable ID before sending the connection request. If you omit the project argument, the command uses the linked project. If you omit --environment, the command connects production, preview, and development. The default does not include Custom Environments.

If connecting would create an environment variable name that already exists on the project, the command exits with an error that names the conflicting variable, the project, and the affected environments. The follow-up message suggests either passing a --prefix to namespace the new variables, or removing the existing variable with vercel env remove.

terminal
# Connect to the currently linked project across all three built-in environments
vercel integration resource connect my-database
 
# Connect to a specific project
vercel integration resource connect my-database my-project
 
# Limit to specific environments
vercel integration resource connect my-database --environment production
vercel integration resource connect my-database -e production -e preview
 
# Connect to a Custom Environment by slug
vercel integration resource connect my-database --environment staging
 
# Use a prefix to avoid environment variable collisions
vercel integration resource connect my-database --prefix NEON2_
 
# Output as JSON (requires --yes)
vercel integration resource connect my-database --yes --json

This command disconnects a resource from a project. If you don't specify a project, the command disconnects from the currently linked project.

terminal
vercel integration resource disconnect <resource-name> [project]

Disconnect a resource from a project.

If the specified project is not currently connected to the resource, the command exits with code 1 and an error like Project <name> is not connected to resource <resource>. Run vercel integration list to see which projects are connected to each resource.

ArgumentRequiredDescription
resource-nameYesName of the resource to disconnect (for example, my-database).
projectNoProject name (for example, my-project) or project ID (for example, prj_abc123) to disconnect from. Uses the linked project if omitted.
OptionShorthandDescription
--allDisconnect all projects from the resource.
--yes-ySkip the confirmation prompt.
--jsonOutput as JSON.

Non-interactive environments and JSON output mode require the --yes flag. When --yes is missing in non-interactive mode, the command prints a JSON error with reason: "confirmation_required" and a next array containing the suggested command, then exits with code 1.

terminal
# Disconnect from the currently linked project
vercel integration resource disconnect my-database
 
# Disconnect from a specific project
vercel integration resource disconnect my-database my-project
 
# Disconnect all projects from the resource
vercel integration resource disconnect my-database --all
 
# Disconnect all without confirmation
vercel integration resource disconnect my-database --all --yes
 
# Output as JSON
vercel integration resource disconnect my-database --all --yes --json

This command deletes an integration resource permanently.

Alias: vercel integration resource rm

terminal
vercel integration resource delete <resource-name>

Delete an integration resource.

If the resource has connected projects, you must disconnect them first or use the --disconnect-all flag.

OptionShorthandDescription
--disconnect-allDisconnect all projects from the resource before deletion.
--yes-ySkip the confirmation prompt.
--jsonOutput as JSON.

Non-interactive environments and JSON output mode require the --yes flag.

terminal
# Delete a resource
vercel integration resource delete my-database
 
# Disconnect all projects and delete in one step
vercel integration resource delete my-database --disconnect-all
 
# Delete without confirmation
vercel integration resource delete my-cache --disconnect-all --yes
 
# Output as JSON
vercel integration resource delete my-cache --disconnect-all --yes --json

Sets up an auto-recharge threshold for a prepaid resource. When the resource's balance drops below the minimum, it automatically purchases additional credit.

If the resource uses installation-level billing, the threshold applies to all resources under that installation.

terminal
vercel integration resource create-threshold <resource-name> <minimum> <spend> <limit>

Configure auto-recharge for a prepaid resource.

ArgumentRequiredDescription
resource-nameYesName of the resource to configure.
minimumYesDollar amount that triggers a recharge (e.g., 50 for $50.00). Decimals supported (e.g., 5.75).
spendYesDollar amount to purchase when the threshold is triggered (e.g., 100 for $100.00). Decimals supported.
limitYesMaximum spend per billing period in dollars (e.g., 2000 for $2,000.00). Decimals supported.
OptionShorthandDescription
--yes-ySkip the confirmation prompt.

Non-interactive environments require the --yes flag.

  • All amounts must be non-negative numbers.
  • minimum must be less than or equal to spend.
  • minimum must be less than or equal to limit.
  • limit must be greater than or equal to spend.
  • The spend amount must fall within the billing plan's allowed range.
terminal
# Set up auto-recharge: top up $100 when balance drops below $50, max $2000/period
vercel integration resource create-threshold my-database 50 100 2000
 
# Skip confirmation
vercel integration resource create-threshold my-database 50 100 2000 --yes

This command claims a sandbox marketplace resource by opening the provider's claim URL in your browser and polling until ownership transfers from sandbox to your team.

terminal
vercel integration resource claim [resource-name]

Claim a sandbox marketplace resource.

When you omit the resource name, the command picks the right resource based on how many sandbox resources exist on the current project:

Sandbox resourcesBehavior
0Prints No sandbox resources to claim in the current project. and exits with code 0.
1Prompts to confirm claiming that resource. Skip the prompt with --yes.
2 or moreShows an interactive picker.

After the browser opens, the command polls for up to five minutes for ownership to transfer. Pressing Ctrl-C cancels the wait and exits with code 130.

ArgumentRequiredDescription
resource-nameNoName of the sandbox resource to claim. If omitted, the command picks interactively (see above).
OptionShorthandDescription
--yes-yWhen exactly one sandbox resource exists and no name was passed, skip the single-resource confirmation prompt. Does not affect the multi-resource picker.
--no-waitPrint the claim URL and exit immediately without opening the browser or polling for completion.
--jsonOutput as JSON.

In non-interactive mode, the command prints a JSON payload with reason: "integration_sandbox_claim_required" and verification_uri set to the claim URL, then exits with code 1.

After claiming, run vercel integration list to confirm the resource's ownership has transferred. You can also have vercel integration add start the claim flow automatically with --claim.

terminal
# Pick a sandbox resource interactively
vercel integration resource claim
 
# Claim a specific resource
vercel integration resource claim my-stripe-sandbox
 
# Get the claim URL without waiting (useful in scripts and CI)
vercel integration resource claim my-stripe-sandbox --no-wait
 
# Output the URL as JSON
vercel integration resource claim my-stripe-sandbox --no-wait --json

This command shows a resource's details and its live status. Vercel fetches the status from the provider when you run the command:

terminal
vercel integration resource inspect <resource-name>

Show a resource's details and live status.

The output shows the resource's status, ownership, product, integration, billing plan, and ID. It also shows a link to the resource in the Vercel dashboard and the projects that the resource is connected to, with their environments. For a sandbox resource, the output also tells you how to claim it.

ArgumentRequiredDescription
resource-nameYesName of the resource to inspect (for example, my-database).
OptionShorthandDescription
--jsonOutput as JSON.
terminal
# Show a resource's details and live status
vercel integration resource inspect my-database
 
# Output as JSON
vercel integration resource inspect my-database --json

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

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

Last updated September 17, 2026

Was this helpful?

supported.