Shipyard

resmi

Shipyard CLI, aracıların Shipyard ortamlarını doğrudan yönetmesi için bir MCP sunucusu sağlar: günlükleri çekme, dalları karşılaştırma, testleri çalıştırma ve ortamları durdurma/başlatma gibi işlemlerle.

Shipyard MCP ile neler yapabilirsiniz?

  • Ortamları listeleme — Depo, dal, çekme isteği numarası veya ada göre filtreleyerek hangi ortamların çalıştığını sorun.
  • Bir ortamı inceleme — Hizmetleri ve dışa açılan bağlantı noktaları da dahil olmak üzere, UUID ile belirli bir ortamın ayrıntılarını alın.
  • Hizmet günlüklerini okuma — Çalışan bir ortamdaki hizmetin günlüklerini gösterin; isteğe bağlı olarak çıktıyı canlı takip edin.
  • Ortam yaşam döngüsünü yönetme — UUID ile bir ortamı durdurun, yeniden başlatın, iptal edin, yeniden oluşturun veya yeniden etkinleştirin.
  • Ortam değişkenlerini yapılandırma — Bir ortama ortam değişkenleri ayarlayın ve bunları uygulamak için bir hizmeti yeniden başlatın.
  • Gönderilen bir değişikliği doğrulama — verify istemini kullanarak gönderilen bir değişikliği ortamında kontrol edin.

Dokümantasyon

Shipyard CLI

Shipyard platformunda Ephemeral Environments yönetmek için bir araç.

Bir yapay zekâ asistanı mı kullanıyorsunuz? CLI bir MCP sunucusu içerir: Shipyard'ı bir yapay zekâ asistanından kullanma bölümüne bakın.

Kurulum

  • Linux ve macOS

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

    /usr/local/bin konumuna kurulur; buraya yazamıyorsa yalnızca sudo kullanılır. Sahip olduğunuz bir dizin gibi başka bir konuma kurmak için SHIPYARD_INSTALL_DIR ayarlayın:

    curl https://www.shipyard.sh/install.sh | SHIPYARD_INSTALL_DIR="$HOME/.local/bin" bash
    
  • Windows Sürümler sayfasına gidin ve Windows için yürütülebilir dosyayı indirin.

  • Homebrew

    brew tap shipyard/tap
    brew install shipyard
    

İndirilen dosyayı doğrulama

Her sürüm, her ikili dosyanın SHA-256 değerini içeren bir checksums.txt yayımlar. Kurulum betiği ikili dosyayı bu değerle karşılaştırır ve eşleşme yoksa kurulumu reddeder. Kendiniz indirdiğiniz bir ikili dosyayı denetlemek için:

grep " shipyard-darwin-arm64$" checksums.txt | shasum -a 256 -c -

checksums.txt, ikili dosyayla aynı sürümden gelir; bu nedenle bozuk veya eksik indirmeleri yakalar, dosyaları değiştirilmiş bir sürümü değil. Aşağıdaki doğrulama, ikili dosyanın bu deponun sürüm iş akışı tarafından oluşturulduğunu denetler.

