Flow komutları

Flow’lar, Flow & Paywall Builder’da oluşturduğunuz paywall’lar ve onboarding’lerdir. CLI, flow kaydını, builder config’ini ve yayımlamayı yönetir. Builder config, Flow & Paywall Builder’ın normalde ürettiği büyük bir JSON belgesidir; CLI bunu kendisi oluşturmaz. Terminaldeki bir config’i yazmak veya düzenlemek için bu komutları sizin adınıza çalıştıran flow-generator skill’ini kullanın. Yayımlamadan önce flow-audit skill, flow’un üretime hazır olup olmadığını kontrol eder. Komutlar burada referans olarak listelenmiştir.

adapty flows list

Bir uygulamaya ait tüm flow’ları listeler.

adapty flows list --app <app-id>
FlagGerekliAçıklama
--appEvetUygulama ID’si (UUID)

Sayfalandırma flag’lerini kabul eder.

adapty flows get

Belirli bir flow için ayrıntıları alır.

adapty flows get --app <app-id> <flow-id>
ArgümanAçıklama
flow-idFlow ID (UUID)
BayrakZorunluAçıklama
--appEvetUygulama ID (UUID)

Yanıt id, name, status ve updated_at içerir. Status değerlerinden biri şunlardır:

DurumAnlam
draftFlow hiç yayınlanmadı
publishedMevcut sürüm yayında
dirtyFlow daha önce yayınlandı ve mevcut sürümde yayınlanmamış değişiklikler var. Kullanıcılar son yayınlanan sürümü görmeye devam eder
publishingYayınlama işlemi devam ediyor
publication_failedSon yayınlama başarısız oldu. Yapılandırmayı düzeltin ve tekrar yayınlayın
archivedFlow arşivlendi

adapty flows create

Bir flow oluşturur. Yeni flow’un bir adı vardır ancak yapılandırması yoktur. Yapılandırma eklemek için flows config update komutunu kullanın.

adapty flows create --app <app-id> --name "Onboarding"
FlagZorunluAçıklama
--appEvetUygulama ID’si (UUID)
--nameEvetFlow adı

adapty flows update

Bir flow’u yeniden adlandırır.

adapty flows update --app <app-id> <flow-id> --name "Onboarding v2"
ArgumentDescription
flow-idFlow ID (UUID)
FlagRequiredDescription
--appYesUygulama ID’si (UUID)
--nameYesYeni flow adı

adapty flows publish

Flow’un mevcut sürümünü kullanıcılarınıza yayınlayın.

adapty flows publish --app <app-id> <flow-id>
ArgümanAçıklama
flow-idFlow ID’si (UUID)
BayrakZorunluAçıklama
--appEvetUygulama ID’si (UUID)
--yes, -yHayırOnay sormadan yayınlayın. Çıktı yönlendirildiğinde veya --json kullanıldığında zorunludur

Değişiklikleri yayımlamak kullanıcılarınızın gördüğü içeriği etkilediğinden, komut flow adını ekrana yazdırır ve onay ister. y dışındaki her yanıt, komutu çıkış kodu 1 ile iptal eder. --json bayrağı kullanılırken veya bir pipe içinde çalıştırılırken komut, yanıt beklemek yerine çıkış kodu 2 ile reddeder; bu nedenle script’lerde ve agent oturumlarında --yes parametresini kullanın.

Yayımlama işlemi asenkrondur: yanıt status: publishing döner ve flow henüz yayında değildir. Durum published ya da publication_failed olana kadar flows get ile sorgulama yapın. publication_failed durumunda, flows config get nedenini raporlar.

Flow’un config’i yoksa, config yayımlanabilir değilse veya mevcut sürüm zaten yayındaysa yayımlama HTTP 400 hatasıyla başarısız olur. Yayımlamadan önce bir config’i kontrol etmek için flows config validate kullanın.

adapty flows config get

Bir flow’un builder config’ini okur.

adapty flows config get --app <app-id> <flow-id>
ArgümanAçıklama
flow-idFlow ID (UUID)
BayrakZorunluAçıklama
--appEvetUygulama ID (UUID)

