Documentación de PreviewShip

PreviewShip convierte artefactos frontend listos para navegador en URLs fijas de preview. Elige el método que encaje con tu flujo:

1. 1Regístrate gratis en previewship.com
2. 2Crea una API Key en la consola (página API Keys)
3. 3Despliega output estático de React/Vue/Vite/Next, un zip con index.html, un archivo HTML/Markdown/PDF, HTML pegado o output generado por agentes mediante CLI, MCP, extensión del editor o consola
4. 4Comparte la URL fija de preview y gestiona acceso, versiones, rollback, redeploy o limpieza del proyecto cuando haga falta

Usa PreviewShip cuando el artefacto que quieres compartir ya puede abrirse en el navegador. Está hecho para enlaces de revisión frontend, no para compilar código fuente ni alojar backends.

Despliega con un comando de terminal y luego gestiona URLs fijas, acceso público/contraseña, versiones, rollback, redeploy y eliminación. La CLI también soporta JSON para agentes de IA y CI.

Instalar

Usa npx directamente (no requiere instalación) o instala globalmente:

Configurar API Key

Configura tu API Key para la autenticación:

O configura mediante variable de entorno:

Desplegar

Despliega un directorio estático ya construido, un único archivo HTML o un documento Markdown para obtener un enlace de preview:

Salida JSON para Agentes

Usa el flag --json para una salida estructurada, ideal para agentes de IA y pipelines de CI:

Comandos de gestión de proyectos

Úsalos para inspeccionar proyectos, cambiar acceso, restaurar enlaces vencidos, hacer rollback de una URL fija o eliminar un proyecto Free sin uso.

previewship deployments list --json
previewship projects list --json
previewship projects access 42 --password "review-pass"
previewship projects access 42 --public
previewship projects versions 42
previewship projects rollback 42 105 --confirm my-project
previewship projects redeploy 42
previewship projects delete 42 --confirm my-project

El MCP server permite que los agentes de IA desplieguen previews y gestionen proyectos como llamadas de herramienta nativas. Funciona con Claude Code, Cursor, Windsurf y clientes compatibles con MCP.

Configuración

Para Claude Code, añade a ~/.claude/settings.json:

{
  "mcpServers": {
    "previewship": {
      "command": "npx",
      "args": ["-y", "previewship-mcp"],
      "env": {
        "PREVIEWSHIP_API_KEY": "ps_live_your_key_here"
      }
    }
  }
}

Para Cursor, crea .cursor/mcp.json en la raíz de tu proyecto:

{
  "mcpServers": {
    "previewship": {
      "command": "npx",
      "args": ["-y", "previewship-mcp"],
      "env": {
        "PREVIEWSHIP_API_KEY": "ps_live_your_key_here"
      }
    }
  }
}

Para Windsurf, añade a ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "previewship": {
      "command": "npx",
      "args": ["-y", "previewship-mcp"],
      "env": {
        "PREVIEWSHIP_API_KEY": "ps_live_your_key_here"
      }
    }
  }
}

Herramientas Disponibles

• deploy_preview — Despliega un directorio de build output, un .html único o Markdown y devuelve una URL fija de preview
• check_deployment — Verifica el estado del despliegue por ID
• show_usage — Muestra la cuota de despliegues restante
• list_projects / get_project — Inspecciona URLs fijas, estado del proyecto, modo de acceso y disponibilidad de redeploy
• get_project_access / set_project_access — Cambia entre PUBLIC y PASSWORD; PUBLIC elimina la contraseña guardada
• list_project_versions / rollback_project_version — Muestra versiones retenidas y revierte una URL fija a un despliegue histórico
• redeploy_project_latest — Restaura un enlace fijo vencido desde el último artefacto retenido
• delete_project — Elimina un proyecto confirmado y borra permanentemente su URL fija, proyecto alojado, asociación de despliegues y entrada de Showcase

PreviewShip también ofrece un skill opcional de Codex para compartir la conversación actual. Convierte el transcript visible en una página HTML de alta fidelidad, la despliega con PreviewShip CLI y devuelve una URL pública.

Instalar el skill

Usar en Codex

Después de instalarlo, referencia el skill en una conversación de Codex:

