PreviewShip 使用文档

PreviewShip 会把浏览器可直接打开的前端产物变成固定预览链接。选择适合你的方式开始：

1. 1在 previewship.com 免费注册账号
2. 2在控制台的 API Keys 页面创建 API Key
3. 3通过 CLI、MCP、编辑器扩展或控制台上传部署 React/Vue/Vite/Next 静态产物、包含 index.html 的 zip、单个 HTML/Markdown/PDF 文件、粘贴 HTML 或智能体生成的产物
4. 4分享固定预览链接，并在需要时管理访问控制、版本历史、回滚、重新部署或项目清理

当你要分享的产物已经可以被浏览器直接打开时，使用 PreviewShip。它适合前端评审链接，不是源码构建或后端托管平台。

用一条终端命令部署，然后继续管理固定项目链接、公开/密码访问、版本历史、回滚、重新部署和删除。CLI 也支持 JSON 输出，适合 AI 智能体和 CI。

安装

直接使用 npx（无需安装）或全局安装：

设置 API Key

设置 API Key 进行身份验证：

或通过环境变量设置：

部署

部署已构建的静态目录或单个 HTML、Markdown、PDF 文档并获取预览链接：

面向智能体的 JSON 输出

使用 --json 参数获取结构化输出，适用于 AI 智能体和 CI 管道：

项目管理命令

当你需要查看项目、修改访问方式、恢复过期链接、回滚固定 URL 或删除不用的 Free 项目槽位时，使用这些命令。

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

MCP 服务器让 AI 编程智能体可以通过原生工具调用来部署预览和管理项目。支持 Claude Code、Cursor、Windsurf 及任何 MCP 兼容客户端。

配置

Claude Code：添加到 ~/.claude/settings.json：

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

Cursor：在项目根目录创建 .cursor/mcp.json：

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

Windsurf：添加到 ~/.codeium/windsurf/mcp_config.json：

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

可用工具

• deploy_preview — 部署构建产物目录或单个 HTML、Markdown、PDF 文档并获取固定预览 URL
• check_deployment — 通过 ID 检查部署状态
• show_usage — 查看剩余部署配额
• list_projects / get_project — 查看固定链接、项目状态、访问模式和是否可重新部署
• get_project_access / set_project_access — 在 PUBLIC 和 PASSWORD 之间切换；PUBLIC 会清除已保存密码
• list_project_versions / rollback_project_version — 查看 retained 版本，并把固定 URL 回滚到历史部署
• redeploy_project_latest — 使用 latest retained artifact 恢复过期的固定预览链接
• delete_project — 删除已确认的项目，并永久移除固定 URL、托管项目、部署关联和 Showcase 作品

PreviewShip 还提供一个可选的 Codex skill，用来分享当前 Codex 对话。它会把可见聊天记录生成高保真 HTML 页面，通过 PreviewShip CLI 部署，并返回公开 URL。

安装 skill

在 Codex 中使用

安装后，在 Codex 对话中引用这个 skill：

PreviewShip 还提供一个可选的 Claude Code skill，用来分享 Claude Code 对话。它会读取本地 Claude Code JSONL 历史，把可见聊天记录生成高保真 HTML 页面，通过 PreviewShip CLI 部署，并返回公开 URL。

安装 skill

在 Codex 中使用

安装后，在 Codex 对话中引用这个 skill，并让它分享 Claude Code 对话：

Cursor 完全兼容 VS Code 扩展，安装方式一致。

通过命令面板安装

1. 1打开 Cursor，按 Ctrl+P（Mac 按 Cmd+P）
2. 2粘贴以下命令并按回车：

通过 VSIX 安装

如果你需要离线安装，可以下载 .vsix 文件，参考下方「手动安装 VSIX」章节。

打开 VS Code，按 Ctrl+P（Mac 按 Cmd+P），粘贴以下命令并按回车：

如果你的环境无法访问扩展商店，可以通过 .vsix 文件手动安装。

安装步骤

1. 1点击上方按钮下载 .vsix 文件
2. 2打开 Cursor 或 VS Code，进入扩展面板（Ctrl+Shift+X）
3. 3点击扩展面板右上角的「...」→「从 VSIX 安装...」→ 选择下载的文件

也可以通过命令行安装：

所有部署方式（CLI、MCP、编辑器扩展）都需要 API Key。以下是创建步骤：

1. 1登录 previewship.com，进入 API Keys 页面
2. 2点击「创建 API Key」，输入名称，复制生成的密钥
3. 3在 CLI（previewship login）、MCP 配置（PREVIEWSHIP_API_KEY 环境变量）或编辑器扩展（Set API Key 命令）中使用

安装扩展并设置 API Key 后：

1. 1在编辑器中打开前端项目文件夹
2. 2打开命令面板（Ctrl+Shift+P），运行「PreviewShip: Deploy Workspace, HTML, Markdown, or PDF File」或「PreviewShip: Deploy Active HTML, Markdown, or PDF File」
3. 3插件会打包选中的构建产物、HTML、Markdown 或 PDF 文件，上传并在完成后返回预览 URL

也可以不安装工具，直接从 Web 控制台部署。控制台支持上传构建产物 zip、上传单个 HTML/Markdown/PDF 文件或粘贴 HTML 源码：

1. 1登录后进入「部署」页面
2. 2选择或新建项目，然后上传包含静态构建产物的 .zip、上传 .html/.md/.markdown/.pdf 文件，或粘贴完整 HTML 文档
3. 3PreviewShip 会将 zip 作为静态站点部署，把单个 HTML 输入打包为 index.html，为 Markdown 添加安全阅读页，并为 PDF 添加跳转入口，通过浏览器原生阅读器全屏打开原文件

项目是 PreviewShip 链接背后的稳定容器。每个项目拥有固定 URL、latest 部署指针、访问方式、retained 版本和可选 Showcase 状态。

• 使用新项目名称部署时会自动创建项目，认领 guest 预览后也会绑定到固定项目。
• 固定项目 URL 不会因为每次部署而变化；部署和回滚只改变该 URL 当前指向的内容。
• 公开项目可以正常分享。Pro 项目可设置密码访问；切回公开会清除密码。
• 版本历史受套餐限制：Free 保留 3 个可回滚版本，Pro Monthly 保留 10 个，Pro Yearly 保留 40 个，前提是 artifact 仍被保留。
• Free 包含 1 个项目。满额时，你可以删除不用的项目，或升级后再部署/认领新的预览。
• 删除项目会永久移除固定预览链接、托管项目、部署关联和 Showcase 作品。
• 只有公开且审核通过的 Showcase 作品可以被索引。密码项目、私密/隐藏作品、过期不可访问内容不会进入 sitemap。

PreviewShip 套餐同时包含部署额度、项目数、上传额度、保留时间、版本历史、访问控制和水印移除：