Documentation PreviewShip

PreviewShip transforme les artefacts frontend prêts pour navigateur en URL fixes de preview. Choisissez le flux adapté :

1. 1Inscrivez-vous gratuitement sur previewship.com
2. 2Créez une API Key dans la console (page API Keys)
3. 3Déployez une sortie statique React/Vue/Vite/Next, un zip avec index.html, un fichier HTML/Markdown/PDF, du HTML collé ou une sortie générée par agent via CLI, MCP, extension éditeur ou console
4. 4Partagez l’URL fixe de preview puis gérez l’accès, les versions, le rollback, le redéploiement ou le nettoyage du projet si besoin

Utilisez PreviewShip lorsque l’artefact à partager peut déjà s’ouvrir dans le navigateur. Le produit est conçu pour les liens de revue frontend, pas pour compiler du code source ni héberger un backend.

Déployez avec une commande terminal puis gérez les URL fixes, l’accès public/mot de passe, les versions, le rollback, le redéploiement et la suppression. La CLI fournit aussi du JSON pour agents IA et CI.

Installation

Utilisez npx directement (aucune installation requise) ou installez globalement :

Configurer l'API Key

Configurez votre API Key pour l'authentification :

Ou définissez via une variable d'environnement :

Déployer

Déployez un dossier statique déjà buildé, un fichier HTML unique ou un document Markdown pour obtenir un lien de preview :

Sortie JSON pour les Agents

Utilisez le flag --json pour une sortie structurée, idéale pour les agents IA et les pipelines CI :

Commandes de gestion de projet

Utilisez-les pour inspecter les projets, changer l’accès, restaurer un lien expiré, revenir en arrière sur une URL fixe ou supprimer un slot Free inutilisé.

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

Le serveur MCP permet aux agents IA de déployer des previews et gérer des projets via des appels d’outils natifs. Compatible avec Claude Code, Cursor, Windsurf et tout client MCP.

Configuration

Pour Claude Code, ajoutez dans ~/.claude/settings.json :

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

Pour Cursor, créez .cursor/mcp.json à la racine de votre projet :

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

Pour Windsurf, ajoutez dans ~/.codeium/windsurf/mcp_config.json :

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

Outils Disponibles

• deploy_preview — Déploie un dossier de build output, un .html seul ou Markdown et retourne une URL fixe de preview
• check_deployment — Vérifier le statut d'un déploiement par ID
• show_usage — Afficher le quota de déploiement restant
• list_projects / get_project — Inspecte les URL fixes, l’état projet, le mode d’accès et la disponibilité du redéploiement
• get_project_access / set_project_access — Bascule entre PUBLIC et PASSWORD ; PUBLIC supprime le mot de passe enregistré
• list_project_versions / rollback_project_version — Affiche les versions retenues et ramène une URL fixe à un déploiement historique
• redeploy_project_latest — Restaure un lien fixe expiré depuis le dernier artefact retenu
• delete_project — Supprime un projet confirmé et retire définitivement son URL fixe, projet hébergé, association de déploiements et entrée Showcase

PreviewShip fournit aussi un skill Codex optionnel pour partager la conversation Codex en cours. Il transforme le transcript visible en page HTML haute fidélité, la déploie avec PreviewShip CLI et renvoie une URL publique.

Installer le skill

Utiliser dans Codex

Après installation, référencez le skill dans une conversation Codex :

PreviewShip fournit aussi un skill Claude Code optionnel pour partager les conversations Claude Code. Il lit l’historique JSONL local, rend le chat visible en page HTML haute fidélité, le déploie avec PreviewShip CLI et renvoie une URL publique.

Installer le skill

Utiliser dans Codex

Après installation, référencez le skill depuis Codex et demandez-lui de partager une conversation Claude Code :

Cursor est entièrement compatible avec les extensions VS Code. Vous pouvez installer PreviewShip de la même façon.

Installer via la Palette de Commandes

1. 1Ouvrez Cursor, appuyez sur Ctrl+P (Cmd+P sur Mac)
2. 2Collez la commande ci-dessous et appuyez sur Entrée :

Installer via VSIX

Si vous préférez l'installation hors ligne, téléchargez le fichier .vsix et suivez la section « Installation VSIX » ci-dessous.

Ouvrez VS Code, appuyez sur Ctrl+P (Cmd+P sur Mac), collez la commande ci-dessous et appuyez sur Entrée :

Si le marketplace n'est pas accessible dans votre environnement, vous pouvez installer l'extension manuellement avec un fichier .vsix.

Étapes d'Installation

1. 1Téléchargez le fichier .vsix avec le bouton ci-dessus
2. 2Ouvrez Cursor ou VS Code, allez dans le panneau Extensions (Ctrl+Shift+X)
3. 3Cliquez sur "..." en haut à droite → « Installer depuis un VSIX... » → sélectionnez le fichier téléchargé

Vous pouvez aussi installer en ligne de commande :

Une API Key est nécessaire pour toutes les méthodes de déploiement (CLI, MCP, extension éditeur). Voici comment en créer une :

1. 1Connectez-vous à previewship.com et allez sur la page API Keys
2. 2Cliquez sur « Créer une API Key », donnez-lui un nom et copiez la clé générée
3. 3Utilisez la clé dans le CLI (previewship login), la config MCP (variable d'environnement PREVIEWSHIP_API_KEY), ou l'extension éditeur (commande Set API Key)

Une fois l'extension installée et votre API Key configurée :

1. 1Ouvrez votre dossier de projet frontend dans l'éditeur
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

Vous pouvez aussi déployer directement depuis la console web sans outil. La console permet d’importer un zip de build output, un fichier HTML, Markdown ou PDF unique, ou de coller du HTML :

1. 1Connectez-vous et allez sur la page Déploiement
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 déploie les zips comme sites statiques, emballe un HTML unique comme index.html et conserve un Markdown unique avec une page de lecture sûre avant le déploiement

Les projets sont le conteneur stable derrière les liens PreviewShip. Chaque projet possède une URL fixe, un pointeur latest, un mode d’accès, des versions retenues et un état Showcase optionnel.

• Les projets sont créés automatiquement lors d’un déploiement avec un nouveau nom, et les previews guest réclamées sont liées à un projet fixe.
• L’URL fixe du projet ne change pas à chaque déploiement ; les déploiements et rollbacks changent ce que cette URL sert.
• Les projets publics se partagent normalement. Pro permet l’accès par mot de passe ; repasser en public supprime le mot de passe.
• L’historique dépend du plan : Free garde 3 versions rollback, Pro Monthly 10 et Pro Yearly 40 tant que les artefacts sont retenus.
• Free inclut 1 projet. Si la limite est atteinte, supprimez un projet inutilisé ou passez à un plan supérieur avant de déployer ou réclamer une autre preview.
• Supprimer un projet retire définitivement l’URL fixe, le projet hébergé, l’association de déploiements et l’entrée Showcase.
• Seuls les éléments Showcase publics et approuvés peuvent être indexés. Les projets avec mot de passe, privés/masqués ou expirés inaccessibles ne vont pas dans le sitemap.

Les plans PreviewShip combinent quota de déploiement, nombre de projets, upload, rétention, historique de versions, contrôle d’accès et suppression du watermark :