PreviewShip también ofrece un skill opcional de Claude Code para compartir conversaciones de Claude Code. Lee el historial JSONL local, renderiza el chat visible como una página HTML de alta fidelidad, la despliega con PreviewShip CLI y devuelve una URL pública.

Instalar el skill

Usar en Codex

Después de instalarlo, referencia el skill desde Codex y pide compartir una conversación de Claude Code:

Cursor es totalmente compatible con las extensiones de VS Code. Puedes instalar PreviewShip de la misma forma.

Instalar desde la Paleta de Comandos

1. 1Abre Cursor, presiona Ctrl+P (Cmd+P en Mac)
2. 2Pega el comando de abajo y presiona Enter:

Instalar desde VSIX

Si prefieres la instalación sin conexión, descarga el archivo .vsix y sigue la sección "Instalación VSIX" más abajo.

Abre VS Code, presiona Ctrl+P (Cmd+P en Mac), pega el comando de abajo y presiona Enter:

Si el marketplace no está disponible en tu entorno, puedes instalar la extensión manualmente con un archivo .vsix.

Pasos de Instalación

1. 1Descarga el archivo .vsix con el botón de arriba
2. 2Abre Cursor o VS Code, ve al panel de Extensiones (Ctrl+Shift+X)
3. 3Haz clic en "..." en la esquina superior derecha → "Instalar desde VSIX..." → selecciona el archivo descargado

También puedes instalar desde la línea de comandos:

Se necesita una API Key para todos los métodos de despliegue (CLI, MCP, extensión del editor). Cómo crearla:

1. 1Inicia sesión en previewship.com y ve a la página API Keys
2. 2Haz clic en "Crear API Key", ponle un nombre y copia la clave generada
3. 3Usa la clave en CLI (previewship login), configuración de MCP (variable de entorno PREVIEWSHIP_API_KEY) o extensión del editor (comando Set API Key)

Una vez instalada la extensión y configurada tu API Key:

1. 1Abre la carpeta de tu proyecto frontend en el editor
2. 2Open the command palette (Ctrl+Shift+P) and run "PreviewShip: Deploy Workspace, HTML, Markdown, or PDF File" or "PreviewShip: Deploy Active HTML, Markdown, or PDF File"
3. 3The extension packages the selected build output, HTML file, or Markdown file, uploads it, and returns a preview URL when ready

También puedes desplegar directamente desde la consola web sin herramientas. La consola admite subir un zip de build output, subir un único archivo HTML, Markdown o PDF, o pegar código HTML:

1. 1Inicia sesión y ve a la página de Despliegue
2. 2Select or create a project, then upload a .zip containing static build output, upload a .html/.md/.markdown/.pdf file, or paste a complete HTML document
3. 3PreviewShip despliega zips como sitios estáticos, empaqueta HTML único como index.html y conserva Markdown único con una página visor segura antes del despliegue

Los proyectos son el contenedor estable detrás de los enlaces de PreviewShip. Cada proyecto tiene URL fija, puntero latest, modo de acceso, versiones retenidas y estado opcional de Showcase.

• Los proyectos se crean automáticamente al desplegar con un nombre nuevo, y las previews guest reclamadas se vinculan a un proyecto fijo.
• La URL fija del proyecto no cambia en cada despliegue; los despliegues y rollbacks cambian lo que esa URL sirve.
• Los proyectos públicos se pueden compartir normalmente. Pro permite acceso con contraseña; volver a público elimina la contraseña.
• El historial depende del plan: Free mantiene 3 versiones rollback, Pro Monthly 10 y Pro Yearly 40 mientras los artefactos sigan retenidos.
• Free incluye 1 proyecto. Si el límite está lleno, elimina un proyecto sin uso o sube de plan antes de desplegar o reclamar otra preview.
• Eliminar un proyecto borra permanentemente la URL fija, el proyecto alojado, la asociación de despliegues y la entrada de Showcase.
• Solo los elementos Showcase públicos y aprobados pueden indexarse. Proyectos con contraseña, privados/ocultos o contenido vencido inaccesible no entran en sitemap.

Los planes de PreviewShip combinan cuota de despliegues, número de proyectos, carga, retención, historial, control de acceso y eliminación de marca de agua: