PreviewShip Documentation

Learn how to deploy frontend previews from CLI, MCP-compatible AI agents, VS Code, Cursor, or browser upload.

Quick Start

  1. Create an account at previewship.com.
  2. Create an API Key from the dashboard.
  3. Deploy with CLI, MCP, extension, or web console.
  4. Share the generated preview URL.

CLI Setup

Install or run directly with npx, then deploy your build output directory.

npx previewship login --key ps_live_your_key_here
npx previewship deploy ./dist --json

MCP Server Setup

Configure previewship-mcp in Claude Code, Cursor, or Windsurf so your AI agent can deploy with native tool calls.

VS Code and Cursor Extension

Install the PreviewShip extension and run Deploy Current Workspace from the command palette.

Plans and Limits

Free includes 5 deploys per day; Pro plans increase projects, deploy quota, and upload limits.