1.9.0 sonrasındaki sürümlerde her ikili dosyanın ayrıca hangi iş akışı çalıştırmasının, commit'in ve etiketin onu oluşturduğunu gösteren imzalı bir derleme kökeni doğrulaması ve ne kullanılarak oluşturulduğunu listeleyen bir SPDX SBOM'u (shipyard-<os>-<arch>.sbom.json; Windows'ta .exe.sbom.json) bulunur. İndirdiğiniz sürümün adını belirterek doğrulamayı GitHub CLI ile denetleyin (burada v1.10.0):

gh attestation verify shipyard-darwin-arm64 -R shipyard/shipyard-cli \
  --signer-workflow shipyard/shipyard-cli/.github/workflows/release.yaml \
  --source-ref refs/tags/v1.10.0

--source-ref değerini koruyun: bu olmadan denetim, yalnızca o sürümün etiket derlemesi için değil, iş akışının herhangi bir dalda imzaladığı her şey için başarılı olur.

Denetim commit'i değil, etiketi adlandırır. Geri çekilen bir sürümün doğrulamaları silinmez; dolayısıyla bir sürüm aynı etiketle yeniden yayımlanırsa geri çekilen ikili dosyaları da doğrulamadan geçer. Commit'i de sabitlemek için etiketin işaret ettiği commit'i içeren --source-digest <commit SHA> ekleyin.

Bir sürümü yeniden derleme

1.10.0 sonrasındaki sürümler yeniden üretilebilir: sürüm etiketini aynı Go ve GoReleaser sürümleriyle yeniden derlemek, herhangi bir dizinde bayt bayt aynı ikili dosyaları verir. Sürümler, o etiketin .github/workflows/release.yaml dosyasındaki GO_VERSION ve GORELEASER_VERSION değerleridir. Bu GoReleaser kurulu durumdayken ve aşağıda 1.26.11 yerine GO_VERSION kullanarak (GOTOOLCHAIN, Go'nun gerekirse indirerek tam olarak bu sürümü kullanmasını sağlar; GOFLAGS= ise kendi derleme bayraklarınızı devre dışı bırakır):

git clone https://github.com/shipyard/shipyard-cli && cd shipyard-cli
git checkout vX.Y.Z
GOTOOLCHAIN=go1.26.11 GOFLAGS= goreleaser release --clean --skip=publish,sbom
grep " shipyard-linux-amd64$" dist/checksums.txt

Özet değeri, sürümün checksums.txt dosyasındaki aynı satırla eşleşmelidir. Eşleşmiyorsa sürümden şüphelenmeden önce Go ve GoReleaser sürümlerinizi (GOTOOLCHAIN=go1.26.11 go version, goreleaser --version) denetleyin. Sürüm iş akışı, sürümü derlemeden önce her sürüm commit'inde bunu denetler (scripts/check-reproducible.sh). SBOM'lar yeniden üretilebilir değildir: oluşturuldukları zamanı kaydederler. CLI'ın kendi modülüne ait girdide sürüm (devel) olarak görünür; çünkü derleme Go'nun VCS damgasını eklemez. shipyard --version sürüm numarasını yazdırır.

Yükseltme

shipyard upgrade

shipyard update aynı işi yapar. En son sürümü kurar ve sürüm notlarını gösterir. Homebrew kurulumu brew upgrade shipyard ile yükseltilir; diğer kurulumlarda sürüm ikili dosyası indirilir, sürümün checksums.txt dosyasına göre doğrulanır ve çalışan ikili dosyanın yerine konur. İkili dosya, yazma izniniz olmayan bir dizindeyse (örneğin /usr/local/bin), sudo shipyard upgrade çalıştırın.

Ön sürümleri dahil etmek için --prerelease ekleyin veya mevcut sürümü yeniden kurmak için --force ekleyin (Homebrew kurulumu için bunun yerine brew reinstall shipyard kullanın).

1.9.0 veya önceki sürümlerden yükseltme

1.9.0 ve önceki sürümlerdeki shipyard update, sürümleri metin olarak karşılaştırır; bu nedenle 1.10.0 ve sonraki sürümleri sizdeki sürümden eski olarak bildirir. Kurulum yönteminize göre bir kez yükseltin; bundan sonra shipyard upgrade çalışır:

  • Linux ve macOS: curl https://www.shipyard.sh/install.sh | bash
  • Windows: yürütülebilir dosyayı sürümler sayfasından indirin
  • Homebrew: brew upgrade shipyard

Güncelleme bildirimleri

Yeni bir sürüm çıktığında CLI, bir komut tamamlandıktan sonra günde en fazla bir kez sizi bilgilendirir:

A new version of shipyard is available: 1.9.0 → 1.10.0
Run `shipyard upgrade` to install it. Release notes: https://github.com/shipyard/shipyard-cli/releases/tag/v1.10.0

Hiçbir şey sormaz veya girdi beklemez. Denetim, komutunuz çalışırken arka planda yürütülür; komut tamamlandığında bitmemişse CLI en fazla bir saniye bekler. Bu yalnızca GitHub'a bağlanırken, yaklaşık günde bir kez veya kaçırdığınız sürüm notlarını almak için gerçekleşir. brew upgrade gibi başka bir yöntemle yapılan yükseltmeden sonraki ilk çalıştırmada bu notlar gösterilir.

Mesaj stderr'e yazılır ve yalnızca stderr bir terminal olduğunda gösterilir. CI'da, kendini tanıtan yapay zekâ kodlama ajanlarında (Claude Code, Codex, Cursor's agent, Gemini CLI) veya shipyard mcp serve için hiçbir zaman gösterilmez. Kapatmak için SHIPYARD_NO_UPDATE_CHECK=1 ayarlayın veya ~/.shipyard/config.yaml öğesine update_check: false ekleyin.

Otomatik güncellemeyi kapatma

GitHub'a erişemeyen, kendi barındırdığınız bir Shipyard'da CLI, Shipyard sürümünüzle birlikte gelir. ~/.shipyard/config.yaml içinde self_update: false ayarlayarak veya SHIPYARD_SELF_UPDATE=false kullanarak otomatik güncellemeyi kapatın. Böylece CLI GitHub'la hiçbir zaman iletişim kurmaz: güncelleme bildirimi gösterilmez, shipyard mcp serve arka plan denetimi yapmaz ve shipyard upgrade, otomatik güncellemenin kapalı olduğunu belirten bir mesajla işlemi reddeder. update_check: false yalnızca bildirimi ve arka plan denetimini kapatır.

Oturum açma

CLI'ı başlatmak için shipyard login çalıştırın. Tarayıcıda Shipyard'da oturum açmanız istenir. CLI daha sonra API token'ınızı yerel bir yapılandırma dosyasına kaydeder. Artık komutları çalıştırmaya hazırsınız.

Kendi barındırdığınız Shipyard

Kendi barındırdığınız bir Shipyard'ı kullanmak için oturum açmadan önce CLI'ı ~/.shipyard/config.yaml içinde (veya SHIPYARD_API_URL ile) API'sine yönlendirin:

api_url: https://shipyard.example.internal/api/v1
self_update: false

shipyard login daha sonra bu sunucunun oturum açma sayfasını açar ve her komut bu API'yi çağırır. Kurulum GitHub'a erişemiyorsa self_update: false ayarlayın (Otomatik güncellemeyi kapatma bölümüne bakın).

Başka bir Shipyard'da (örneğin shipyard.build) zaten oturum açtıysanız shipyard login bu token'ı korur ve oturumunuzun açık olduğunu bildirir. Kendi barındırdığınız kuruluma giriş yapmadan önce yapılandırma dosyasından api_token öğesini kaldırın ve SHIPYARD_API_TOKEN değerini temizleyin.

Token'ınızı elle ayarlama

Shipyard API token'ınızı SHIPYARD_API_TOKEN ortam değişkeninin değeri olarak ayarlayın.

Token'ı profil sayfanıza giderek alabilirsiniz.

Kuruluşunuz için API erişimini etkinleştirmek isterseniz support@shipyard.build adresinden bize ulaşabilirsiniz. Başka sorularınız varsa topluluğumuza Slack üzerinden katılabilirsiniz.

shipyard set token

Alternatif olarak, varsayılan olarak $HOME/.shipyard/config.yaml konumunda saklanan bir yapılandırma dosyası kullanabilirsiniz. CLI'ı ilk kez çalıştırdığınızda, düzenleyebileceğiniz varsayılan ve boş bir yapılandırma dosyası oluşturulur.

Herhangi bir komuta --config {path} bayrağını ekleyerek varsayılan olmayan bir yapılandırma yolu da belirtebilirsiniz.

Yapılandırma değerlerini dosyanıza ekleyin ve dosyanın YAML sözdizimine uygun olduğundan emin olun. Örneğin:

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

Ortam değişkenlerinizin değerleri, yapılandırmadaki karşılık gelen değerlerin üzerine yazar.

Temel kullanım

Üyesi olduğunuz tüm kuruluşları listeleme

shipyard get orgs

Genel varsayılan kuruluşu ayarlama

shipyard set org {org-name}

Şu anda yapılandırılmış kuruluşu görüntüleme

shipyard get org

Tüm ortamları listeleme

shipyard get environments

Kullanılabilir bayraklar:

AdAçıklamaTürVarsayılan değer
branchDal adına göre filtrelestring
deletedSilinmiş ortamları döndürbooleanfalse
jsonJSON çıktısının tamamını yazdırbooleanfalse
nameUygulama adına göre filtrelestring
org-nameBirden fazla kuruluşun üyesiyseniz kuruluş adına göre filtrelestringvarsayılan kuruluşunuz
pageİstenen sayfa numarasıint1
page-sizeİstenen sayfa boyutuint20
pull-request-numberPull request numarasına göre filtrelestring
repo-nameDepo adına göre filtrelestring

Örnekler:

  • main dalında çalışan flask-backend deposunun tüm ortamlarını listeleyin:
shipyard get environments --repo-name flask-backend --branch main
  • Silinmiş tüm ortamları listeleyin:
shipyard get environments --deleted

UUID'sine göre belirli bir ortamın ayrıntılarını görüntüleme

shipyard get environment {environment_uuid}

Kullanılabilir bayraklar:

AdAçıklamaTürVarsayılan değer
jsonJSON çıktısının tamamını yazdırbooleanfalse
orgBirden fazla kuruluşun üyesiyseniz ortamın kuruluşustringvarsayılan kuruluşunuz
bypass-tokenBetikler için yalnızca ortamın bypass token'ını yazdırbooleanfalse

--bypass-token, bir betiğin token'ı kimse yazmadan veya ekrana basmadan kullanmasını sağlar:

SHIPYARD_TOKEN=$(shipyard get environment {environment_uuid} --bypass-token) && \
  export SHIPYARD_TOKEN && curl -b "shipyard_token=$SHIPYARD_TOKEN" https://your-environment-url/

Çalışan bir ortamı durdurma

shipyard stop environment {environment_uuid}

Durdurulmuş bir ortamı yeniden başlatma

shipyard restart environment {environment_uuid}

Bir ortam için devam eden derlemeyi iptal etme

shipyard cancel environment {environment_uuid}

Bir ortamı yeniden derleme

shipyard rebuild environment {environment_uuid}

Silinmiş bir ortamı yeniden etkinleştirme

shipyard revive environment {environment_uuid}

Bağımsız bir ortam dağıtma

Mevcut bir uygulama derlemesini klonlayarak yeni ve bağımsız ("detached") bir ortam oluşturun. Kuruluşunuzda detached environments özelliğinin etkinleştirilmiş olması gerekir.

shipyard detached deploy {application_build_uuid} --name my-detached-env

Depo başına dalları geçersiz kılın ve detached ortamın yeni commit'lerde yeniden derlenip derlenmeyeceğini belirleyin:

# Override the branch for a repo, and never rebuild on new commits
shipyard detached deploy {application_build_uuid} --name my-detached-env --branch web=feature-x --build-on-commit never

# Per-repo build-on-commit settings (always | inherit | never)
shipyard detached deploy {application_build_uuid} --build-on-commit-for web=always --build-on-commit-for api=never

Bağımsız bir ortamı silme

Ortam UUID'sini veya uygulama derlemelerinden herhangi birinin UUID'sini (derleme ayrıntıları sayfasının URL'sinde bulunanı) iletin. Bu yöntemle yalnızca detached ortamlar silinebilir; temel, pull request veya uzak ortamlar için işlem reddedilir. Zaten silinmiş bir ortamı silme işlemi yeniden başarılı olur.

shipyard detached delete {environment_uuid}
shipyard detached delete {application_build_uuid}

Bir ortamın tüm hizmetlerini ve açık portlarını listeleme

shipyard get services --env {environment_uuid}

Çalışan bir ortamın hizmetinde komut çalıştırma

Çalışan bir ortamın belirli bir hizmetinde, istediğiniz bağımsız değişken ve bayraklarla herhangi bir komutu çalıştırın. Komut bağımsız değişkenlerini çift eğik çizgiden sonra iletin. Oturum, yalnızca siz yazarken ortamın boşta olduğu için durdurulmasını önler; bu süre en fazla 12 saattir.

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

Çalışan bir ortamın hizmet portunu yönlendirme

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

Açık bir port-forward veya logs --follow, ortamın boşta olduğu için durdurulmasını en fazla 12 saat önler.

Çalışan bir ortamın hizmet günlüklerini alma

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

Bir ortamı ziyaret etme

shipyard visit {environment_uuid}

Kullanılabilir bayraklar:

AdAçıklamaTürVarsayılan değer
followGünlük çıktısını takip etbooleanfalse
tailGösterilecek son günlük satırı sayısıint3000

Birimlerle çalışma

Bir ortamdaki tüm birimleri listeleme

shipyard get volumes --env {environment_uuid}

Bir ortamdaki tüm birim anlık görüntülerini listeleme

shipyard get snapshots --env {environment_uuid}

Bir ortamdaki birimi sıfırlama

shipyard reset volume --env {environment_uuid}

Bir ortamda anlık görüntü oluşturma

shipyard create snapshot --env {environment_uuid}

Bir ortama birim anlık görüntüsü yükleme

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

Bir ortamdaki birime dosya yükleme

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

REST API'yi doğrudan çağırma

shipyard api /api/v1/environment
shipyard api -X PUT /api/v1/environment/{environment_uuid}/env-vars --input body.json

Yollar /api/v1 veya /api/v2 ile başlamalıdır; token'ınız ve kuruluşunuz sizin için eklenir. --include-secrets iletmediğiniz sürece bypass_token ve kubeconfig kimlik bilgileri gizlenir.

Telepresence'e bağlanma

shipyard telepresence connect --env {environment_uuid}

Buradan, ad alanındaki tüm pod'larla doğrudan iletişim kurabilirsiniz. Hizmetlerle iletişim kurmak için ad alanı ana bilgisayar adını kullanmanız gerekebilir; bu adı Namespace alanının altındaki telepresence status üzerinden alabilirsiniz. Örneğin, redis ile iletişim kurmak için redis.shipyard-app-build-{uuid} kullanırsınız.

Koddan çalıştırılabilir dosya oluşturma:

Aşağıdaki komutu çalıştırarak bir çalıştırılabilir dosya oluşturabilirsiniz:

make

Bu yeni çalıştırılabilir dosyayı çalıştırmak için:

./shipyard

Otomatik Tamamlamayı Etkinleştirme

Bash

Bu betik, bash-completion paketine bağlıdır. Paket henüz yüklü değilse işletim sisteminizin paket yöneticisi aracılığıyla yükleyebilirsiniz. Geçerli kabuk oturumunuzda tamamlamaları yüklemek için:

source <(shipyard completion bash)

Her yeni oturumda tamamlamaları yüklemek için aşağıdakini bir kez çalıştırın.

Linux'ta:

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

macOS'te:

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

Zsh

Ortamınızda kabuk tamamlama henüz etkin değilse bunu etkinleştirmeniz gerekir. Aşağıdakini bir kez çalıştırabilirsiniz:

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

Geçerli kabuk oturumunuzda tamamlamaları yüklemek için:

source <(shipyard completion zsh); compdef _shipyard shipyard

Her yeni oturumda tamamlamaları yüklemek için aşağıdakini bir kez çalıştırın.

Linux'ta:

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

macOS'te:

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

Bu kurulumun etkili olması için yeni bir kabuk başlatmanız gerekir.

Fish

Geçerli kabuk oturumunuzda tamamlamaları yüklemek için:

$ shipyard completion fish | source

Her oturumda tamamlamaları yüklemek için bir kez çalıştırın:

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

PowerShell

Geçerli kabuk oturumunuzda tamamlamaları yüklemek için:

shipyard completion powershell | Out-String | Invoke-Expression

Her yeni oturumda tamamlamaları yüklemek için şunu çalıştırın:

shipyard completion powershell > shipyard.ps1

ve bu dosyayı PowerShell profilinizden kaynak olarak yükleyin.

Shipyard'ı bir yapay zekâ asistanından kullanma (MCP)

shipyard mcp serve, bir Model Context Protocol sunucusu çalıştırır; böylece Claude Code, Claude Desktop, Cursor veya Codex gibi bir asistan ortamlarınızı listeleyebilir, inceleyebilir, yeniden oluşturabilir ve yapılandırabilir; hizmet günlüklerini okuyabilir, birimleri yönetebilir ve gönderilen bir değişikliği ortamında doğrulayabilir.

CLI'da oturum açtıktan sonra Claude Code'a ekleyin:

claude mcp add shipyard -- shipyard mcp serve

Ardından şunlar gibi sorular sorun:

  • "web deposu için hangi ortamlar çalışıyor?"
  • "Dalımın ortamındaki api hizmetinin günlüklerini göster."
  • "Bu ortamın en son derlemesi neden başarısız oldu?"
  • "Bu ortamda FEATURE_FLAGS=beta ayarını yap ve worker hizmetini yeniden başlat."
  • "Az önce gönderdim. Değişikliği ortamında doğrula." (veya /mcp__shipyard__verify)

Diğer istemcilerde kurulum, yapılandırma, tüm araç listesi, verify istemi ve sorun giderme hakkında bilgi için MCP kılavuzuna bakın.