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貼上以下指令並按 Enter：

透過 VSIX 安裝

如果你需要離線安裝，可以下載 .vsix 檔案，參考下方「手動安裝 VSIX」章節。

開啟 VS Code，按 Ctrl+P（Mac 按 Cmd+P），貼上以下指令並按 Enter：

如果你的環境無法存取擴充功能商店，可以透過 .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 方案同時包含部署額度、專案數、上傳額度、保留時間、版本歷史、存取控制和浮水印移除：