Agent skill

Use Vercel Action

by amondnet in amondnet/vercel-action

Wire amondnet/vercel-action into a GitHub Actions workflow to deploy Vercel projects from CI.

MITAuto-check passedDevOps & Cloud

Install Use Vercel Action

skills CLI
$ npx skills add amondnet/vercel-action --skill use-vercel-action -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install amondnet/vercel-action use-vercel-action --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/amondnet/vercel-action.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/use-vercel-action .claude/skills/use-vercel-action && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
use-vercel-action
GitHub stars
764
Token cost
~2.7k tokens
SKILL.md length
901 words
Files
1
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

Wire amondnet/vercel-action into a GitHub Actions workflow to deploy Vercel projects from CI.

  • Works in 4 steps: Disable Vercel's native auto-deploys in… → Link the project locally and capture the… → GitHub Deployments need explicit… → …
  • The user asks to deploy to Vercel from GitHub Actions
  • SKILL.md covers When to use, When NOT to use, Mandatory prerequisites and Quick start: preview deploy on…, plus 5 more sections
  • Calls vercel and npm; needs VERCEL_TOKEN and GITHUB_TOKEN

What it does

Use Vercel Action is an agent skill from amondnet/vercel-action. Wire amondnet/vercel-action into a GitHub Actions workflow to deploy Vercel projects from CI. Use when the user asks to deploy to Vercel from GitHub Actions, add Vercel preview deploys, post a Vercel preview URL on a PR, configure prebuilt Vercel deployments, set up alias domains for previews, create a GitHub Deployment for Vercel, or migrate off Vercel's native GitHub integration. Covers required tokens/IDs, the CLI vs experimental-API modes, prebuilt flows, alias placeholders, deprecated zeit-/now- aliases, and…

Its SKILL.md is about 2.7k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in DevOps & Cloud, covering Deployment and CI/CD. It works with Vercel, GitHub and GitHub Actions. The repository describes itself as: This action make a deployment with github actions instead of Vercel builder. The licence is MIT.

When your agent uses it

  • The user asks to deploy to Vercel from GitHub Actions
  • Add Vercel preview deploys
  • Post a Vercel preview URL on a PR
  • Configure prebuilt Vercel deployments

Example prompts

  • “/use-vercel-action”

Requirements

  • Node.js
  • A credential in VERCEL_TOKEN
  • A credential in GITHUB_TOKEN

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Disable Vercel's native auto-deploys in the project repo, otherwise both Vercel and the action will deploy and you'll get duplicate…
  2. Link the project locally and capture the IDs. Run vercel link once on a developer machine; this writes .vercel/project.json with projectId…
  3. GitHub Deployments need explicit permission. If you set github-deployment: true, the workflow job must declare permissions: deployments…
  4. Action runtime is Node 24. No consumer-side Node setup is needed for the action itself — the runner provides it.

What it can do on your machine

Read from SKILL.md and the folder at commit 9471a56. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • vercel
    • npm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • vercel.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • VERCEL_TOKEN
    • GITHUB_TOKEN

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Use Vercel Action loads about 2.7k tokens when it runs. Until then it costs about 154 tokens; SKILL.md has 901 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~154
When it runs · the whole SKILL.md, loaded when a task matches
~2.7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from amondnet/vercel-action at commit 9471a56, republished under its MIT licence (© amondnet). 901 words, ~2,676 tokens.

