Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt

Use this file to discover all available pages before exploring further.

VercelResource exposes a Vercel account or team as a read-only tree of projects, deployments, and recent build logs.

​
Node

pnpm add @struktoai/mirage-node

import { MountMode, VercelResource, Workspace } from '@struktoai/mirage-node'

const vercel = new VercelResource({
  token: process.env.VERCEL_TOKEN,
  teamId: process.env.VERCEL_TEAM_ID,
})

const ws = new Workspace({ '/vercel': vercel }, { mode: MountMode.READ })
await ws.execute('ls /vercel/projects/')

​
Browser

pnpm add @struktoai/mirage-browser
The browser variant routes through an HTTP driver so the token never reaches the page directly: 
import { MountMode, VercelResource, Workspace } from '@struktoai/mirage-browser'

const vercel = new VercelResource({
  baseUrl: '/api/vercel-proxy',
})

​
Config

FieldDefaultNotes
tokennoneVercel API token. Redacted in snapshots.
teamIdnoneRestrict to a specific team.
baseUrlhttps://api.vercel.comOverride for proxies.
defaultListLimit100Default page size.

​
Mount mode

read.