@robinpath/vercel
v0.1.1
Published
Vercel module for RobinPath.
Readme
@robinpath/vercel
Vercel module for RobinPath.
Why use this module?
The vercel module lets you:
- List all projects in the authenticated account
- Get details of a project by ID or name
- Create a new Vercel project
- Update settings of an existing project
- Delete a Vercel project
All functions are callable directly from RobinPath scripts with a simple, consistent API.
Installation
npm install @robinpath/vercelQuick Start
1. Set up credentials
vercel.setToken "my-vercel-token"2. List all projects in the authenticated account
vercel.listProjects {"limit": 20, "search": "my-app"}Available Functions
| Function | Description |
|----------|-------------|
| vercel.setToken | Set the Vercel API bearer token for authentication |
| vercel.listProjects | List all projects in the authenticated account |
| vercel.getProject | Get details of a project by ID or name |
| vercel.createProject | Create a new Vercel project |
| vercel.updateProject | Update settings of an existing project |
| vercel.deleteProject | Delete a Vercel project |
| vercel.listDeployments | List deployments, optionally filtered by project, state, or target |
| vercel.getDeployment | Get details of a specific deployment |
| vercel.createDeployment | Create a new deployment with files |
| vercel.cancelDeployment | Cancel an in-progress deployment |
| vercel.deleteDeployment | Delete a deployment |
| vercel.redeployDeployment | Redeploy an existing deployment (create from existing) |
| vercel.listDomains | List all domains in the authenticated account |
| vercel.getDomain | Get information about a specific domain |
| vercel.addDomain | Register a new domain to the account |
| vercel.removeDomain | Remove a domain from the account |
| vercel.listProjectDomains | List all domains assigned to a project |
| vercel.addProjectDomain | Add a domain to a project |
| vercel.removeProjectDomain | Remove a domain from a project |
| vercel.getDomainConfig | Get DNS configuration for a domain |
| vercel.verifyDomain | Verify a domain attached to a project |
| vercel.listEnvVars | List all environment variables for a project |
| vercel.getEnvVar | Get details of a specific environment variable |
| vercel.createEnvVar | Create a new environment variable for a project |
| vercel.updateEnvVar | Update an existing environment variable |
| vercel.deleteEnvVar | Delete an environment variable from a project |
| vercel.getUser | Get the authenticated user's profile |
| vercel.listTeams | List all teams the authenticated user belongs to |
| vercel.getTeam | Get details of a specific team |
| vercel.getDeploymentLogs | Get build logs for a deployment |
Examples
List all projects in the authenticated account
vercel.listProjects {"limit": 20, "search": "my-app"}Get details of a project by ID or name
vercel.getProject "my-project"Create a new Vercel project
vercel.createProject "my-app" {"framework": "nextjs"}Integration with RobinPath
import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/vercel";
const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);
const result = await rp.executeScript(`
vercel.setToken "my-vercel-token"
vercel.listProjects {"limit": 20, "search": "my-app"}
`);Full API Reference
See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.
Related Modules
@robinpath/docker— Docker module for complementary functionality@robinpath/git— Git module for complementary functionality@robinpath/github— GitHub module for complementary functionality@robinpath/gitlab— GitLab module for complementary functionality@robinpath/netlify— Netlify module for complementary functionality
License
MIT