Download SKILL.mdSave it as .claude/skills/use-vercel-action/SKILL.md (or your agent's skills folder).
name
use-vercel-action
description
Wire `amondnet/vercel-action` into a GitHub Actions workflow to deploy Vercel projects from CI. Use when the user asks to deploy to Vercel from GitHub Actions, add Vercel preview deploys, post a Vercel preview URL on a PR, configure prebuilt Vercel deployments, set up alias domains for previews, create a GitHub Deployment for Vercel, or migrate off Vercel's native GitHub integration. Covers required tokens/IDs, the CLI vs experimental-API modes, prebuilt flows, alias placeholders, deprecated `zeit-*`/`now-*` aliases, and the action's outputs (`preview-url`, `preview-name`, `deployment-id`).

use-vercel-action

This skill teaches an agent how to consume amondnet/vercel-action correctly. Inputs and outputs documented here come from action.yml in this repo — when in doubt, open action.yml for the full surface.

When to use

  • Adding amondnet/vercel-action to a workflow for the first time.
  • Fixing a workflow that already uses the action (input names, mutual exclusions, missing prerequisites).
  • Choosing between CLI mode (default), experimental API mode, and the two prebuilt flows.
  • Migrating from Vercel's native GitHub integration to action-driven deploys.

When NOT to use

  • The user just wants the Vercel CLI locally (no GitHub Actions involved) — refer them to the official Vercel CLI docs instead.
  • The user is happy with Vercel's native GitHub integration and isn't asking for action-based deploys.

Mandatory prerequisites

Consumers consistently miss these. Verify each before writing the workflow:

  1. Disable Vercel's native auto-deploys in the project repo, otherwise both Vercel and the action will deploy and you'll get duplicate previews. Add to vercel.json (or vercel.ts):

    json
    { "git": { "deploymentEnabled": false } }

    Legacy projects may instead use the older { "github": { "enabled": false } } — both are accepted.

  2. Link the project locally and capture the IDs. Run vercel link once on a developer machine; this writes .vercel/project.json with projectId and orgId. Store those values as GitHub repository secrets:

    Do not commit raw IDs into workflow files; reference them via ${{ secrets.* }}.

  3. GitHub Deployments need explicit permission. If you set github-deployment: true, the workflow job must declare permissions: deployments: write (and usually contents: read). Without it the deployment write call fails.

  4. Action runtime is Node 24. No consumer-side Node setup is needed for the action itself — the runner provides it.

Quick start: preview deploy on every PR

yaml
name: Preview Deploy
on:
  pull_request:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: amondnet/vercel-action@v42
        with:
          vercel-token: ${{ secrets.VERCEL_TOKEN }}
          vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
          vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
          github-token: ${{ secrets.GITHUB_TOKEN }}

github-token is what enables the action to comment the preview URL on the PR. Omit it (or set github-comment: false) if you don't want the comment.

Common patterns

Production deploy on push to main
yaml
on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: amondnet/vercel-action@v42
        with:
          vercel-token: ${{ secrets.VERCEL_TOKEN }}
          vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
          vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
          vercel-args: --prod
Prebuilt — Method 1: build outside the action

Build with the Vercel CLI in a prior step, then deploy the prebuilt output. Best when you need to share the build artifact with other steps (tests, smoke checks).

yaml
- run: npm install --global vercel@latest
- run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
  env:
    VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
    VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
- run: vercel build --token=${{ secrets.VERCEL_TOKEN }}
  env:
    VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
    VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
- uses: amondnet/vercel-action@v42
  with:
    vercel-token: ${{ secrets.VERCEL_TOKEN }}
    vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
    vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
    prebuilt: true

The npm install --global vercel@latest step is required on a fresh runner — the Vercel CLI is not preinstalled on GitHub-hosted runners.

Prebuilt — Method 2: let the action build

vercel-build: true runs vercel pull + vercel build inside the action and then deploys the prebuilt output. Simpler — one step total — but you can't reuse the build artifact elsewhere.

yaml
- uses: amondnet/vercel-action@v42
  with:
    vercel-token: ${{ secrets.VERCEL_TOKEN }}
    vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
    vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
    vercel-build: true
Alias domains with placeholders

alias-domains accepts one domain per line and substitutes {{PR_NUMBER}} and {{BRANCH}}. The domains must already exist on the Vercel project.

yaml
- uses: amondnet/vercel-action@v42
  with:
    vercel-token: ${{ secrets.VERCEL_TOKEN }}
    vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
    vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
    alias-domains: |
      pr-{{PR_NUMBER}}.preview.example.com
      {{BRANCH}}.preview.example.com

When alias domains are present the preview-url output is the first alias rather than the raw deployment URL.

GitHub Deployments
yaml
permissions:
  contents: read
  deployments: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: amondnet/vercel-action@v42
        id: vercel
        with:
          vercel-token: ${{ secrets.VERCEL_TOKEN }}
          vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
          vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          github-deployment: true
          # Optional override; otherwise auto-derived from vercel-args.
          # github-deployment-environment: staging
      - run: echo "Deployment id ${{ steps.vercel.outputs.deployment-id }}"

Deployment lifecycle: created in_progress before deploy, then transitioned to success (with the preview/alias URL as the environment URL) or failure. Previous deployments to the same environment are auto-deactivated.

Show full SKILL.md (422 more words)Show less

Input reference (essentials)

InputRequiredNotes
vercel-tokenyesVercel personal token.
vercel-org-idyesRequired for Vercel CLI 17+. Works for both CLI and API modes — prefer over scope.
vercel-project-idyesRequired for Vercel CLI 17+.
vercel-argsnoAd-hoc CLI flags (e.g. --prod, --force). Mutually exclusive with experimental-api and vercel-build.
working-directorynoRun the deploy from a subdirectory.
alias-domainsnoMulti-line list; supports {{PR_NUMBER}} and {{BRANCH}}.
prebuiltnoDeploy a prebuilt .vercel/output directory. Mutually exclusive with vercel-build.
vercel-buildnoRun vercel pull + vercel build inside the action. Mutually exclusive with prebuilt and vercel-args.
vercel-output-dirnoOverride the prebuilt output path. Defaults to {working-directory}/.vercel/output when prebuilt: true.
github-tokennoNeeded for PR/commit comments.
github-commentnotrue (default), false, or a custom comment string.
github-deploymentnotrue to create a GitHub Deployment. Requires permissions: deployments: write.
github-deployment-environmentnoOverride the auto-derived environment name.

For the long tail (target, force, env, build-env, regions, archive, root-directory, auto-assign-custom-domains, custom-environment, public, with-cache, scope, vercel-version, vercel-project-name, experimental-api) read action.yml — every input there is the source of truth.

Outputs

OutputSet whenNotes
preview-urlalwaysRaw deployment URL, or the first alias domain if alias-domains is set.
preview-namealwaysDeployment name (resolved via vercel inspect).
deployment-idonly when github-deployment: trueGitHub Deployment ID — useful for follow-up status updates.

Mutual exclusions and gotchas

  • experimental-api: true cannot be combined with vercel-args. The API client uses @vercel/client, an internal Vercel package without semver guarantees — keep CLI mode (the default) unless the user explicitly wants the typed inputs (target, regions, env, build-env, public, with-cache, custom-environment, auto-assign-custom-domains).
  • prebuilt cannot be combined with vercel-build. Pick exactly one prebuilt flow.
  • vercel-build: true cannot be combined with a non-empty vercel-args. The action throws at config-parse time with a clear error — vercel-build deploys the locally produced .vercel/output via the prebuilt path, while vercel-args routes through the CLI path which would ignore that output.
  • scope is CLI-mode only. Prefer vercel-org-id so the same workflow works in both modes.
  • The auto-detected GitHub Deployment environment is mode-dependent. CLI mode: production if vercel-args contains --prod or --production, otherwise preview. Experimental API mode: derived from target (production or preview). Set github-deployment-environment explicitly for staging and similar in either mode.
  • Deprecated input aliases (still accepted, emit deprecation warnings): zeit-token → vercel-token, now-args → vercel-args, now-project-id → vercel-project-id, now-org-id → vercel-org-id. Always rewrite to the modern names.
  • The action sets VERCEL_TELEMETRY_DISABLED=1 and exports VERCEL_ORG_ID / VERCEL_PROJECT_ID from the corresponding inputs — don't redeclare them in env: for the action step itself.

References

  • action.yml — full input/output contract (source of truth).
  • README.md — additional examples and a longer changelog.
  • https://vercel.com/account/tokens — where to mint the VERCEL_TOKEN secret.

© amondnet, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/use-vercel-action of amondnet/vercel-action.

Open the folder on GitHubat commit 9471a56

Compare with similar skills

Use Vercel Action next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Use Vercel Action compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Use Vercel Action this skillamondnet/vercel-action764—~2.7kAutomated safety check: PassMIT
Vercel CI Integrationjeremylongshore/tons-of-skills-marketplace2.8k—~1.9kAutomated safety check: PassMIT
AI News RadarLearnPrompt/ai-news-radar1.8k—~2.5kAutomated safety check: NotesMIT
Prepare Cloudflare Production DeploymentLubomirGeorgiev/cloudflare-workers-nextjs-saas-template786—~5.9kAutomated safety check: NotesMIT
Deployments Cicdvercel/vercel-plugin3011 repos~3kAutomated safety check: PassCustom licence
GitHub Actions Docsdevantler-tech/ksail1652 repos~1.3kAutomated safety check: PassCustom licence

Similar skills

  • Vercel CI Integration

    jeremylongshore/tons-of-skills-marketplace

    Configure Vercel CI/CD with GitHub Actions, preview deployments, and automated testing.

    2.8k GitHub stars~1.9k tokensUpdated today
    DevOps & CloudAuto-check passed
  • AI News Radar

    LearnPrompt/ai-news-radar

    A skill your agent uses when working on AI News Radar, 24 小时 AI 更新雷达, AI 更新雷达, 伯乐Skill, or Scout Skill: finding high-signal AI/tech sources, adding RSS/OPML/GitHub feeds, checking source health…

    1.8k GitHub stars~2.5k tokensUpdated today
    DevOps & CloudAuto-check: notes
  • Prepare Cloudflare Production Deployment

    LubomirGeorgiev/cloudflare-workers-nextjs-saas-template

    Source-of-truth runbook for preparing this Vinext Cloudflare Workers SaaS template for production deployment.

    786 GitHub stars~5.9k tokensUpdated 2 days ago
    DevOps & CloudAuto-check: notes
  • Deployments Cicd

    vercel/vercel-plugin

    Official

    Vercel deployment and CI/CD expert guidance. An agent skill from vercel/vercel-plugin.

    301 GitHub starsUsed in 1 repo~3k tokens
    DevOps & CloudAuto-check passed
  • GitHub Actions Docs

    devantler-tech/ksail

    A skill your agent uses when users ask how to write, explain, customize, migrate, secure, or troubleshoot GitHub Actions workflows, workflow syntax, triggers, matrices, runners, reusable workflows…

    165 GitHub starsUsed in 2 repos~1.3k tokens
    DevOps & CloudAuto-check passed
  • CI CD

    EliasOulkadi/shokunin

    Design CI/CD pipelines for GitHub Actions, GitLab CI, and CircleCI with matrix builds, test sharding, caching, Docker layer caching, OIDC auth, deployment strategies (rolling, blue-green, canary)…

    114 GitHub stars~3.4k tokensUpdated 4 days ago
    DevOps & CloudAuto-check: notes

Categories

Questions about Use Vercel Action

What does Use Vercel Action do?

Wire amondnet/vercel-action into a GitHub Actions workflow to deploy Vercel projects from CI. Use Vercel Action is an agent skill from amondnet/vercel-action. Wire amondnet/vercel-action into a GitHub Actions workflow to deploy Vercel projects from CI.

When should I use Use Vercel Action?

Use Vercel Action fits situations like: the user asks to deploy to Vercel from GitHub Actions; add Vercel preview deploys; post a Vercel preview URL on a PR; configure prebuilt Vercel deployments.

How do I install Use Vercel Action in Claude Code?

Run `npx skills add amondnet/vercel-action --skill use-vercel-action -a claude-code`. Or copy the skill folder (skills/use-vercel-action in amondnet/vercel-action) into .claude/skills/use-vercel-action in your project. Claude Code loads it when a task matches its description.

How do I install Use Vercel Action in Codex?

Run `npx skills add amondnet/vercel-action --skill use-vercel-action -a codex`. Or copy the skill folder (skills/use-vercel-action in amondnet/vercel-action) into .agents/skills/use-vercel-action in your project. Codex loads it when a task matches its description.

Can I use Use Vercel Action in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add amondnet/vercel-action --skill use-vercel-action -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/use-vercel-action, .gemini/skills/use-vercel-action, .github/skills/use-vercel-action and .opencode/skills/use-vercel-action in your project.

What does Use Vercel Action need to run?

Going by SKILL.md and its folder, Use Vercel Action needs the command-line tools its instructions call (vercel and npm) and credentials named VERCEL_TOKEN and GITHUB_TOKEN. Our summary lists: Node.js; A credential in VERCEL_TOKEN; A credential in GITHUB_TOKEN.

Does Use Vercel Action access the network?

SKILL.md names 1 domain. As links in the text: vercel.com. This is read from the text; nothing was executed.

Is Use Vercel Action safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Use Vercel Action use?

Use Vercel Action is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Use Vercel Action use?

About 2.7k tokens (SKILL.md is roughly 11k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Use Vercel Action?

Skills that share tags, products or a category with Use Vercel Action: Vercel CI Integration (jeremylongshore/tons-of-skills-marketplace, 2.8k stars), AI News Radar (LearnPrompt/ai-news-radar, 1.8k stars), Prepare Cloudflare Production Deployment (LubomirGeorgiev/cloudflare-workers-nextjs-saas-template, 786 stars) and Deployments Cicd (vercel/vercel-plugin, 301 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Use Vercel Action?

amondnet (a GitHub user) maintains it in amondnet/vercel-action, which has 764 GitHub stars. The repository was last updated on July 20, 2026.

Source: amondnet/vercel-action on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.