Documentação do PreviewShip

O PreviewShip transforma artefatos frontend prontos para navegador em URLs fixas de preview. Escolha o fluxo ideal:

1. 1Registre-se gratuitamente em previewship.com
2. 2Crie uma API Key no console (página API Keys)
3. 3Publique output estático de React/Vue/Vite/Next, um zip com index.html, um arquivo HTML/Markdown/PDF, HTML colado ou output gerado por agente via CLI, MCP, extensão do editor ou console
4. 4Compartilhe a URL fixa de preview e gerencie acesso, versões, rollback, redeploy ou limpeza do projeto quando necessário

Use o PreviewShip quando o artefato que você quer compartilhar já abre no navegador. Ele é feito para links de revisão frontend, não para compilar código-fonte ou hospedar backends.

Publique com um comando no terminal e depois gerencie URLs fixas, acesso público/senha, versões, rollback, redeploy e exclusão. A CLI também oferece JSON para agentes de IA e CI.

Instalar

Use npx diretamente (sem instalação) ou instale globalmente:

Configurar API Key

Configure sua API Key para autenticação:

Ou defina via variável de ambiente:

Implantar

Implante um diretório estático já construído, um único arquivo HTML ou um documento Markdown para obter um link de preview:

Saída JSON para Agentes

Use a flag --json para saída estruturada, ideal para agentes de IA e pipelines de CI:

Comandos de gestão de projetos

Use para inspecionar projetos, mudar acesso, restaurar links expirados, fazer rollback da URL fixa ou excluir um slot Free sem 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

O MCP server permite que agentes de IA publiquem previews e gerenciem projetos como chamadas nativas de ferramenta. Funciona com Claude Code, Cursor, Windsurf e clientes compatíveis com MCP.

Configuração

Para Claude Code, adicione ao ~/.claude/settings.json:

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

Para Cursor, crie .cursor/mcp.json na raiz do seu projeto:

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

Para Windsurf, adicione ao ~/.codeium/windsurf/mcp_config.json:

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

Ferramentas Disponíveis

• deploy_preview — Publica um diretório de build output, um .html único ou Markdown e retorna uma URL fixa de preview
• check_deployment — Verifica o status de implantação por ID
• show_usage — Exibe a cota restante de implantações
• list_projects / get_project — Inspeciona URLs fixas, status do projeto, modo de acesso e disponibilidade de redeploy
• get_project_access / set_project_access — Alterna entre PUBLIC e PASSWORD; PUBLIC remove a senha salva
• list_project_versions / rollback_project_version — Mostra versões retidas e reverte uma URL fixa para um deploy histórico
• redeploy_project_latest — Restaura um link fixo expirado a partir do último artefato retido
• delete_project — Exclui um projeto confirmado e remove permanentemente sua URL fixa, projeto hospedado, associação de deploys e item do Showcase

PreviewShip também oferece uma skill opcional do Codex para compartilhar a conversa atual. Ela transforma o transcript visível em uma página HTML de alta fidelidade, implanta com o PreviewShip CLI e retorna uma URL pública.

Instalar a skill

Usar no Codex

Após a instalação, referencie a skill em uma conversa do Codex:

PreviewShip também oferece um skill opcional de Claude Code para compartilhar conversas do Claude Code. Ele lê o histórico JSONL local, renderiza o chat visível como uma página HTML de alta fidelidade, faz deploy com o PreviewShip CLI e retorna uma URL pública.

Instalar o skill

Usar no Codex

Depois de instalar, referencie o skill no Codex e peça para compartilhar uma conversa do Claude Code:

O Cursor é totalmente compatível com extensões do VS Code. Você pode instalar o PreviewShip da mesma forma.

Instalar pela Paleta de Comandos

1. 1Abra o Cursor, pressione Ctrl+P (Cmd+P no Mac)
2. 2Cole o comando abaixo e pressione Enter:

Instalar via VSIX

Se preferir instalação offline, baixe o arquivo .vsix e siga a seção "Instalação VSIX" abaixo.

Abra o VS Code, pressione Ctrl+P (Cmd+P no Mac), cole o comando abaixo e pressione Enter:

Se o marketplace não estiver disponível no seu ambiente, você pode instalar a extensão manualmente com um arquivo .vsix.

Passos de Instalação

1. 1Baixe o arquivo .vsix usando o botão acima
2. 2Abra o Cursor ou VS Code, vá ao painel de Extensões (Ctrl+Shift+X)
3. 3Clique em "..." no canto superior direito → "Instalar de VSIX..." → selecione o arquivo baixado

Também é possível instalar pela linha de comando:

Uma API Key é necessária para todos os métodos de implantação (CLI, MCP, extensão do editor). Como criar:

1. 1Faça login em previewship.com e vá para a página API Keys
2. 2Clique em "Criar API Key", dê um nome e copie a chave gerada
3. 3Use a chave no CLI (previewship login), na configuração MCP (variável de ambiente PREVIEWSHIP_API_KEY) ou na extensão do editor (comando Set API Key)

Com a extensão instalada e a API Key configurada:

1. 1Abra a pasta do projeto frontend no editor
2. 2Abra a paleta de comandos (Ctrl+Shift+P) e execute "PreviewShip: Deploy Workspace, HTML, Markdown, or PDF File" ou "PreviewShip: Deploy Active HTML, Markdown, or PDF File"
3. 3A extensão empacota o build output, arquivo HTML ou arquivo Markdown selecionado, faz o upload e retorna uma URL de preview quando ficar pronto

Você também pode implantar diretamente pelo console web sem ferramentas. O console permite enviar um zip de build output, enviar um único arquivo HTML, Markdown ou PDF, ou colar HTML:

1. 1Faça login e vá para a página de Implantação
2. 2Selecione ou crie um projeto; depois envie um .zip com saída estática compilada, envie um arquivo .html/.md/.markdown/.pdf ou cole um documento HTML completo
3. 3O PreviewShip implanta zips como sites estáticos, empacota HTML único como index.html e mantém Markdown único com uma página visualizadora segura antes do deploy

Projetos são o contêiner estável por trás dos links do PreviewShip. Cada projeto tem URL fixa, ponteiro latest, modo de acesso, versões retidas e estado opcional no Showcase.

• Projetos são criados automaticamente ao publicar com um nome novo, e previews guest reivindicados são vinculados a um projeto fixo.
• A URL fixa do projeto não muda a cada deploy; deploys e rollbacks mudam o que essa URL serve.
• Projetos públicos podem ser compartilhados normalmente. Pro permite acesso com senha; voltar para público remove a senha.
• O histórico depende do plano: Free mantém 3 versões rollback, Pro Monthly 10 e Pro Yearly 40 enquanto os artefatos estiverem retidos.
• Free inclui 1 projeto. Se o limite estiver cheio, exclua um projeto sem uso ou faça upgrade antes de publicar ou reivindicar outro preview.
• Excluir um projeto remove permanentemente a URL fixa, o projeto hospedado, a associação de deploys e o item do Showcase.
• Só itens Showcase públicos e aprovados podem ser indexados. Projetos com senha, privados/ocultos ou conteúdo expirado inacessível não entram no sitemap.

Os planos do PreviewShip combinam cota de deploy, número de projetos, upload, retenção, histórico de versões, controle de acesso e remoção da marca d’água: