vercel-deploy

Automates Vercel deployments and returns Preview and Claim URLs from directories or tarballs.

Updated Oct 31, 2024
One-click install
npx skills add https://github.com/thesammykins/dotfiles --skill vercel-deploy-thesammykins
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vercel-deploy
Source: https://github.com/thesammykins/dotfiles/tree/main/.agents/skills/vercel-deploy
Command: npx skills add https://github.com/thesammykins/dotfiles --skill vercel-deploy-thesammykins

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Deploying projects to Vercel often requires setup, authentication, and manual bundling. This skill streamlines the process by packaging the project, detecting the framework, and returning ready-to-use Preview and Claim URLs without extra setup.

Core Features & Use Cases

  • Automatic packaging: Creates a deployment package from a project or tarball, excluding node_modules, .git, and sensitive files.
  • Framework detection: Inspects package.json to determine the correct deployment flow for Next.js, Nuxt, SvelteKit, etc.
  • Live results: Returns a Preview URL for sharing and a Claim URL for transferring deployment ownership.
  • Ease of use: Works from a directory or an existing tarball, with optional static HTML handling for single-file sites.

Quick Start

Run the bundled deploy script from your project directory to publish to Vercel and obtain the Preview URL.

Frequently Asked Questions about vercel-deploy

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deploy a project to Vercel and get a live preview URL?

To deploy a project to Vercel and get a live preview URL, run the deployment script from your project directory. It automatically packages your files, detects the framework, and returns a ready-to-use Preview URL along with a Claim URL.

Can I deploy an existing tarball to Vercel without manual bundling?

Yes, you can deploy an existing tarball to Vercel without manual bundling. The deployment process accepts tarballs directly, automatically detecting the framework from package.json and returning a live Preview URL and Claim URL.

Does the Vercel deployment script support Next.js, Nuxt, and SvelteKit?

Yes, the Vercel deployment script supports Next.js, Nuxt, and SvelteKit. It automatically detects the correct deployment flow by inspecting your project's package.json to apply the appropriate framework configurations.

What files are excluded when packaging a project for Vercel deployment?

When packaging a project for Vercel deployment, node_modules, .git directories, and sensitive environment files are excluded. This ensures the deployment package remains lightweight and secure while satisfying Vercel's packaging rules.

How do I transfer ownership of a Vercel preview deployment?

To transfer ownership of a Vercel preview deployment, use the Claim URL provided in the JSON output. The deployment script returns both a Preview URL for sharing and a Claim URL specifically for transferring deployment ownership.

What is the best way to deploy static HTML files to Vercel?

The best way to deploy static HTML files to Vercel is using an automated deployment script that handles optional static HTML packaging. It bundles single-file sites and returns live Preview URLs without requiring extra setup or manual configuration.