mcpField
V
vercel-deploy

vercel-deploy

github.com/openaiCloud & DevOps28.4k3.4k installsUpdated 18w ago
Repository

About vercel-deploy

vercel-deploy is a skill for deploying projects to Vercel, using the Vercel CLI when available and a script as an authentication fallback. Deployments default to preview; production deployment requires an explicit request.

Key features

  1. 01Check for Vercel CLI
  2. 02Deploy projects as previews by default
  3. 03Use a script when CLI authentication fails
  4. 04Return preview and claim URLs for fallback deployments
  5. 05Support explicitly requested production deploys

Use cases

  1. 01Create a preview deployment for a project
  2. 02Deploy when the CLI has no credentials
  3. 03Deploy to production when explicitly requested

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/openai/skills --skill vercel-deploy

After installing, type/vercel-deployin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

LICENSE.txt
agents/
openai.yaml
assets/
vercel-small.svg
scripts/
deploy.sh

Details

From the project README

Vercel Deploy

Deploy any project to Vercel instantly. Always deploy as preview (not production) unless the user explicitly asks for production.

Prerequisites

  • Check whether the Vercel CLI is installed without escalated permissions (for example, command -v vercel).
  • Only escalate the actual deploy command if sandboxing blocks the deployment network calls (sandbox_permissions=require_escalated).
  • The deployment might take a few minutes. Use appropriate timeout values.

Quick Start

  1. Check whether the Vercel CLI is installed (no escalation for this check):
command -v vercel
  1. If vercel is installed, run this (with a 10 minute timeout):
vercel deploy [path] -y

Important: Use a 10 minute (600000ms) timeout for the deploy command since builds can take a while.

  1. If vercel is not installed, or if the CLI fails with "No existing credentials found", use the fallback method below.

Fallback (No Auth)

If CLI fails with auth error, use the deploy script:

skill_dir="<path-to-skill>"

# Deploy current directory
bash "$skill_dir/scripts/deploy.sh"

# Deploy specific project
bash "$skill_dir/scripts/deploy.sh" /path/to/project

# Deploy existing tarball
bash "$skill_dir/scripts/deploy.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."

Production Deploys

Only if user explicitly asks:

vercel deploy [path] --prod -y

Output

Show the user the deployment URL. For fallback deployments, also show the claim URL.

Do not curl or fetch the deployed URL to verify it works. Just return the link.

Troubleshooting

Escalated Network Access

If deployment fails due to network issues (timeouts, DNS errors, connection resets), rerun the actual deploy command with escalated permissions (use sandbox_permissions=require_escalated). Do not escalate the command -v vercel installation check. The deploy requires escalated network access when sandbox networking blocks outbound requests.

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?

Comments

Markdown supported