PreviewShip ドキュメント

PreviewShip はブラウザで開けるフロントエンド成果物を固定プレビュー URL にします。ワークフローに合う方法を選んでください：

1. 1previewship.com で無料アカウントを登録
2. 2コンソールの API Keys ページで API Key を作成
3. 3CLI、MCP、エディタ拡張、またはコンソールから React/Vue/Vite/Next の静的出力、index.html を含む zip、単一 HTML/Markdown/PDF、貼り付け HTML、エージェント生成物をデプロイします
4. 4固定プレビュー URL を共有し、必要に応じてアクセス、バージョン、ロールバック、再デプロイ、プロジェクト整理を管理します

共有したい成果物をブラウザで直接開ける状態なら PreviewShip が適しています。これはフロントエンドレビューリンク向けで、ソースコードビルドやバックエンドホスティングではありません。

1 つのターミナルコマンドでデプロイし、その後に固定 URL、公開/パスワードアクセス、バージョン、ロールバック、再デプロイ、削除を管理できます。CLI は AI エージェントや CI 向けの JSON 出力にも対応します。

インストール

npx で直接実行（インストール不要）、またはグローバルインストール：

API Key の設定

認証用の API Key を設定します：

環境変数で設定することもできます：

デプロイ

ビルド済み静的ディレクトリ、単一HTMLファイル、またはMarkdown文書をデプロイしてプレビューリンクを取得します:

エージェント向け 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 server は 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 をデプロイして固定プレビュー URL を返します
• check_deployment — デプロイ ID でデプロイ状況を確認
• show_usage — 残りのデプロイ枠を表示
• list_projects / get_project — 固定 URL、ステータス、アクセスモード、再デプロイ可否を確認します
• 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 会話を共有するための任意の Codex skill もあります。表示されている会話を高精度な HTML ページに変換し、PreviewShip CLI でデプロイして公開 URL を返します。

skill をインストール

Codex で使う

インストール後、Codex の会話で skill を参照します:

PreviewShipには、Claude Codeの会話を共有するための任意のClaude Code skillもあります。ローカルのClaude Code JSONL履歴を読み取り、可視チャットを高品質なHTMLページにレンダリングし、PreviewShip CLIでデプロイして公開URLを返します。

skillをインストール

Codexで使用

インストール後、Codexの会話でこのskillを参照し、Claude Code会話の共有を依頼します:

Cursor は VS Code 拡張機能と完全互換です。同じ方法でインストールできます。

コマンドパレットからインストール

1. 1Cursor を開き、Ctrl+P（Mac は Cmd+P）を押す
2. 2以下のコマンドを貼り付けて Enter を押す：

VSIX からインストール

オフラインインストールが必要な場合は、.vsix ファイルをダウンロードし、下の「VSIX 手動インストール」を参照してください。

VS Code を開き、Ctrl+P（Mac は Cmd+P）を押して、以下のコマンドを貼り付けて Enter を押します：

マーケットプレイスにアクセスできない環境では、.vsix ファイルで手動インストールできます。

インストール手順

1. 1上のボタンから .vsix ファイルをダウンロード
2. 2Cursor または VS Code を開き、拡張機能パネル（Ctrl+Shift+X）を開く
3. 3拡張機能パネル右上の「...」→「VSIX からインストール...」→ ダウンロードしたファイルを選択

コマンドラインからもインストールできます：

API Key はすべてのデプロイ方法（CLI、MCP、エディタ拡張機能）に必要です。作成手順：

1. 1previewship.com にログインし、API Keys ページへ移動
2. 2「API Key を作成」をクリックし、名前を入力して生成されたキーをコピー
3. 3CLI（previewship login）、MCP 設定（PREVIEWSHIP_API_KEY 環境変数）、またはエディタ拡張機能（Set API Key コマンド）でキーを使用

拡張機能のインストールと API Key の設定が完了したら：

1. 1エディタでフロントエンドプロジェクトフォルダを開く
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

ツールなしでWebコンソールから直接デプロイすることもできます。コンソールではビルド出力zip、単一HTML/Markdown/PDFファイル、HTML貼り付けに対応しています:

1. 1ログイン後、「デプロイ」ページへ移動
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はzipを静的サイトとしてデプロイし、単一HTMLをindex.htmlとしてパッケージし、単一Markdownは安全なビューアーページを追加してからデプロイします

プロジェクトは PreviewShip リンクの安定したコンテナです。固定 URL、latest ポインタ、アクセスモード、retained バージョン、任意の Showcase 状態を持ちます。

• 新しいプロジェクト名でデプロイすると自動作成され、guest プレビューを申請した場合も固定プロジェクトに紐づきます。
• 固定プロジェクト URL はデプロイごとに変わりません。デプロイとロールバックは、その URL が提供する内容だけを変えます。
• 公開プロジェクトは通常どおり共有できます。Pro はパスワードアクセスにでき、公開に戻すとパスワードが削除されます。
• バージョン履歴はプランに依存します：Free は 3 件、Pro Monthly は 10 件、Pro Yearly は 40 件を保持済み artifact の範囲で表示します。
• Free は 1 プロジェクトです。上限に達したら、使わないプロジェクトを削除するかアップグレードしてから新しいプレビューをデプロイ/申請します。
• プロジェクト削除は固定 URL、ホスト済みプロジェクト、デプロイ関連付け、Showcase 項目を完全に削除します。
• 公開かつ承認済みの Showcase 項目だけがインデックス対象です。パスワード付き、非公開/非表示、期限切れでアクセスできない内容は sitemap に入りません。

PreviewShip のプランは、デプロイクォータ、プロジェクト数、アップロード枠、保持期間、バージョン履歴、アクセス制御、ウォーターマーク削除を組み合わせています：