Previewship Mcp

PreviewShip

版本交付记录：2.0.1 — 后台内容审核和自动修复。

从编辑器、终端、AI Agent 或浏览器部署 React/Vue/Vite/Next 构建输出、HTML、Markdown 和 PDF 文档，并获取固定的预览 URL。

PreviewShip 是面向开发者和 AI 辅助工作流的前端预览部署平台。上传可直接在浏览器中运行的构建输出，例如 dist、build、out 或 public，发布单个 HTML、Markdown 或 PDF 文件，粘贴生成的 HTML，或让 AI 编码 Agent 部署静态制品，并在数秒内返回可分享的 PreviewShip URL。

PreviewShip 不是源代码构建平台。对于 React、Vue、Vite、Next、Astro、Svelte、Angular 或 Nuxt 项目，请先构建，再部署生成的静态输出文件夹或包含 index.html 的 zip 文件。单个 HTML、Markdown 和 PDF 文件可直接使用。

如何介绍 PreviewShip

在 npm、GitHub、VS Code Marketplace、Open VSX、MCP 目录和 AI Agent 工具列表中使用以下简短介绍：

PreviewShip 可在线发布 HTML、托管 HTML 文件，并通过 CLI、VS Code/Cursor、MCP Agent 和浏览器上传，将可直接在浏览器中运行的 React/Vue/Vite/Next 构建输出、Markdown 和 AI 生成的静态页面部署到固定的预览 URL。

实用深层链接

在开发者目录、MCP 目录、README 文件、文章或社区答复中列出 PreviewShip 时，请使用这些链接：

• 立即上传页面 — 无需 Git、域名或服务器
• 浏览产品对比
• 核实产品和定价信息
• 部署最小静态示例
• 从 Claude Code 部署
• 将 Claude HTML 制品分享为在线 URL
• 单个 HTML 文件或 ZIP 的 Netlify Drop 替代方案
• 将 HTML 文件上传到网站
• 分享 Codex 聊天对话
• 分享 Claude Code 聊天对话
• 比较 PreviewShip 和 Netlify Drop

西班牙语工作流指南：

• 从 Claude Code 部署预览
• 从 Visual Studio Code 发布
• 从 Cursor 部署预览
• 在网上发布 HTML 文件

开源软件包

PreviewShip 提供四个开源客户端软件包：

软件包	npm	描述
CLI	previewship	从终端部署前端构建输出、HTML、Markdown 或 PDF
MCP 服务	previewship-mcp	面向 Claude Code、Cursor、Windsurf 和 MCP Agent 的原生部署工具
VS Code 扩展	Marketplace	一键从编辑器部署构建输出或当前打开的 HTML/Markdown/PDF 文件
Agent 技能	GitHub / npx skills	可安装的技能，适用于 Codex 和 Claude Code 工作流，包括高保真聊天分享

部署方式

方式	命令 / 操作	最适用于
CLI	npx previewship deploy ./dist、./report.html、./README.md 或 ./report.pdf	终端、脚本、CI/CD、前端构建、文档
MCP 服务	在 AI 聊天中说“构建应用，并将 dist 文件夹部署到 PreviewShip”	Claude Code、Cursor、Windsurf、Agent 工作流
VS Code / Cursor 扩展	命令面板 → PreviewShip: Deploy Workspace, HTML, Markdown, or PDF File	以编辑器为主的工作流、构建文件夹、当前打开的 HTML/Markdown/PDF 文件
Agent 技能	$share-codex-chat / $share-claude-code-chat	将 Codex 或 Claude Code 对话发布为可分享的高保真聊天页面
Web 控制台	上传 zip/html/markdown/pdf，或在 previewship.com 粘贴 HTML	无需工具即可部署

每个项目都有一个固定的预览 URL。可通过相同的部署流程进行公开发布或密码保护发布；密码保护是 Pro 功能。

支持的输入

输入	是否支持	备注
React/Vue/Vite/Svelte/Astro 构建输出	是	部署 dist、build、out、public，或包含 index.html 的 zip
Next.js 静态导出	是	部署导出的静态文件夹
单个 .html 文件	是	自动打包为 index.html
Markdown .md / .markdown 文件	是	通过生成的查看器页面发布
PDF .pdf 文件	是	使用浏览器原生 PDF 查看器全屏打开
包含 package.json、src/ 和 node_modules 的原始源文件夹	否	请先运行构建，再部署生成的输出

PDF 入口选择会保留网站现有行为：HTML 优先于 Markdown，Markdown 优先于 PDF。单个 PDF 会自动成为全屏入口；如果归档文件包含多个 PDF，且不含 HTML 或 Markdown，请将根入口命名为 index.pdf，或只上传一个 PDF。

发布工作流

