vercel integration

The vercel integration command manages marketplace integrations. Use it to provision resources, browse available integrations, view setup guides, check billing balances, and more.

It supports the following subcommands:

• add: Provision a new resource from a marketplace integration
• list: List installed resources
• discover: Browse available marketplace integrations
• guide: View getting started guides and code snippets
• balance: Check balances and thresholds
• open: Open a provider's dashboard via SSO
• remove: Uninstall an integration

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 (alias: vercel i).

In a terminal, this command prompts for choices like billing plan and metadata. 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.

vercel integration add <integration-name>

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

vercel integration add <integration>/<product>

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)

# 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 --metadata region=us-east-1
vercel integration add neon -m region=us-east-1 -m version=16
 
# Provision with a specific billing plan
vercel integration add neon --plan pro
 
# Connect to specific environments only
vercel integration add neon --environment production
vercel integration add neon -e production -e preview
 
# 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_
 
# Show available products and metadata keys
vercel integration add neon --help

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

Alias: vercel integration ls

vercel integration list [project-name]

The output includes the name, status, product, integration, and connected projects for each resource.

# List resources for the current project
vercel integration list
 
# Filter to a specific integration
vercel integration list --integration neon
vercel integration list -i upstash
 
# List all resources across the team
vercel integration list --all
 
# Output as JSON
vercel integration list --format=json

This command lists available marketplace integrations and their products. Use this to find integrations you can install.

vercel integration discover

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

# Browse available integrations
vercel integration discover
 
# Output as JSON
vercel integration discover --format=json

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

vercel integration guide <integration-name>

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

vercel integration guide <integration>/<product>

# 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.

vercel integration balance <integration-name>

# View balances for an integration
vercel integration balance neon
 
# Output as JSON
vercel integration balance neon --format=json

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

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

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.

# 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 --format=json

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

vercel integration remove <integration-name>

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

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

• --cwd
• --debug
• --global-config
• --help
• --local-config
• --no-color
• --scope
• --token

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