home / skills / jeremylongshore / claude-code-plugins-plus-skills / vercel-install-auth

This skill helps you install and configure the Vercel SDK/CLI authentication for seamless project integration.

npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill vercel-install-auth

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.2 KB
---
name: vercel-install-auth
description: |
  Install and configure Vercel SDK/CLI authentication.
  Use when setting up a new Vercel integration, configuring API keys,
  or initializing Vercel in your project.
  Trigger with phrases like "install vercel", "setup vercel",
  "vercel auth", "configure vercel API key".
allowed-tools: Read, Write, Edit, Bash(npm:*), Bash(pip:*), Grep
version: 1.0.0
license: MIT
author: Jeremy Longshore <[email protected]>
---

# Vercel Install & Auth

## Overview
Set up Vercel SDK/CLI and configure authentication credentials.

## Prerequisites
- Node.js 18+ or Python 3.10+
- Package manager (npm, pnpm, or pip)
- Vercel account with API access
- API key from Vercel dashboard

## Instructions

### Step 1: Install SDK
```bash
# Node.js
npm install vercel

# Python
pip install None
```

### Step 2: Configure Authentication
```bash
# Set environment variable
export VERCEL_API_KEY="your-api-key"

# Or create .env file
echo 'VERCEL_API_KEY=your-api-key' >> .env
```

### Step 3: Verify Connection
```typescript
const teams = await vercel.teams.list(); console.log(teams.length > 0 ? 'OK' : 'No teams');
```

## Output
- Installed SDK package in node_modules or site-packages
- Environment variable or .env file with API key
- Successful connection verification output

## Error Handling
| Error | Cause | Solution |
|-------|-------|----------|
| Invalid API Key | Incorrect or expired key | Verify key in Vercel dashboard |
| Rate Limited | Exceeded quota | Check quota at https://vercel.com/docs |
| Network Error | Firewall blocking | Ensure outbound HTTPS allowed |
| Module Not Found | Installation failed | Run `npm install` or `pip install` again |

## Examples

### TypeScript Setup
```typescript
import { VercelClient } from 'vercel';

const client = new VercelClient({
  apiKey: process.env.VERCEL_API_KEY,
});
```

### Python Setup
```python
from None import VercelClient

client = VercelClient(
    api_key=os.environ.get('VERCEL_API_KEY')
)
```

## Resources
- [Vercel Documentation](https://vercel.com/docs)
- [Vercel Dashboard](https://api.vercel.com)
- [Vercel Status](https://www.vercel-status.com)

## Next Steps
After successful auth, proceed to `vercel-hello-world` for your first API call.

Overview

This skill installs the Vercel SDK/CLI and configures authentication so your project can call Vercel APIs securely. It guides installation, environment variable or .env setup for the API key, and a simple verification step to confirm connectivity. The goal is a reproducible auth setup for local dev, CI, or automation scripts.

How this skill works

The skill walks you through installing the Vercel client/CLI for your platform (Node.js/npm or Python/pip) and shows how to store your Vercel API key as an environment variable or in a .env file. It includes a small verification snippet that lists teams or performs a lightweight API call to confirm the key works. It also highlights common errors and fixes so you can recover from credential or network problems quickly.

When to use it

  • Setting up a new Vercel integration or project
  • Configuring or rotating Vercel API keys for CI/CD
  • Initializing Vercel SDK/CLI in local development environment
  • Scripting automated deployments or API calls to Vercel
  • Troubleshooting authentication or connectivity to Vercel APIs

Best practices

  • Use a dedicated API key with least privilege for automation or CI
  • Store VERCEL_API_KEY in CI secrets, not in source control
  • Prefer environment variables over committed .env files; add .env to .gitignore
  • Test auth with a harmless read-only call before running deploys
  • Rotate keys regularly and revoke unused keys from the Vercel dashboard

Example use cases

  • Install Vercel client and export VERCEL_API_KEY to run local deployment scripts
  • Configure CI pipeline secrets to hold the Vercel API key and run automated builds
  • Add a verification step that lists teams or projects to validate credentials in a setup script
  • Rotate an expired key by updating environment variables and re-verifying connectivity

FAQ

Which package should I install?

For Node.js projects install the official Vercel package via npm (npm install vercel). For Python, install the maintained Python Vercel client if available (pip install vercel or the SDK your project targets).

How do I verify the key is correct?

Run a lightweight API call such as listing teams or projects using the client. A successful non-empty response indicates valid credentials.

Where should I store the API key for CI?

Store VERCEL_API_KEY in your CI provider's secret storage (GitHub Actions secrets, GitLab CI variables, etc.) and reference it as an environment variable during runs.