• 上传 HTML 文件、ZIP 或构建输出
• 从 Claude Code 部署
• 分享 Claude HTML artifacts
• 部署 React/Vue 构建输出
• 将 Markdown 转换为网站
• 上传并分享 PDF
• 在线发布 AI 生成的 HTML
• 预览托管与生产托管
• 单个 HTML 文件或 ZIP 的 Netlify Drop 替代方案
• 比较 PreviewShip 与 Netlify Drop
• 使用 share-codex-chat 技能，将 Codex 聊天记录分享为公开的 PreviewShip URL
• 使用 share-claude-code-chat 技能，将 Claude Code 聊天记录和工具时间线分享为公开的 PreviewShip URL

---

CLI

在任意终端中通过一条命令部署。支持为 AI Agent 和 CI 流水线生成 JSON 输出。

快速入门

# Set your API Key
npx previewship login --key ps_live_YOUR_KEY

# Deploy a directory
npx previewship deploy ./dist

# Deploy a single HTML file
npx previewship deploy ./report.html

# Deploy a Markdown document
npx previewship deploy ./README.md

# Deploy a PDF document
npx previewship deploy ./report.pdf

对于压缩包上传或目录部署，请部署静态构建产物，而不是原始源项目。先运行框架构建，然后部署 dist、build、out、public 等目录，或包含 index.html 及其资源的 zip。不要上传包含 package.json、src/ 和 node_modules 的源代码 zip，并期待 PreviewShip 为其构建。

命令

