Shipyard Cli

🚀 Shipyard命令行工具（CLI）

Shipyard命令行工具（CLI）是一款用於管理Shipyard平臺上臨時環境的實用工具，能幫助用戶高效地在平臺上進行環境管理操作。

🚀 快速開始

在使用Shipyard CLI之前，你需要完成安裝和登錄操作。

📦 安裝指南

Linux和macOS系統

在終端中執行以下命令：

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

Windows系統

你可以訪問發佈頁面，並下載適用於Windows的可執行文件。

使用Homebrew安裝

brew tap shipyard/tap
brew install shipyard

💻 使用示例

登錄

運行shipyard login命令來初始化CLI。執行該命令後，系統會提示你在瀏覽器中登錄Shipyard平臺。登錄成功後，CLI會將你的API令牌保存在本地配置文件中，之後你就可以開始運行其他命令了。

手動設置令牌

你可以將Shipyard API令牌設置為SHIPYARD_API_TOKEN環境變量的值。你可以通過訪問個人資料頁面來獲取該令牌。 如果你希望為你的組織啟用API訪問權限，可以通過support@shipyard.build聯繫我們。如果你還有其他問題，歡迎加入我們的社區Slack。

shipyard set token

另外，你也可以使用默認存儲在$HOME/.shipyard/config.yaml中的配置文件。當你首次運行CLI時，它會創建一個默認的空配置文件，你可以對其進行編輯。 你還可以在任何命令中添加--config {path}標誌來指定非默認的配置文件路徑。在配置文件中添加任何配置值時，請確保文件遵循YAML語法。例如：

api_token: <your-token>
org: <your-non-default-org>

環境變量的值會覆蓋配置文件中對應的配置值。

基礎用法

獲取你所屬的所有組織

shipyard get orgs

設置全局默認組織

shipyard set org {org-name}

獲取當前配置的組織

shipyard get org

列出所有環境

shipyard get environments

可用的標誌參數如下：

名稱	描述	類型	默認值
branch	按分支名稱過濾	字符串
deleted	返回已刪除的環境	布爾值	false
json	打印完整的JSON輸出	布爾值	false
name	按應用程序名稱過濾	字符串
org-name	如果你屬於多個組織，可以按組織名稱過濾	字符串	你的默認組織
page	請求的頁碼	整數	1
page-size	請求的每頁數量	整數	20
pull-request-number	按拉取請求編號過濾	字符串
repo-name	按倉庫名稱過濾	字符串

示例：

• 列出在main分支上運行flask-backend倉庫的所有環境：

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

• 列出所有已刪除的環境：

shipyard get environments --deleted

根據環境的UUID獲取特定環境的詳細信息

shipyard get environment {environment_uuid}

可用的標誌參數如下：

名稱	描述	類型	默認值
json	打印完整的JSON輸出	布爾值	false
org-name	如果你屬於多個組織，可以按組織名稱過濾	字符串	你的默認組織

停止正在運行的環境

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}

可用的標誌參數如下：

名稱	描述	類型	默認值
follow	跟隨日誌輸出	布爾值	false
tail	顯示最近的日誌行數	整數	3000

處理卷

列出環境中的所有卷

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}

連接成功後，你將能夠直接與命名空間中的所有Pod進行通信。你可能需要使用命名空間主機名來與服務進行通信，你可以通過telepresence status命令在Namespace字段下獲取該主機名。例如，要與Redis進行通信，你可以使用redis.shipyard-app-build-{uuid}。

從代碼構建可執行文件

你可以通過運行以下命令來創建一個可執行文件：

make

要運行這個新的可執行文件，請執行：

./shipyard

啟用自動補全功能

Bash

此腳本依賴於bash-completion包。如果尚未安裝該包，你可以通過操作系統的包管理器進行安裝。 要在當前shell會話中加載補全功能，請執行：

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

如果你的環境中尚未啟用shell補全功能，你需要先啟用它。你可以執行以下命令一次：

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

要在當前shell會話中加載補全功能，請執行：

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

你需要啟動一個新的shell會話，此設置才能生效。

Fish

要在當前shell會話中加載補全功能，請執行：

$ shipyard completion fish | source

要在每個會話中加載補全功能，請執行一次以下命令：

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

PowerShell

要在當前shell會話中加載補全功能，請執行：

shipyard completion powershell | Out-String | Invoke-Expression

要在每個新會話中加載補全功能，請運行：

shipyard completion powershell > shipyard.ps1

並在你的PowerShell配置文件中引入該文件。

模型上下文協議（MCP）集成

Shipyard CLI提供了一個MCP服務器，用於集成AI助手。這使得像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" }