Shipyard Cli

🚀 Shipyard CLI

Shipyardプラットフォーム上のエフェメラル環境を管理するためのツールです。

🚀 クイックスタート

Shipyard CLIを使用することで、Shipyardプラットフォーム上のエフェメラル環境を簡単に管理できます。以下に、インストール方法や基本的な使い方を紹介します。

✨ 主な機能

• Shipyardプラットフォーム上のエフェメラル環境の管理
• 組織や環境の情報取得
• 環境の起動、停止、再開、再構築などの操作
• ボリュームの管理とスナップショットの操作
• AIアシスタントとの統合（MCPサーバー提供）

📦 インストール

• LinuxとmacOS

  curl https://www.shipyard.sh/install.sh | bash
  

• Windows リリースページにアクセスし、Windows用の実行ファイルをダウンロードします。

• Homebrew

  brew tap shipyard/tap
  brew install shipyard
  

💻 使用例

基本的な使用法

所属するすべての組織を取得する

shipyard get orgs

グローバルなデフォルト組織を設定する

shipyard set org {org-name}

現在設定されている組織を取得する

shipyard get org

すべての環境をリストする

shipyard get environments

利用可能なフラグ:

例:

• リポジトリ flask-backend の main ブランチで実行されているすべての環境をリストする:

shipyard get environments --repo-name flask-backend --branch main

• すべての削除された環境をリストする:

shipyard get environments --deleted

特定の環境の詳細をUUIDで取得する

shipyard get environment {environment_uuid}

利用可能なフラグ:

実行中の環境を停止する

shipyard stop environment {environment_uuid}

停止した環境を再開する

shipyard restart environment {environment_uuid}

環境の進行中のビルドをキャンセルする

shipyard cancel environment {environment_uuid}

環境を再構築する

shipyard rebuild environment {environment_uuid}

削除された環境を復活させる

shipyard revive environment {environment_uuid}

環境のすべてのサービスと公開ポートを取得する

shipyard get services --env {environment_uuid}

実行中の環境のサービスにアクセスする

実行中の環境の特定のサービスで、任意の引数とフラグを持つコマンドを実行します。ダブルスラッシュの後にコマンド引数を渡します。

shipyard exec --env {environment_uuid} --service {service_name} -- bash

実行中の環境のサービスのポートを転送する

shipyard port-forward --env {environment_uuid} --service {service_name} --ports {local_port}:{service_container_port}

実行中の環境のサービスのログを取得する

shipyard logs --env {environment_uuid} --service {service_name}

環境を訪問する

shipyard visit {environment_uuid}

利用可能なフラグ:

ボリュームの操作

環境内のすべてのボリュームをリストする

shipyard get volumes --env {environment_uuid}

環境内のすべてのボリュームスナップショットをリストする

shipyard get snapshots --env {environment_uuid}

環境内のボリュームをリセットする

shipyard reset volume --env {environment_uuid}

環境内でボリュームスナップショットを作成する

shipyard create snapshot --env {environment_uuid}

環境内のボリュームスナップショットを読み込む

shipyard load snapshot --env {environment_uuid} --sequence-number {n}

環境内のボリュームにファイルをアップロードする

shipyard upload volume --env {environment_uuid} --volume {volume} --file {filepath.bz2}

Telepresenceに接続する

shipyard telepresence connect --env {environment_uuid}

これにより、名前空間内のすべてのポッドと直接通信できるようになります。サービスと通信するために名前空間のホスト名を使用する必要がある場合があります。これは、telepresence status の Namespace フィールドから取得できます。たとえば、redis と通信するには、redis.shipyard-app-build-{uuid} を使用します。

コードから実行ファイルをビルドする

次のコマンドを実行することで、実行ファイルを作成できます。

make

この新しい実行ファイルを実行するには:

./shipyard

自動補完を有効にする

Bash

このスクリプトは bash-completion パッケージに依存しています。まだインストールされていない場合は、OSのパッケージマネージャーを使ってインストールできます。 現在のシェルセッションで補完を読み込むには:

source <(shipyard completion bash)

すべての新しいセッションで補完を読み込むには、以下を一度実行します。

Linuxでは:

shipyard completion bash > /etc/bash_completion.d/shipyard

macOSでは:

shipyard completion bash > $(brew --prefix)/etc/bash_completion.d/shipyard

Zsh

シェル補完が環境でまだ有効になっていない場合は、有効にする必要があります。以下を一度実行できます。

echo "autoload -U compinit; compinit" >> ~/.zshrc

現在のシェルセッションで補完を読み込むには:

source <(shipyard completion zsh); compdef _shipyard shipyard

すべての新しいセッションで補完を読み込むには、以下を一度実行します。

Linuxでは:

shipyard completion zsh > "${fpath[1]}/_shipyard"

macOSでは:

shipyard completion zsh > $(brew --prefix)/share/zsh/site-functions/_shipyard

この設定を有効にするには、新しいシェルを起動する必要があります。

Fish

現在のシェルセッションで補完を読み込むには:

$ shipyard completion fish | source

各セッションで補完を読み込むには、一度実行します。

shipyard completion fish > ~/.config/fish/completions/shipyard.fish

PowerShell

現在のシェルセッションで補完を読み込むには:

shipyard completion powershell | Out-String | Invoke-Expression

すべての新しいセッションで補完を読み込むには、次を実行します。

shipyard completion powershell > shipyard.ps1

そして、PowerShellプロファイルからこのファイルを読み込みます。

📚 ドキュメント

モデルコンテキストプロトコル (MCP) 統合

Shipyard CLIは、AIアシスタント統合用のMCPサーバーを提供します。これにより、ClaudeなどのAIアシスタントがShipyard環境を直接管理できるようになります。

サポートされるMCPツール

環境管理 (7つのツール)

• get_environments - フィルタリングを伴う環境のリスト
• get_environment - 特定の環境の詳細を取得
• stop_environment - 実行中の環境を停止
• restart_environment - 停止した環境を再開
• rebuild_environment - 最新のコミットで再構築
• cancel_environment - 環境の最新のビルドをキャンセル
• revive_environment - 削除された環境を復活させる

サービス管理 (2つのツール)

• get_services - 環境内のサービスをリスト
• get_logs - サービスからログを取得

ボリューム管理 (5つのツール)

• get_volumes - 環境内のボリュームをリスト
• reset_volume - ボリュームを初期状態にリセット
• get_snapshots - ボリュームスナップショットをリスト
• create_snapshot - ボリュームスナップショットを作成
• load_snapshot - ボリュームスナップショットを読み込む

組織管理 (3つのツール)

• get_orgs - すべての組織をリスト
• get_org - 現在のデフォルト組織を取得
• set_org - デフォルト組織を設定

制限付きツール

これらのツールは、ユーザーにCLIコマンドの使用を指示するヘルプテキストを返します。

• exec_service - サービスコンテナ内でコマンドを実行
• port_forward - サービスをローカルマシンにポート転送
• telepresence_connect - Telepresenceに接続

Claudeに追加する

APIトークンと組織名を指定する場合:

claude mcp add shipyard --env SHIPYARD_API_TOKEN=your-token-here --env SHIPYARD_ORG=your-org-name -- shipyard mcp serve

CLIですでに構成されている場合:

claude mcp add shipyard -- shipyard mcp serve

Codex CLIに追加する

~/.codex/config.toml を編集して、以下を追加します。

[mcp_servers.shipyard]
command = "shipyard"
args = ["mcp", "serve"]
env = { "SHIPYARD_API_TOKEN" = "your-token-here", "SHIPYARD_ORG" = "your-org-name" }