deploy-to-vercel
vercel-labs/agent-skills
Deploy applications to Vercel with git integration or direct CLI deployment.
What is deploy-to-vercel?
Deploys projects to Vercel as preview deployments by default. Handles authentication, project linking, and git-based deployments. Use when users request deployment actions like "deploy my app", "push this live", or "create a preview deployment".
- Deploy projects to Vercel as preview or production deployments
- Automatically link projects to Vercel for git-based continuous deployment
- Detect project state (git remote, CLI auth, Vercel linking) and choose optimal deploy method
- Support team/organization selection for multi-team accounts
- Retrieve deployment URLs and check deployment status
- Fallback to no-auth deployment in sandboxed environments
How to install deploy-to-vercel
npx skills add https://github.com/vercel-labs/agent-skills --skill deploy-to-vercel- Vercel CLI installed (npm install -g vercel) for full functionality
- Vercel account (free or paid)
- Git repository (optional; direct deployment works without git)
How to use deploy-to-vercel
- 1.Run project state checks to determine if the project is linked and authenticated
- 2.If not authenticated, run 'vercel login' to authenticate with Vercel
- 3.If multiple teams exist, select which team to deploy to
- 4.If project is not linked, run 'vercel link' or 'vercel link --repo' to link it
- 5.Commit and push changes (if git remote exists) or run 'vercel deploy -y --no-wait' for direct deployment
- 6.Retrieve the deployment URL from CLI output or Vercel dashboard
Use cases
- Deploy a web application to Vercel and get a shareable preview URL
- Link a git repository to Vercel for automatic deployments on push
- Deploy a project without git integration using direct CLI deployment
- Transfer a deployment to your Vercel account using a claim URL
- Check deployment status and build logs after pushing to production
- Web developers deploying applications
- Teams managing multiple Vercel projects
- Users new to Vercel looking to set up continuous deployment
- Developers in sandboxed or non-interactive environments
deploy-to-vercel FAQ
Always deploy as preview unless the user explicitly requests production. Preview deployments are safer for testing.
Run 'npm install -g vercel' to install it. If in a sandboxed environment where CLI can't be authenticated, use the no-auth fallback script.
Link your project with 'vercel link --repo' (if you have a git remote). Then commits and pushes to your repository will automatically trigger Vercel deployments.
.vercel/project.json is created by 'vercel link' for single project linking. .vercel/repo.json is created by 'vercel link --repo' for repo-based linking with automatic git integration. Either file means the project is linked.
Yes, use the no-auth fallback script (bash /mnt/skills/user/deploy-to-vercel/resources/deploy.sh) which returns a preview URL and claim URL to transfer the deployment to your account later.
Full instructions (SKILL.md)
Source of truth, from vercel-labs/agent-skills.
name: deploy-to-vercel description: Deploy applications and websites to Vercel. Use when the user requests deployment actions like "deploy my app", "deploy and give me the link", "push this live", or "create a preview deployment". metadata: author: vercel version: "3.0.0"
Deploy to Vercel
Deploy any project to Vercel. Always deploy as preview (not production) unless the user explicitly asks for production.
The goal is to get the user into the best long-term setup: their project linked to Vercel with git-push deploys. Every method below tries to move the user closer to that state.
Step 1: Gather Project State
Run all four checks before deciding which method to use:
# 1. Check for a git remote
git remote get-url origin 2>/dev/null
# 2. Check if locally linked to a Vercel project (either file means linked)
cat .vercel/project.json 2>/dev/null || cat .vercel/repo.json 2>/dev/null
# 3. Check if the Vercel CLI is installed and authenticated
vercel whoami 2>/dev/null
# 4. List available teams (if authenticated)
vercel teams list --format json 2>/dev/null
Team selection
If the user belongs to multiple teams, present all available team slugs as a bulleted list and ask which one to deploy to. Once the user picks a team, proceed immediately to the next step — do not ask for additional confirmation.
Pass the team slug via --scope on all subsequent CLI commands (vercel deploy, vercel link, vercel inspect, etc.):
vercel deploy [path] -y --no-wait --scope <team-slug>
If the project is already linked (.vercel/project.json or .vercel/repo.json exists), the orgId in those files determines the team — no need to ask again. If there is only one team (or just a personal account), skip the prompt and use it directly.
About the .vercel/ directory: A linked project has either:
.vercel/project.json— created byvercel link(single project linking). ContainsprojectIdandorgId..vercel/repo.json— created byvercel link --repo(repo-based linking). ContainsorgId,remoteName, and aprojectsarray mapping directories to Vercel project IDs.
Either file means the project is linked. Check for both.
Do NOT use vercel project inspect, vercel ls, or vercel link to detect state in an unlinked directory — without a .vercel/ config, they will interactively prompt (or with --yes, silently link as a side-effect). Only vercel whoami is safe to run anywhere.
Step 2: Choose a Deploy Method
Linked (.vercel/ exists) + has git remote → Git Push
This is the ideal state. The project is linked and has git integration.
-
Ask the user before pushing. Never push without explicit approval:
This project is connected to Vercel via git. I can commit and push to trigger a deployment. Want me to proceed? -
Commit and push:
git add . git commit -m "deploy: <description of changes>" git pushVercel automatically builds from the push. Non-production branches get preview deployments; the production branch (usually
main) gets a production deployment. -
Retrieve the preview URL. If the CLI is authenticated:
sleep 5 vercel ls --format jsonThe JSON output has a
deploymentsarray. Find the latest entry — itsurlfield is the preview URL.If the CLI is not authenticated, tell the user to check the Vercel dashboard or the commit status checks on their git provider for the preview URL.
Linked (.vercel/ exists) + no git remote → vercel deploy
The project is linked but there's no git repo. Deploy directly with the CLI.
vercel deploy [path] -y --no-wait
Use --no-wait so the CLI returns immediately with the deployment URL instead of blocking until the build finishes (builds can take a while). Then check on the deployment status with:
vercel inspect <deployment-url>
For production deploys (only if user explicitly asks):
vercel deploy [path] --prod -y --no-wait
Not linked + CLI is authenticated → Link first, then deploy
The CLI is working but the project isn't linked yet. This is the opportunity to get the user into the best state.
-
Ask the user which team to deploy to. Present the team slugs from Step 1 as a bulleted list. If there's only one team (or just a personal account), skip this step.
-
Once a team is selected, proceed directly to linking. Tell the user what will happen but do not ask for separate confirmation:
Linking this project to <team name> on Vercel. This will create a Vercel project to deploy to and enable automatic deployments on future git pushes. -
If a git remote exists, use repo-based linking with the selected team scope:
vercel link --repo --scope <team-slug>This reads the git remote URL and matches it to existing Vercel projects that deploy from that repo. It creates
.vercel/repo.json. This is much more reliable thanvercel link(without--repo), which tries to match by directory name and often fails when the local folder and Vercel project are named differently.If there is no git remote, fall back to standard linking:
vercel link --scope <team-slug>This prompts the user to select or create a project. It creates
.vercel/project.json. -
Then deploy using the best available method:
- If a git remote exists → commit and push (see git push method above)
- If no git remote →
vercel deploy [path] -y --no-wait --scope <team-slug>, thenvercel inspect <url>to check status
Not linked + CLI not authenticated → Install, auth, link, deploy
The Vercel CLI isn't set up at all.
-
Install the CLI (if not already installed):
npm install -g vercel -
Authenticate:
vercel loginThe user completes auth in their browser. If running in a non-interactive environment where login is not possible, skip to the no-auth fallback below.
-
Ask which team to deploy to — present team slugs from
vercel teams list --format jsonas a bulleted list. If only one team / personal account, skip. Once selected, proceed immediately. -
Link the project with the selected team scope (use
--repoif a git remote exists, plainvercel linkotherwise):vercel link --repo --scope <team-slug> # if git remote exists vercel link --scope <team-slug> # if no git remote -
Deploy using the best available method (git push if remote exists, otherwise
vercel deploy -y --no-wait --scope <team-slug>, thenvercel inspect <url>to check status).
No-Auth Fallback — claude.ai sandbox
When to use: Last resort when the CLI can't be installed or authenticated in the claude.ai sandbox. This requires no authentication — it returns a Preview URL (live site) and a Claim URL (transfer to your Vercel account).
bash /mnt/skills/user/deploy-to-vercel/resources/deploy.sh [path]
Arguments:
path- Directory to deploy, or a.tgzfile (defaults to current directory)
Examples:
# Deploy current directory
bash /mnt/skills/user/deploy-to-vercel/resources/deploy.sh
# Deploy specific project
bash /mnt/skills/user/deploy-to-vercel/resources/deploy.sh /path/to/project
# Deploy existing tarball
bash /mnt/skills/user/deploy-to-vercel/resources/deploy.sh /path/to/project.tgz
The script auto-detects the framework from package.json, packages the project (excluding node_modules, .git, .env), uploads it, and waits for the build to complete.
Tell the user: "Your deployment is ready at [previewUrl]. Claim it at [claimUrl] to manage your deployment."
No-Auth Fallback — Codex sandbox
When to use: In the Codex sandbox where the CLI may not be authenticated. Codex runs in a sandboxed environment by default — try the CLI first, and fall back to the deploy script if auth fails.
-
Check whether the Vercel CLI is installed (no escalation needed for this check):
command -v vercel -
If
vercelis installed, try deploying with the CLI:vercel deploy [path] -y --no-wait -
If
vercelis not installed, or the CLI fails with "No existing credentials found", use the fallback script:skill_dir="<path-to-skill>" # Deploy current directory bash "$skill_dir/resources/deploy-codex.sh" # Deploy specific project bash "$skill_dir/resources/deploy-codex.sh" /path/to/project # Deploy existing tarball bash "$skill_dir/resources/deploy-codex.sh" /path/to/project.tgz
The script handles framework detection, packaging, and deployment. It waits for the build to complete and returns JSON with previewUrl and claimUrl.
Tell the user: "Your deployment is ready at [previewUrl]. Claim it at [claimUrl] to manage your deployment."
Escalated network access: Only escalate the actual deploy command if sandboxing blocks the network call (sandbox_permissions=require_escalated). Do not escalate the command -v vercel check.
Agent-Specific Notes
Claude Code / terminal-based agents
You have full shell access. Do NOT use the /mnt/skills/ path. Follow the decision flow above using the CLI directly.
For the no-auth fallback, run the deploy script from the skill's installed location:
bash ~/.claude/skills/deploy-to-vercel/resources/deploy.sh [path]
The path may vary depending on where the user installed the skill.
Sandboxed environments (claude.ai)
You likely cannot run vercel login or git push. Go directly to the no-auth fallback — claude.ai sandbox.
Codex
Codex runs in a sandbox. Check if the CLI is available first, then fall back to the deploy script. Go to the no-auth fallback — Codex sandbox.
Output
Always show the user the deployment URL.
- Git push: Use
vercel ls --format jsonto find the preview URL. If the CLI isn't authenticated, tell the user to check the Vercel dashboard or commit status checks. - CLI deploy: Show the URL returned by
vercel deploy --no-wait. Usevercel inspect <url>to check build status and report it to the user. - No-auth fallback: Show both the preview URL and the claim URL:
Deployment successful! Preview URL: https://my-app-abc123.vercel.app Claim URL: https://vercel.com/claim-deployment?code=... View your site at the Preview URL. To transfer this deployment to your Vercel account, visit the Claim URL.
Do not curl or fetch the deployed URL to verify it works. Just return the link.
Troubleshooting
Network Egress Error (claude.ai)
If deployment fails due to network restrictions on claude.ai, tell the user:
Deployment failed due to network restrictions. To fix this:
1. Go to https://claude.ai/settings/capabilities
2. Add *.vercel.com to the allowed domains
3. Try deploying again
Escalated Network Access (Codex / sandboxed environments)
If deployment fails due to network issues (timeouts, DNS errors, connection resets) in a sandboxed environment, rerun with escalated permissions (sandbox_permissions=require_escalated). Do not escalate the initial CLI availability check — only escalate the actual deploy command.
Example guidance to the user:
The deploy needs escalated network access to deploy to Vercel. I can rerun
the command with escalated permissions — want me to proceed?
CLI Auth Failure
If vercel login or vercel deploy fails with authentication errors, fall back to the no-auth deploy script (claude.ai or Codex variant, depending on the environment).
Related skills
More from vercel-labs/agent-skills and the wider catalog.
vercel-react-best-practices
React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.
web-design-guidelines
Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".
vercel-composition-patterns
Agent skill from vercel-labs/agent-skills.
vercel-react-native-skills
Agent skill from vercel-labs/agent-skills.
vercel-react-view-transitions
Guide for implementing smooth, native-feeling animations using React's View Transition API (`<ViewTransition>` component, `addTransitionType`, and CSS view transition pseudo-elements). Use this skill whenever the user wants to add page transitions, animate route changes, create shared element animations, animate enter/exit of components, animate list reorder, implement directional (forward/back) navigation animations, or integrate view transitions in Next.js. Also use when the user mentions view transitions, `startViewTransition`, `ViewTransition`, transition types, or asks about animating between UI states in React without third-party animation libraries.
vercel-cli-with-tokens
Deploy and manage projects on Vercel using token-based authentication. Use when working with Vercel CLI using access tokens rather than interactive login — e.g. "deploy to vercel", "set up vercel", "add environment variables to vercel".