命令	说明
previewship login [--key KEY]	设置用于身份验证的 API Key
previewship deploy [path] [-n name] [--json]	部署目录、单个 HTML、Markdown 或 PDF 文档，并获取预览 URL
previewship status <id> [--json]	按 ID 检查部署状态
previewship deployments list [--status READY] [--days 30]	列出部署历史记录和回滚可用情况
`previewship projects list	get
previewship usage [--json]	显示剩余部署配额
previewship whoami	显示当前配置

选项

# Deploy with a custom project name
npx previewship deploy ./dist -n my-project

# JSON output for AI agents and CI
npx previewship deploy ./dist --json

# Custom exclude patterns
npx previewship deploy ./dist --exclude "*.map" --exclude "tests/**"

项目名称是 PreviewShip 中的显示名称。名称可以简短自然；PreviewShip 会自动创建适用于部署的托管 slug。

环境变量

变量	说明
PREVIEWSHIP_API_KEY	API Key（覆盖已保存的配置）
PREVIEWSHIP_SERVER_URL	自定义 API 服务 URL
CI	在 CI 环境中自动启用 JSON 输出
NO_COLOR	禁用彩色输出

编程式用法

CLI 也会导出其核心函数，供作为库使用：

import {
  deploy,
  getStatus,
  getUsage,
  listProjects,
  getProject,
  deleteProject,
  getProjectAccess,
  updateProjectAccess,
  listProjectVersions,
  rollbackProjectVersion,
  redeployProject,
  listDeployments,
} from 'previewship'
import { ApiClient } from 'previewship'
import { packDirectory, DEFAULT_EXCLUDE_PATTERNS } from 'previewship'

使用 updateProjectAccess(projectId, { visibility: 'PUBLIC' }) 可清除现有项目密码，并将固定预览 URL 切换回公开访问。

---

Agent 技能

可安装的技能让 PreviewShip 成为原生支持 Agent 的工作流，而不只是一个部署命令。随附的 share-codex-chat 和 share-claude-code-chat 技能会将 AI 编码对话转换为高保真 HTML 页面并部署到 PreviewShip，让用户无需截图即可分享调试会话、实现审查、工具时间线和 AI 生成的作品。

安装 Share Codex Chat

全局安装：

npx skills add blockdancez/PreviewShip --skill share-codex-chat -a codex -g --yes

在项目根目录运行，安装到项目本地：

npx skills add blockdancez/PreviewShip --skill share-codex-chat -a codex --yes

然后在 Codex 中使用：

$share-codex-chat 分享当前 Codex 对话

此技能会保留可见的 Codex UI 元素，例如用户气泡、助手回复、上传的图片缩略图、插件提及、折叠的处理详情、文件卡片和已编辑文件摘要。它会过滤隐藏的系统/开发者上下文，并通过 PreviewShip CLI 部署生成的 HTML。

安装 Share Claude Code Chat

全局安装：

npx skills add blockdancez/PreviewShip --skill share-claude-code-chat -a codex -g --yes

在项目根目录运行，安装到项目本地：

npx skills add blockdancez/PreviewShip --skill share-claude-code-chat -a codex --yes

然后在 Codex 中使用：

$share-claude-code-chat 分享 Claude Code 对话

此技能会从 ~/.claude/projects 读取 Claude Code JSONL 会话，将可见消息和安全的工具活动渲染为精美的分享页面，隐藏推理和原始工具输出，并通过 PreviewShip CLI 部署生成的 HTML。

---

MCP 服务

Model Context Protocol 服务，可让 AI 编码 Agent 通过原生工具调用部署预览。兼容 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"
      }
    }
  }
}

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

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

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

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

可用工具

工具	描述	参数
deploy_preview	部署构建输出目录、单个 HTML、Markdown 或 PDF 文档，并获取预览 URL	path（可选）、projectName（可选）、excludePatterns（可选）
check_deployment	按 ID 检查部署状态	deploymentId（必填）
show_usage	显示剩余部署配额	—
list_projects, get_project	查看固定预览 URL、项目状态、访问模式和重新部署状态	详情查询使用 projectId
set_project_access, get_project_access	设置公开/密码访问；PUBLIC 会清除现有密码	projectId、visibility；密码模式下还需提供 password
list_project_versions, rollback_project_version	分页查看保留的版本，并从历史版本排队发起新部署	projectId、page、size、deploymentId、confirmProjectName
redeploy_project_latest	从最新保留的构件恢复已过期的固定预览链接	projectId
delete_project	删除项目及其固定预览 URL；需准确确认项目名称	projectId、confirmProjectName
list_deployments	列出部署历史、来源、当前标记和回滚可用状态	status、query、days、page、size

用法

配置完成后，只需向 AI Agent 提出请求：

“将此项目部署到 PreviewShip” “查看我上次部署的状态” “我今天还剩多少次部署额度？”

---

VS Code / Cursor 扩展

在 VS Code 或 Cursor 中一键部署。可部署工作区、检测到的构建输出，或当前活动的 HTML/Markdown/PDF 文件。可从 VS Code Marketplace 或 Open VSX Registry 安装。

安装

通过命令面板（Ctrl+P / Cmd+P）：

ext install previewship.previewship

通过 VSIX（离线安装）：

code --install-extension previewship-0.1.8.vsix
# Or for Cursor:
cursor --install-extension previewship-0.1.8.vsix

命令

命令	描述
PreviewShip: Set API Key	安全存储 API Key（通过 VS Code Secrets API 加密）
PreviewShip: Deploy Workspace, HTML, Markdown, or PDF File	打包、上传并部署项目；当前活动文件受支持时，可选择部署文件或工作区
PreviewShip: Deploy Active HTML, Markdown, or PDF File	将当前活动的 HTML、Markdown 或 PDF 文件打包为站点入口并直接部署
PreviewShip: Show Usage	显示每日/每月部署配额

设置

设置	默认值	描述
previewship.serverUrl	https://api.previewship.com	API 服务 URL
previewship.excludePatterns	node_modules/**, .git/**, .env* 等	打包时排除的文件模式
previewship.pollIntervalMs	3000	部署状态轮询间隔（ms）
previewship.pollTimeoutMs	300000	轮询超时时间（ms）

---

开始使用

1. 注册 previewship.com 免费账户
2. 创建 API Key，前往控制台 → API Keys 页面
3. 使用以上任意方法进行部署
4. 与团队分享预览链接

套餐

	免费	Pro 月付	Pro 年付
价格	$0	$8.10/月，默认优惠价（原价 $9/月）	$75.60/年，默认优惠价（原价 $84/年，$6.30/月）
项目数	1	20	40
每日部署次数	5	50	80
每月部署次数	20	300	500
最大 Zip 大小	15 MB	50 MB	80 MB
托管	3 天后过期	订阅期间持续托管	订阅期间持续托管
当前托管保障	3 天	1 个月，滚动计算	12 个月，滚动计算
版本历史	保留 3 个版本	保留 10 个版本	保留 40 个版本
项目密码访问	不包含	包含	包含
公开/密码访问切换	仅公开访问	包含	包含
PreviewShip 水印	包含	移除	移除

Stripe 价格仍为 $9/月和 $84/年。结账时会自动应用符合条件的优惠券：默认情况下，新用户可永久享受 10% 折扣；BR/PT 葡萄牙语营销活动和用户留存流程可获得限时 40% 优惠；现有的旧版月付用户升级为年付时，可永久保留旧版 40% 优惠。

免费套餐无需信用卡。立即开始部署。

支持的框架

任何静态前端输出均可使用 — React、Vue、Svelte、Angular、Next.js（导出）、Nuxt（生成）、Astro、原生 HTML/CSS/JS、Markdown、PDF 等。构建输出目录应包含 index.html。单个 .html 文件会成为入口页面；Markdown 会生成一个查看器；单个 PDF 文档会通过浏览器原生 PDF 查看器全屏打开，并在浏览器支持时提供缩放、搜索、打印和下载控件。

重要提示：PreviewShip 托管静态产物；上传后不会运行 npm install，也不会构建原始源码压缩包。如果你的项目使用 React/Vue/Next/Astro 等，请先运行构建命令，再上传生成的输出文件夹或压缩包。

要求

• Node.js ≥ 20.0.0（用于 CLI 和 MCP）
• VS Code ≥ 1.85.0（用于扩展）
• 来自 previewship.com 的 API Key

链接

• 网站：previewship.com
• 文档：previewship.com/docs
• npm 上的 CLI：npmjs.com/package/previewship
• npm 上的 MCP：npmjs.com/package/previewship-mcp
• VS Code Marketplace：marketplace.visualstudio.com
• Agent Skills：skills/

许可证

MIT — 详情请参阅 LICENSE。