Yanıt config, remote_configs, status ve updated_at alanlarını içerir. updated_at, son config değişikliğinin milisaniye cinsinden zaman damgasıdır. Eş zamanlı bir düzenlemenin üzerine yazmamak için bunu flows config update komutuna --expected-updated-at parametresi olarak geçirin. Config’i hiç yazılmamış bir flow için 404 döner.

Bir yayımlama girişiminin ardından yanıt, sürecin nasıl ilerlediğini açıklayan üç alan daha içerir. Bu alanları flows get komutu publication_failed döndürdüğünde okuyun:

AlanAçıklama
publication_statusBu flow sürümünün yayınlanma aşaması: transforming, transformed, uploading, uploaded, published veya failed
transform_errorHam dönüştürme hatası — sorunları listeleyen bir JSON yükü veya özet bir metin dizesi
publication_errorBaşarısız yayın için okunabilir bir mesaj

adapty flows config update

Bir flow’un builder config’ini yazar.

adapty flows config update --app <app-id> <flow-id> --config-file config.json
ArgumentDescription
flow-idFlow ID (UUID)
BayrakGerekliAçıklama
--appEvetUygulama ID’si (UUID)
--configİkisinden biriJSON dizesi olarak builder config
--config-fileİkisinden biriBuilder config içeren bir JSON dosyasının yolu veya stdin’den okumak için -
--remote-configsHayır{locale, data} girişlerinden oluşan JSON dizisi; data, remote config’i dize olarak içerir
--expected-updated-atHayırÖnceki bir flows config get komutundan alınan updated_at değeri. Config bu okumadan sonra değiştirildiyse, komut değişikliğin üzerine yazmak yerine başarısız olur. Koşulsuz olarak üzerine yazmak için bu bayrağı atlayın

Yapılandırmayı kaydetmek bir taslak oluşturur ve yayımlamaz. Yayımlanmış bir flow’da, yazma işlemi yeni bir sürüm oluşturur: flow’un durumu dirty olur ve siz flows publish komutunu çalıştırana kadar kullanıcılar yayımlanmış sürümü görmeye devam eder.

adapty flows config validate

Bir builder config’in kaydedilmeden yayınlanabilir olup olmadığını kontrol eder.

adapty flows config validate --app <app-id> <flow-id> --config-file config.json
ArgümanAçıklama
flow-idFlow ID’si (UUID)
FlagZorunluAçıklama
--appEvetUygulama ID’si (UUID)
--configİkisinden biriJSON string olarak builder config
--config-fileİkisinden biriBuilder config içeren JSON dosyasının yolu veya stdin’den okumak için -

valid yanıtı ve bir issues listesi içerir. Config yayınlanamaz durumda olduğunda, komut 1 koduyla çıkar; bu sayede scriptler bunu bir kontrol noktası olarak kullanabilir.

adapty flows config preview

Yerel bir config dosyasını tarayıcıda görüntüler. Bu komut herhangi bir API çağrısı yapmaz ve --app bayrağı almaz.

adapty flows config preview ./config.json --screen <screen-id> --device iphone-14 --orientation portrait
ArgümanAçıklama
config-fileYerel bir builder config JSON dosyasının yolu
BayrakVarsayılanAçıklama
--screenFlow’un ilk ekranıGörüntülenecek ekran ID’si
--deviceiphone-14Görüntüleneceği cihaz çerçevesi
--orientationportraitportrait veya landscape

Terminalde komut, önizlemeyi tarayıcınızda açar. Bir pipe’a yönlendirildiğinde veya --json ile kullanıldığında URL’yi yazdırır. URL’nin tamamı config’i içerdiğinden oldukça uzundur: yazdırmak yerine bir ekran görüntüsü aracına pipe edin. Yaklaşık 32 KB’ı aşan config’ler yavaş render edilir.

adapty flows media upload

Bir flow config’inde kullanmak üzere görsel yükleyin.

adapty flows media upload --app <app-id> ./hero.png
ArgümanAçıklama
fileGörsel dosyasının yolu
FlagZorunluAçıklama
--appEvetUygulama ID’si (UUID)

Kabul edilen formatlar: GIF, HEIC, JPEG, PNG, SVG ve WebP. Yanıt, config’den referans almak için görselin id, name ve CDN url bilgilerini içerir.

Sırada ne var

  • Komut referansı — tüm CLI konuları, genel bayraklar ve sayfalama bayrakları.