Not
Bu sayfaya erişim yetkilendirme gerektiriyor. Oturum açmayı veya dizinleri değiştirmeyi deneyebilirsiniz.
Bu sayfaya erişim yetkilendirme gerektiriyor. Dizinleri değiştirmeyi deneyebilirsiniz.
@microsoft/winappcli için TypeScript/JavaScript API’si başvurusu.
Her CLI komutu, stdout/stderr yakalayan ve yazılan bir sonuç döndüren bir zaman uyumsuz işlev olarak kullanılabilir.
MSIX kimliği, Elektron hata ayıklama kimliği ve derleme araçları için yardımcı yardımcı programlar da dışarı aktarılır.
Kurulum
npm install @microsoft/winappcli
Hızlı başlangıç
import { init, packageApp, certGenerate } from '@microsoft/winappcli';
// Initialize a new project with defaults
await init({ useDefaults: true });
// Generate a dev certificate
await certGenerate({ install: true });
// Package the built app
await packageApp({ inputFolder: './dist', cert: './devcert.pfx' });
Yaygın türler
Her bir CLI komut sarmalayıcısı, CommonOptions genişleten bir seçenekler nesnesini kabul eder ve Promise<WinappResult> döndürür.
CommonOptions
Çoğu komut tarafından paylaşılan temel seçenekler.
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
WinappResult
Her komut sarmalayıcısının döndürdüğü sonuç.
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
exitCode |
number |
Yes | İşlem çıkış kodu (her zaman başarıda 0 – sıfır olmayan atmalar). |
stdout |
string |
Yes | Kaydedilen standart çıkış. |
stderr |
string |
Yes | Kaydedilen standart hata. |
CLI komut sarmalayıcıları
Bu işlevler yerel winapp CLI komutlarını sarmalar. Tümü CommonOptions'ı (quiet, verbose, cwd) kabul eder.
certGenerate()
Yalnızca yerel test için otomatik olarak imzalanan bir sertifika oluşturun. Yayıncı, manifest ile eşleşmelidir (--manifest sağlandıysa veya Package.appxmanifest çalışma dizinindeyse otomatik olarak belirlenir). Çıkış: devcert.pfx (varsayılan parola: 'password'). Üretim için güvenilen bir CA'dan sertifika alın. Bu makineye güvenmek için 'cert install' komutunu kullanın.
function certGenerate(options?: CertGenerateOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
exportCer |
boolean \| undefined |
Hayır | pfx ile birlikte yalnızca ortak anahtar içeren .cer dosyasını dışa aktarma |
ifExists |
IfExists \| undefined |
Hayır | Çıkış dosyası mevcut olduğunda davranış: 'error' (fail, default), 'skip' (var olanı koru) veya 'overwrite' (değiştir) |
install |
boolean \| undefined |
Hayır | Sertifikayı oluşturma sonrasında yerel makine deposuna yükleme |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
manifest |
string \| undefined |
Hayır | Yayımcı bilgilerini ayıklamak için Package.appxmanifest veya appxmanifest.xml dosyasının yolu |
output |
string \| undefined |
Hayır | Oluşturulan PFX dosyasının çıkış yolu |
password |
string \| undefined |
Hayır | Oluşturulan PFX dosyasının parolası |
publisher |
string \| undefined |
Hayır | Oluşturulan sertifika için Yayıncı adı. Belirtilmezse manifestten anlaşılır. |
validDays |
number \| undefined |
Hayır | Sertifikanın geçerli olduğu gün sayısı |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
certInfo()
Sertifika ayrıntılarını (konu, parmak izi, süre sonu) görüntüleme. İmzalamadan önce bir sertifikanın bildiriminizle eşleştiğinden emin olmak için kullanışlıdır.
function certInfo(options: CertInfoOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
certPath |
string |
Yes | Sertifika dosyasının yolu (PFX) |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
password |
string \| undefined |
Hayır | PFX dosyasının parolası |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
certInstall()
Bu makinedeki bir sertifikaya güven (yönetici gerektirir). Geliştirme sertifikalarıyla imzalanan MSIX paketlerini yüklemeden önce komutu yürütün. Örnek: winapp cert install ./devcert.pfx. Sertifika başına yalnızca bir kez gereklidir.
function certInstall(options: CertInstallOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
certPath |
string |
Yes | Sertifika dosyasının yolu (PFX veya CER) |
force |
boolean \| undefined |
Hayır | Sertifika zaten mevcut olsa bile yüklemeyi zorlama |
password |
string \| undefined |
Hayır | PFX dosyasının parolası |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
createDebugIdentity()
Tam MSIX oluşturmadan hata ayıklama için paket kimliğini etkinleştirin. Geliştirme sırasında Windows API'lerini (anında iletme bildirimleri, hedef paylaşma vb.) test için gereklidir. Örnek: winapp create-debug-identity ./myapp.exe. Geçerli dizinde Package.appxmanifest veya appxmanifest.xml dosyasını bulundurmanızı ya da --manifest parametresi ile geçirmenizi gerektirir. Bildirimi veya Varlıkları/ değiştirdikten sonra yeniden çalıştırın.
function createDebugIdentity(options?: CreateDebugIdentityOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
entrypoint |
string \| undefined |
Hayır | Kimlik bilgileri veya giriş noktası betiğiyle çalıştırılması gereken .exe dosyasının yolu. |
keepIdentity |
boolean \| undefined |
Hayır | Manifeste paket kimliğini koruyun, paket adına ve uygulama kimliğine '.debug' eklemeden kalsın. |
manifest |
string \| undefined |
Hayır | Package.appxmanifest veya appxmanifest.xml yolu |
noInstall |
boolean \| undefined |
Hayır | Oluşturma işleminden sonra paketi yüklemeyin. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
createExternalCatalog()
Belirtilen dizinlerden yürütülebilir dosyaların karmalarını içeren bir CodeIntegrityExternal.cat katalog dosyası oluşturur. Pakete dahil olmayan dış dosyaların yürütülmesine izin vermek için MSIX seyrek paket bildirimlerinde (AllowExternalContent) TrustedLaunch bayrağıyla birlikte kullanılır.
function createExternalCatalog(options: CreateExternalCatalogOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
inputFolder |
string |
Yes | İşlenmek üzere yürütülebilir dosyaları olan giriş klasörlerinin listesi (noktalı virgülle ayrılmış) |
computeFlatHashes |
boolean \| undefined |
Hayır | Kataloğu oluştururken düz karmalar ekleyin |
ifExists |
IfExists \| undefined |
Hayır | Çıkış dosyası zaten mevcut olduğunda davranış |
output |
string \| undefined |
Hayır | Çıktı kataloğu dosya yolu. Belirtilmezse, varsayılan CodeIntegrityExternal.cat adı kullanılır. |
recursive |
boolean \| undefined |
Hayır | Alt dizinlerden dosya ekleme |
usePageHashes |
boolean \| undefined |
Hayır | Katalog oluştururken sayfa karmalarını ekleyin |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
getWinappPath()
.winapp dizinine giden yolu yazdırın. Paylaşılan önbellek konumu için --global kullanın veya project-local .winapp klasörü için atla. Yüklü paketlere referans vermesi gereken derleme betikleri için yararlı olur.
function getWinappPath(options?: GetWinappPathOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
global |
boolean \| undefined |
Hayır | Yerel yerine genel .winapp dizinini alma |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
init()
Gerekli kurulumla bir Windows uygulaması başlatmak için buradan başlayın. Windows uygulama geliştirme için gereken her şeyi ayarlar: varsayılan varlıklarla Package.appxmanifest oluşturur, Windows SDK ve Windows Uygulama SDK'sı paketlerini indirir ve projeksiyonlar oluşturur. SDK paketleri yönetildiğinde (--setup-sdks stable/preview/experimental), 'restore'/'update' sürümlerini sabitlemek için winapp.yaml dosyası da oluşturulur; --setup-sdks hiç [none] (örneğin, Rust/Tauri projeleri kendi SDK bağlamalarını getirdiğinde), winapp.yaml dosyası oluşturulmaz. Varsayılan olarak etkileşimlidir (istemleri atlamak için --use-defaults kullanın). Zaten winapp.yaml olan bir depoyu kopyaladıysanız bunun yerine 'restore' kullanın. Yalnızca bir bildirime ihtiyacınız varsa 'manifest generate' veya kod imzalama için geliştirme sertifikasına ihtiyacınız varsa 'cert generate' kullanın.
function init(options?: InitOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
baseDirectory |
string \| undefined |
Hayır | Tüketim veya yükleme için winapp çalışma alanının temel/kök dizini. |
configDir |
string \| undefined |
Hayır | Okuma/depolama yapılandırması dizini (varsayılan: geçerli dizin) |
configOnly |
boolean \| undefined |
Hayır | Yalnızca yapılandırma dosyası işlemlerini işleyin (eksikse oluşturun, varsa doğrulayın). Paket yükleme ve diğer çalışma alanı kurulum adımlarını atlayın. |
ignoreConfig |
boolean \| undefined |
Hayır | Sürüm yönetimi için yapılandırma dosyasını kullanma |
noGitignore |
boolean \| undefined |
Hayır | .gitignore dosyasını güncellemeyin |
setupSdks |
SdkInstallMode \| undefined |
Hayır | SDK yükleme modu: 'kararlı' (varsayılan), 'önizleme', 'deneysel' veya 'hiçbiri' (SDK yüklemesini atla) |
useDefaults |
boolean \| undefined |
Hayır | İstem göstermeyin ve tüm istemler için varsayılanı kullanın. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
manifestAddAlias()
Package.appxmanifest dosyasına bir yürütme diğer adı (uap5:AppExecutionAlias) ekleyin. Bu, diğer adı yazarak paketlenmiş uygulamanın komut satırından başlatılmasına olanak tanır. Varsayılan olarak, takma ad Yürütülebilir özniteliğinden çıkarılır (örneğin, $targetnametoken$.exe $targetnametoken$.exe olarak belirlenir).
function manifestAddAlias(options?: ManifestAddAliasOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
appId |
string \| undefined |
Hayır | Diğer adın ekleneceği Uygulama Kimliği (varsayılan: ilk Uygulama [Application] öğesi) |
manifest |
string \| undefined |
Hayır | Package.appxmanifest veya appxmanifest.xml dosyasının yolu (varsayılan: geçerli dizinde ara) |
name |
string \| undefined |
Hayır | Takma ad (örneğin 'myapp.exe'). Varsayılan: bildirimdeki Yürütülebilir özniteliğinden çıkarılır. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
manifestGenerate()
Tam proje kurulumu olmadan Package.appxmanifest oluşturun. Yalnızca bildirim ve görüntü varlıklarına (SDK yoksa, sertifika olmadan) ihtiyacınız olduğunda kullanın. Tam kurulum için bunun yerine 'init' kullanın. Şablonlar: 'packaged' (tam MSIX), 'sparse' (Windows API'leri gereken masaüstü uygulaması).
function manifestGenerate(options?: ManifestGenerateOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
directory |
string \| undefined |
Hayır | içinde bildirim oluşturulacak dizin |
description |
string \| undefined |
Hayır | Yükleme sırasında ve Windows Ayarları'nda gösterilen, okunabilir uygulama açıklaması |
executable |
string \| undefined |
Hayır | Uygulamanın yürütülebilir dosyasının yolu. Varsayılan: <paket adı>.exe |
ifExists |
IfExists \| undefined |
Hayır | Çıkış dosyası mevcut olduğunda davranış: 'error' (fail, default), 'skip' (var olanı koru) veya 'overwrite' (değiştir) |
logoPath |
string \| undefined |
Hayır | Logo resim dosyasının yolu |
packageName |
string \| undefined |
Hayır | Paket adı (varsayılan: klasör adı) |
publisherName |
string \| undefined |
Hayır | Publisher CN (varsayılan: CN=<geçerli kullanıcı>) |
template |
ManifestTemplates \| undefined |
Hayır | Bildirim şablonu türü: 'packaged' (tam MSIX uygulaması, varsayılan) veya 'sparse' (Windows API'ler için paket kimliğine sahip masaüstü uygulaması) |
version |
string \| undefined |
Hayır | Major.Minor.Build.Revision biçiminde uygulama sürümü (örneğin, 1.0.0.0). |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
manifestUpdateAssets()
Tek bir kaynak görüntüden Package.appxmanifest dosyasında başvuruda bulunan görüntüler için yeni varlıklar oluşturun. Kaynak görüntü en az 400x400 piksel olmalıdır.
function manifestUpdateAssets(options: ManifestUpdateAssetsOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
imagePath |
string |
Yes | Kaynak görüntü dosyasının yolu (SVG, PNG, ICO, JPG, BMP, GIF) |
lightImage |
string \| undefined |
Hayır | Açık tema varyantları için kaynak görüntü yolu (SVG, PNG, ICO, JPG, BMP, GIF) |
manifest |
string \| undefined |
Hayır | Package.appxmanifest veya appxmanifest.xml dosyasının yolu (varsayılan: geçerli dizinde ara) |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
packageApp()
Yerleşik uygulamanızdan MSIX yükleyicisi oluşturun. Uygulamanızı derledikten sonra çalıştırın. Paketleme için bir bildirim (Package.appxmanifest veya appxmanifest.xml) gereklidir; geçerli çalışma dizininde olmalıdır, --manifest olarak geçirilmelidir veya giriş klasöründe olmalıdır. Test için imzalamak için --cert devcert.pfx kullanın. Örnek: winapp package ./dist --manifest Package.appxmanifest --cert ./devcert.pfx
function packageApp(options: PackageOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
inputFolder |
string |
Yes | Paket düzenine sahip giriş klasörü |
cert |
string \| undefined |
Hayır | İmzalama sertifikası yolu (sağlanırsa otomatik olarak imzalanır) |
certPassword |
string \| undefined |
Hayır | Sertifika parolası (varsayılan: parola) |
executable |
string \| undefined |
Hayır | Giriş klasörüne göre yürütülebilir dosyanın yolu. |
generateCert |
boolean \| undefined |
Hayır | Yeni bir geliştirme sertifikası oluşturma |
installCert |
boolean \| undefined |
Hayır | Makineye sertifika yükleme |
manifest |
string \| undefined |
Hayır | AppX manifesto dosyasının yolu (varsayılan: giriş klasöründen veya geçerli dizinden otomatik olarak algılanır) |
name |
string \| undefined |
Hayır | Paket adı (varsayılan: manifestodan) |
output |
string \| undefined |
Hayır | Oluşturulan paket için çıkış msix dosya adı (varsayılan olarak <name><version><arch>.msix, ancak version/arch belirlenemediğinde sırasıyla <name><version>.msix, <name><arch>.msix veya <name>.msix olarak geri döner) |
publisher |
string \| undefined |
Hayır | Sertifika oluşturma için Publisher adı |
selfContained |
boolean \| undefined |
Hayır | Bağımsız dağıtım için Windows Uygulama SDK'sı çalışma zamanını paketleme |
skipPri |
boolean \| undefined |
Hayır | PRI dosya oluşturmayı atlama |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
restore()
Depo kopyaladıktan sonra veya .winapp/ klasörü eksik olduğunda kullanın. Sürümleri değiştirmeden mevcut winapp.yaml dosyasından SDK paketlerini yeniden yükler. winapp.yaml gerektirir ('init' tarafından oluşturulur). Daha yeni SDK sürümlerini denetlemek için bunun yerine 'update' kullanın.
function restore(options?: RestoreOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
baseDirectory |
string \| undefined |
Hayır | Winapp çalışma alanı için temel/kök dizin |
configDir |
string \| undefined |
Hayır | Yapılandırmanın okunacağı dizin (varsayılan: geçerli dizin) |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
run()
Paketlenmiş düzen oluşturur, Uygulamayı kaydeder ve paketlenmiş uygulamayı başlatır.
function run(options: RunOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
inputFolder |
string |
Yes | Çalıştırılacak uygulamayı içeren giriş klasörü |
args |
string \| undefined |
Hayır | Uygulamaya geçirmek için komut satırı argümanları |
clean |
boolean \| undefined |
Hayır | Yeniden dağıtmadan önce mevcut paketin uygulama verilerini (LocalState, ayarlar vb.) kaldırın. Varsayılan olarak, uygulama verileri yeniden dağıtımlarda korunur. |
debugOutput |
boolean \| undefined |
Hayır | Başlatılan uygulamadan OutputDebugString iletilerini ve ilk şans özel durumlarını yakalayın. Aynı anda bir işleme yalnızca bir hata ayıklayıcısı eklenebilir, bu nedenle diğer hata ayıklayıcılar (Visual Studio, VS Code) aynı anda kullanılamaz. Farklı bir hata ayıklayıcı eklemeniz gerekiyorsa bunun yerine --no-launch kullanın. --no-launch veya --json ile birleştirilemez. |
detach |
boolean \| undefined |
Hayır | Uygulamayı başlatın ve çıkışını beklemeden hemen geri dönün. Başlatma sonrasında uygulamayla etkileşim kurmanız gereken CI/otomasyon için kullanışlıdır. PID'yi stdout'a (veya --json ile JSON'da) yazdırır. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
manifest |
string \| undefined |
Hayır | Package.appxmanifest dosyasının yolu (varsayılan: giriş klasöründen veya mevcut dizinden otomatik algılama) |
noLaunch |
boolean \| undefined |
Hayır | Uygulamayı başlatmadan yalnızca hata ayıklama kimliğini oluşturun ve paketi kaydedin |
outputAppxDirectory |
string \| undefined |
Hayır | Gevşek düzen paketi için çıkış dizini. Belirtilmezse, input-folder dizininin içindeki AppX adlı bir dizin kullanılır. |
symbols |
boolean \| undefined |
Hayır | Daha zengin yerel kilitlenme analizi için sembolleri Microsoft Sembol Sunucusu'ndan indirin. Yalnızca --debug-output ile kullanılır. İlk çalıştırma simgeleri indirir ve yerel olarak önbelleğe alır; sonraki çalıştırmalarda önbellek kullanılır. |
unregisterOnExit |
boolean \| undefined |
Hayır | Uygulama çıktıktan sonra geliştirme paketinin kaydını kaldırın. Yalnızca geliştirme modunda kayıtlı paketleri kaldırır. |
withAlias |
boolean \| undefined |
Hayır | Uygulamayı AUMID etkinleştirmesi yerine çalışma diğer adını kullanarak başlatın. Uygulama geçerli terminalde devralınan stdin/stdout/stderr ile çalışır. Manifest dosyasında bir uap5:ExecutionAlias gerektirir. Bildirime bir çalıştırma takma adı eklemek için "winapp manifest add-alias" komutunu kullanın. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
sign()
MSIX paketini veya yürütülebilir dosyayı kodla imzalayın. Örnek: winapp sign ./app.msix ./devcert.pfx. Sertifikanın süresi dolduktan sonra üretim derlemelerinin geçerli kalması için --timestamp kullanın. 'package' komutu --cert ile otomatik olarak imzalayabilir.
function sign(options: SignOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
filePath |
string |
Yes | İmzalayacak dosyanın/paketin yolu |
certPath |
string |
Yes | Sertifika dosyasının yolu (PFX biçimi) |
password |
string \| undefined |
Hayır | Sertifika parolası |
timestamp |
string \| undefined |
Hayır | Zaman damgası sunucusu URL'si |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
store()
Bir Microsoft Store Geliştirici CLI komutu çalıştırın. Bu komut, henüz indirilmemişse Microsoft Store Geliştirici CLI'sini indirir. Microsoft Store Geliştirici CLI'sı hakkında daha fazla bilgi için buraya bakın: https://aka.ms/msstoredevcli
function store(options?: StoreOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
storeArgs |
string[] \| undefined |
Hayır | Microsoft Store Geliştirici CLI'sına geçirilecek bağımsız değişkenler. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
tool()
Windows SDK araçlarını doğrudan çalıştırın (makeappx, signtool, makepri vb.). Gerekirse Derleme Araçları'nı otomatik olarak indirir. Çoğu görev için 'package' veya 'sign' gibi üst düzey komutları tercih edin. Örnek: winapp tool makeappx pack /d ./folder /p ./out.msix
function tool(options?: ToolOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
toolArgs |
string[] \| undefined |
Hayır | SDK aracına iletilecek bağımsız değişkenler; örneğin ['makeappx', 'pack', '/d', './folder', '/p', './out.msix']. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiClick()
Fare simülasyonu kullanarak bir öğeye slug veya metin araması ile tıklayın. InvokePattern'ı desteklemeyen öğeler üzerinde çalışır (örneğin, sütun başlıkları, liste öğeleri). Çift tıklama için --double, sağ tıklama için --right kullanın.
function uiClick(options?: UiClickOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad/automationId ile aranacak anlamsal bilgi (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
double |
boolean \| undefined |
Hayır | Tek tıklama yerine çift tıklama gerçekleştirme |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
right |
boolean \| undefined |
Hayır | Sol tıklama yerine sağ tıklama gerçekleştirme |
window |
number \| undefined |
Hayır | HWND'yi kullanarak hedef pencere (liste çıktısından gelen kararlı bir tanıtıcı ile). --app üzerinde önceliklidir. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiFocus()
UIA SetFocus kullanarak klavye odağını belirtilen öğeye taşıyın.
function uiFocus(options?: UiFocusOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND yoluyla hedef pencere (listeden kararlı tanıtıcı). --app üzerinde üstünlüğü vardır. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiGetFocused()
Hedef uygulamada klavye odağı olan öğeyi gösterin.
function uiGetFocused(options?: UiGetFocusedOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiGetProperty()
Bir öğeden UIA özellik değerlerini okuyun. Tek bir özellik için --property değerini belirtin veya tümü için atla seçeneğini belirleyin.
function uiGetProperty(options?: UiGetPropertyOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
property |
string \| undefined |
Hayır | Okunacak veya filtrelenecek özellik adı |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiGetValue()
Bir öğeden geçerli değeri okuyun. TextPattern (RichEditBox, Document), ValuePattern (TextBox, ComboBox, Slider) ve name (etiketler) değerlerini dener. Kullanım: winapp ui get-value <seçici> -a <uygulaması>
function uiGetValue(options?: UiGetValueOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiInspect()
Anlamsal bilgi kümeleri, öğe türleri, adlar ve sınırlar içeren UI öğe ağacını görüntüleyin.
function uiInspect(options?: UiInspectOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
ancestors |
boolean \| undefined |
Hayır | Ağaçta belirtilen öğeden köke kadar yukarı çıkın |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
depth |
number \| undefined |
Hayır | Ağaç inceleme derinliği |
hideDisabled |
boolean \| undefined |
Hayır | Devre dışı bırakılan öğeleri çıkıştan gizleme |
hideOffscreen |
boolean \| undefined |
Hayır | Ekran dışı öğeleri çıkıştan gizleme |
interactive |
boolean \| undefined |
Hayır | Yalnızca etkileşimli/çağrılabilen öğeleri (düğmeler, bağlantılar, girişler, liste öğeleri) gösterir. Varsayılan derinliği 8'e artırır. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiInvoke()
Bir öğeyi slug veya metin araması yaparak etkinleştirin. InvokePattern, TogglePattern, SelectionItemPattern ve ExpandCollapsePattern'ı sırayla dener.
function uiInvoke(options?: UiInvokeOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiListWindows()
Tüm görünür pencereleri HWND, başlık, işlem ve boyutlarıyla listeleyin. Uygulama adına göre filtrelemek için -a kullanın. Belirli bir pencereyi hedeflemek için -w ile HWND kullanın.
function uiListWindows(options?: UiListWindowsOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiScreenshot()
Hedef pencereyi veya öğeyi PNG görüntüsü olarak yakalayın. Birden çok pencere (örneğin, iletişim kutuları) varsa, her bir pencereyi ayrı bir dosyaya yakalar. --json ile dosya yolunu ve boyutlarını döndürür. Açılır pencere katmanları için --capture-screen kullanın.
function uiScreenshot(options?: UiScreenshotOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyon kimliği (automationId) ile aranacak anlamsal etiket (örneğin, btn-minimize-d1a0) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
captureScreen |
boolean \| undefined |
Hayır | Pencere işleme yerine ekran yakalama (açılır pencereler/bindirmeler dahil). Önce pencereyi ön plana getirir. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
output |
string \| undefined |
Hayır | Çıktıyı dosya yoluna kaydetme (örn. ekran görüntüsü) |
window |
number \| undefined |
Hayır | HWND tarafından hedef pencere (liste çıktısından kararlı tanıtıcı). --app'den önceliklidir. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiScroll()
ScrollPattern kullanarak bir kapsayıcı öğesini kaydırma. Artımlı olarak kaydırmak için --direction veya üste/alta atlamak için --to kullanın.
function uiScroll(options?: UiScrollOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya automationId ile aranan anlamsal slug (örneğin btn-minimize-d1a0) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
direction |
string \| undefined |
Hayır | Kaydırma yönü: yukarı, aşağı, sol, sağ |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
to |
string \| undefined |
Hayır | Görünüm kaydırma: üst, alt |
window |
number \| undefined |
Hayır | HWND'e göre hedef pencere (liste çıktısından kararlı tutamak). --app'den önceliklidir. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiScrollIntoView()
UIA ScrollItemPattern kullanarak belirtilen öğeyi görünür alana kaydırın.
function uiScrollIntoView(options?: UiScrollIntoViewOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad/automationId ile aranacak anlamsal bilgi (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND ile hedef pencere (liste çıktısından kararlı tutucu). --app'den önceliklidir. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiSearch()
Öğe ağacında metin sorgusuyla eşleşen öğeleri arayın. Semantik sümüklü böceklerle yapılan tüm eşleşmeleri döndürür.
function uiSearch(options?: UiSearchOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad/automationId ile aranacak anlamsal bilgi (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
max |
number \| undefined |
Hayır | Arama sonuçları üst sınırı |
window |
number \| undefined |
Hayır | HWND tarafından hedef pencere (liste çıktısından sabit tanıtıcı). --app'in üzerinde önceliklidir. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiSetValue()
UIA ValuePattern kullanarak bir öğede bir değer ayarlayın. TextBox, ComboBox, Slider ve diğer düzenlenebilir denetimler için çalışır. Kullanım: winapp ui set-value <selector><değer> -a <uygulama>
function uiSetValue(options?: UiSetValueOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya automationId ile aranacak anlamsal terim (btn-minimize-d1a0 gibi) veya metin |
value |
string \| undefined |
Hayır | Ayarlanacağı değer (TextBox/ComboBox metni, Kaydırıcı için sayı) |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND ile hedef pencere (liste çıktısındaki sabit tanıtıcı). --app'den önceliklidir. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiStatus()
Hedef uygulamaya bağlanın ve bağlantı bilgilerini görüntüleyin.
function uiStatus(options?: UiStatusOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND ile hedef pencere (liste çıktısından sabit tanıtıcı). Bu seçenek --app'den önceliklidir. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
uiWaitFor()
Bir öğenin görünmesini, kaybolmasını veya bir özelliğin hedef değere ulaşmasını bekleyin. 100ms aralıklarla koşul karşılanıncaya veya zaman aşımı meydana gelene kadar sorgular.
function uiWaitFor(options?: UiWaitForOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Anlamlı slug (örneğin, btn-minimize-d1a0) veya ad/automationId ile aramak için metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
contains |
boolean \| undefined |
Hayır | Tam eşleşme yerine --value için alt dize eşleştirmesi kullanın |
gone |
boolean \| undefined |
Hayır | Öğenin görünmesi yerine kaybolmasını bekleyin |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
property |
string \| undefined |
Hayır | Okunacak veya filtrelenecek özellik adı |
timeout |
number \| undefined |
Hayır | Milisaniye cinsinden zaman aşımı |
value |
string \| undefined |
Hayır | Öğe değerinin bu dizeye eşit olmasını bekleyin. Akıllı geri dönüş kullanır (TextPattern -> ValuePattern -> Adı). Bunun yerine belirli bir özelliği denetlemek için --property ile birleştirin. |
window |
number \| undefined |
Hayır | HWND ile hedef pencere (liste çıktısındaki kararlı tanıtıcıdan). --app'den önceliklidir. |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
unregister()
Dışarıdan yüklenen bir geliştirme paketinin kaydını kaldırır. Yalnızca geliştirme modunda kayıtlı paketleri kaldırır (örneğin, 'winapp run' veya 'create-debug-identity' aracılığıyla).
function unregister(options?: UnregisterOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
force |
boolean \| undefined |
Hayır | Yükleme konumu dizin denetimini atlayın ve paket farklı bir proje ağacından kaydedilmiş olsa bile kaydını kaldırın |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
manifest |
string \| undefined |
Hayır | Package.appxmanifest yolunun (varsayılan: mevcut dizinden otomatik olarak algılanması) |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
update()
Daha yeni SDK sürümlerini denetleyin ve yükleyin. winapp.yaml dosyasını en son sürümlerle güncelleştirir ve paketleri yeniden yükler. Mevcut winapp.yaml gerektirir ('init' tarafından oluşturulur). SDK'ları önizlemek için --setup-sdks önizlemesini kullanın. Güncel sürümleri güncelleştirmeden yeniden yüklemek için bunun yerine 'restore' kullanın.
function update(options?: UpdateOptions): Promise<WinappResult>
Seçenekler:
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
setupSdks |
SdkInstallMode \| undefined |
Hayır | SDK yükleme modu: 'kararlı' (varsayılan), 'önizleme', 'deneysel' veya 'hiçbiri' (SDK yüklemesini atla) |
Ayrıca CommonOptions'ı (quiet, verbose, cwd) kabul eder.
Yardımcı program işlevleri
execWithBuildTools()
PATH ortamına BuildTools bin dizini ekleyerek bir komutu yürütme
function execWithBuildTools(command: string, options?: ExecSyncOptions): string | Buffer<ArrayBufferLike>
Parametreler:
| Parametre | Türü | Zorunlu | Description |
|---|---|---|---|
command |
string |
Yes | Yürütülecek komut |
options |
ExecSyncOptions |
Hayır | execSync'e geçirme seçenekleri (isteğe bağlı) |
Döndürür: execSync fonksiyonunun çıktısı
addMsixIdentityToExe()
bir appxmanifest.xml dosyasından yürütülebilir dosyanın gömülü bildirimi için paket kimliği bilgileri ekler
function addMsixIdentityToExe(exePath: string, appxManifestPath?: string | undefined, options?: MsixIdentityOptions): Promise<MsixIdentityResult>
Parametreler:
| Parametre | Türü | Zorunlu | Description |
|---|---|---|---|
exePath |
string |
Yes | Yürütülebilir dosyanın yolu |
appxManifestPath |
string \| undefined |
Hayır | Paket kimliği verilerini içeren appxmanifest.xml dosyasının yolu |
options |
MsixIdentityOptions |
Hayır | İsteğe bağlı yapılandırma |
addElectronDebugIdentity()
Elektron hata ayıklama işlemine paket kimliği ekler
function addElectronDebugIdentity(options?: MsixIdentityOptions): Promise<ElectronDebugIdentityResult>
Parametreler:
| Parametre | Türü | Zorunlu | Description |
|---|---|---|---|
options |
MsixIdentityOptions |
Hayır | Yapılandırma seçenekleri |
clearElectronDebugIdentity()
Elektron hata ayıklama sürecinden paket kimlik bilgilerini yedekten geri yükleyerek temizler/kaldırır.
function clearElectronDebugIdentity(options?: MsixIdentityOptions): Promise<ClearElectronDebugIdentityResult>
Parametreler:
| Parametre | Türü | Zorunlu | Description |
|---|---|---|---|
options |
MsixIdentityOptions |
Hayır | Yapılandırma seçenekleri |
getGlobalWinappPath()
Küresel .winapp dizin yolunu al
function getGlobalWinappPath(): string
Döndürür: Genel .winapp dizininin tam yolu
getLocalWinappPath()
Yerel .winapp dizinine giden yolu bulma
function getLocalWinappPath(): string
Döndürür: Yerel .winapp dizininin tam yolu
Node.js CLI komutları
Bu komutlar yalnızca aracılığıyla npx winapp node <subcommand> kullanılabilir ve programlı işlevler olarak dışarı aktarılmaz.
node create-addon
Bir Electron projesi için yerel eklenti dosyaları oluşturma. C++ (node-gyp) ve C# (node-api-dotnet) şablonlarını destekler.
npx winapp node create-addon [options]
Seçenekler:
| Flag | Description |
|---|---|
--name <name> |
Eklenti adı (varsayılan olarak şablona bağlıdır) |
--template <type> |
Addon şablonu: cpp veya cs (varsayılan: cpp) |
--verbose |
Ayrıntılı çıktıyı etkinleştir |
Not:
package.jsoniçeren bir dizin olan bir Electron projesinin kök dizininden çalıştırılmalıdır.
Örnekler:
npx winapp node create-addon
npx winapp node create-addon --name myAddon
npx winapp node create-addon --template cs --name MyCsAddon
node add-electron-debug-identity
Seyrek paketleme kullanarak Elektron hata ayıklama işlemine paket kimliği ekleyin. öğesinin yedeğini electron.exeoluşturur, seyrek bir MSIX bildirimi oluşturur, yürütülebilir dosyaya kimlik ekler ve seyrek paketi kaydeder.
Package.appxmanifest gerektirmektedir (veya winapp init ile winapp manifest generate bir tane oluşturun).
npx winapp node add-electron-debug-identity [options]
Seçenekler:
| Flag | Description |
|---|---|
--manifest <path> |
Özel Package.appxmanifest için yol (varsayılan: geçerli dizinde Package.appxmanifest) |
--no-install |
Oluşturma işleminden sonra paketi yüklemeyin |
--keep-identity |
Manifest kimliğini olduğu gibi tutun, sonuna .debug eklemeyin |
--verbose |
Ayrıntılı çıktıyı etkinleştir |
Not: Bir Electron projesinin kökünden,
node_modules/electroniçeren dizinden çalıştırılmalıdır. Geri almak için kullanınnpx winapp node clear-electron-debug-identity.
Örnekler:
npx winapp node add-electron-debug-identity
npx winapp node add-electron-debug-identity --manifest ./custom/Package.appxmanifest
node clear-electron-debug-identity
Elektron hata ayıklama işleminden paket kimliğini kaldırın.
electron.exe tarafından add-electron-debug-identity oluşturulan yedeklemeden geri yükler ve yedekleme dosyalarını kaldırır.
npx winapp node clear-electron-debug-identity [options]
Seçenekler:
| Flag | Description |
|---|---|
--verbose |
Ayrıntılı çıktıyı etkinleştir |
Not: Bir Electron projesinin,
node_modules/electronbileşenini içeren kök dizininden çalıştırılmalıdır.
Örnekler:
npx winapp node clear-electron-debug-identity
Türler Referansı
ExecSyncOptions
Kolaylık sağlamak için Node.js'dan yeniden dışarı aktarıldı. Bkz. Node.js belgeleri.
MsixIdentityOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
verbose |
boolean \| undefined |
Hayır | |
noInstall |
boolean \| undefined |
Hayır | |
keepIdentity |
boolean \| undefined |
Hayır | |
manifest |
string \| undefined |
Hayır |
MsixIdentityResult
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
success |
boolean |
Yes |
ElectronDebugIdentityResult
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
success |
boolean |
Yes | |
electronExePath |
string |
Yes | |
backupPath |
string |
Yes | |
manifestPath |
string |
Yes | |
assetsDir |
string |
Yes |
ClearElectronDebugIdentityResult
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
success |
boolean |
Yes | |
electronExePath |
string |
Yes | |
restoredFromBackup |
boolean |
Yes |
CallWinappCliOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
exitOnError |
boolean \| undefined |
Hayır |
CallWinappCliResult
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
exitCode |
number |
Yes |
CallWinappCliCaptureOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()) |
CallWinappCliCaptureResult
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
exitCode |
number |
Yes | |
stdout |
string |
Yes | |
stderr |
string |
Yes |
GenerateCppAddonOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
name |
string \| undefined |
Hayır | |
projectRoot |
string \| undefined |
Hayır | |
verbose |
boolean \| undefined |
Hayır |
GenerateCppAddonResult
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
success |
boolean |
Yes | |
addonName |
string |
Yes | |
addonPath |
string |
Yes | |
needsTerminalRestart |
boolean |
Yes | |
files |
string[] |
Yes |
GenerateCsAddonOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
name |
string \| undefined |
Hayır | |
projectRoot |
string \| undefined |
Hayır | |
verbose |
boolean \| undefined |
Hayır |
GenerateCsAddonResult
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
success |
boolean |
Yes | |
addonName |
string |
Yes | |
addonPath |
string |
Yes | |
needsTerminalRestart |
boolean |
Yes | |
files |
string[] |
Yes |
IfExists
IfExists değerleri.
type IfExists = "error" | "overwrite" | "skip"
SdkInstallMode
SdkInstallMode değerleri.
type SdkInstallMode = "stable" | "preview" | "experimental" | "none"
ManifestTemplates
ManifestTemplates değerleri.
type ManifestTemplates = "packaged" | "sparse"
CertGenerateOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
exportCer |
boolean \| undefined |
Hayır | .cer dosyasını (sadece ortak anahtar) .pfx ile birlikte dışarı aktarma |
ifExists |
IfExists \| undefined |
Hayır | Çıkış dosyası mevcut olduğunda davranış: 'error' (fail, default), 'skip' (var olanı koru) veya 'overwrite' (değiştir) |
install |
boolean \| undefined |
Hayır | Sertifikayı oluşturma sonrasında yerel makine deposuna yükleme |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
manifest |
string \| undefined |
Hayır | Yayımcı bilgilerini ayıklamak için Package.appxmanifest veya appxmanifest.xml dosyasının yolu |
output |
string \| undefined |
Hayır | Oluşturulan PFX dosyasının çıkış yolu |
password |
string \| undefined |
Hayır | Oluşturulan PFX dosyasının parolası |
publisher |
string \| undefined |
Hayır | Oluşturulan sertifika için Yayımlayıcı adı. Belirtilmezse manifestodan elde edilir. |
validDays |
number \| undefined |
Hayır | Sertifikanın geçerli olduğu gün sayısı |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
CertInfoOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
certPath |
string |
Yes | Sertifika dosyasının yolu (PFX) |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
password |
string \| undefined |
Hayır | PFX dosyasının parolası |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
CertInstallOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
certPath |
string |
Yes | Sertifika dosyasının yolu (PFX veya CER) |
force |
boolean \| undefined |
Hayır | Sertifika zaten mevcut olsa bile yüklemeyi zorlama |
password |
string \| undefined |
Hayır | PFX dosyasının parolası |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
CreateDebugIdentityOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
entrypoint |
string \| undefined |
Hayır | Kimlik bilgileri veya giriş noktası betiğiyle çalıştırılması gereken .exe dosyasının yolu. |
keepIdentity |
boolean \| undefined |
Hayır | Manifeste paket kimliğini koruyun, paket adına ve uygulama kimliğine '.debug' eklemeden kalsın. |
manifest |
string \| undefined |
Hayır | Package.appxmanifest veya appxmanifest.xml yolu |
noInstall |
boolean \| undefined |
Hayır | Oluşturma işleminden sonra paketi yüklemeyin. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
CreateExternalCatalogOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
inputFolder |
string |
Yes | İşlenmek üzere yürütülebilir dosyaları olan giriş klasörlerinin listesi (noktalı virgülle ayrılmış) |
computeFlatHashes |
boolean \| undefined |
Hayır | Kataloğu oluştururken düz karmalar ekleyin |
ifExists |
IfExists \| undefined |
Hayır | Çıkış dosyası zaten mevcut olduğunda davranış |
output |
string \| undefined |
Hayır | Çıktı kataloğu dosya yolu. Belirtilmezse, varsayılan CodeIntegrityExternal.cat adı kullanılır. |
recursive |
boolean \| undefined |
Hayır | Alt dizinlerden dosya ekleme |
usePageHashes |
boolean \| undefined |
Hayır | Katalog oluştururken sayfa karmalarını ekleyin |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
GetWinappPathOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
global |
boolean \| undefined |
Hayır | Yerel yerine genel .winapp dizinini alma |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
InitOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
baseDirectory |
string \| undefined |
Hayır | Tüketim veya yükleme için winapp çalışma alanının temel/kök dizini. |
configDir |
string \| undefined |
Hayır | Okuma/depolama yapılandırması dizini (varsayılan: geçerli dizin) |
configOnly |
boolean \| undefined |
Hayır | Yalnızca yapılandırma dosyası işlemlerini işleyin (eksikse oluşturun, varsa doğrulayın). Paket yükleme ve diğer çalışma alanı kurulum adımlarını atlayın. |
ignoreConfig |
boolean \| undefined |
Hayır | Sürüm yönetimi için yapılandırma dosyasını kullanma |
noGitignore |
boolean \| undefined |
Hayır | .gitignore dosyasını güncellemeyin |
setupSdks |
SdkInstallMode \| undefined |
Hayır | SDK yükleme modu: 'kararlı' (varsayılan), 'önizleme', 'deneysel' veya 'hiçbiri' (SDK yüklemesini atla) |
useDefaults |
boolean \| undefined |
Hayır | İstem göstermeyin ve tüm istemler için varsayılanı kullanın. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
ManifestAddAliasOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
appId |
string \| undefined |
Hayır | Diğer adın ekleneceği Uygulama Kimliği (varsayılan: ilk Uygulama [Application] öğesi) |
manifest |
string \| undefined |
Hayır | Package.appxmanifest veya appxmanifest.xml dosyasının yolu (varsayılan: geçerli dizinde ara) |
name |
string \| undefined |
Hayır | Takma ad (örneğin 'myapp.exe'). Varsayılan: bildirimdeki Yürütülebilir özniteliğinden çıkarılır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
ManifestGenerateOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
directory |
string \| undefined |
Hayır | içinde bildirim oluşturulacak dizin |
description |
string \| undefined |
Hayır | Yükleme sırasında ve Windows Ayarları'nda gösterilen, okunabilir uygulama açıklaması |
executable |
string \| undefined |
Hayır | Uygulamanın yürütülebilir dosyasının yolu. Varsayılan: <paket adı>.exe |
ifExists |
IfExists \| undefined |
Hayır | Çıkış dosyası mevcut olduğunda davranış: 'error' (fail, default), 'skip' (var olanı koru) veya 'overwrite' (değiştir) |
logoPath |
string \| undefined |
Hayır | Logo resim dosyasının yolu |
packageName |
string \| undefined |
Hayır | Paket adı (varsayılan: klasör adı) |
publisherName |
string \| undefined |
Hayır | Publisher CN (varsayılan: CN=<geçerli kullanıcı>) |
template |
ManifestTemplates \| undefined |
Hayır | Bildirim şablonu türü: 'packaged' (tam MSIX uygulaması, varsayılan) veya 'sparse' (Windows API'ler için paket kimliğine sahip masaüstü uygulaması) |
version |
string \| undefined |
Hayır | Major.Minor.Build.Revision biçiminde uygulama sürümü (örneğin, 1.0.0.0). |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
ManifestUpdateAssetsOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
imagePath |
string |
Yes | Kaynak görüntü dosyasının yolu (SVG, PNG, ICO, JPG, BMP, GIF) |
lightImage |
string \| undefined |
Hayır | Açık tema varyantları için kaynak görüntü yolu (SVG, PNG, ICO, JPG, BMP, GIF) |
manifest |
string \| undefined |
Hayır | Package.appxmanifest veya appxmanifest.xml dosyasının yolu (varsayılan: geçerli dizinde ara) |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
PackageOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
inputFolder |
string |
Yes | Paket düzenine sahip giriş klasörü |
cert |
string \| undefined |
Hayır | İmzalama sertifikası yolu (sağlanırsa otomatik olarak imzalanır) |
certPassword |
string \| undefined |
Hayır | Sertifika parolası (varsayılan: parola) |
executable |
string \| undefined |
Hayır | Giriş klasörüne göre yürütülebilir dosyanın yolu. |
generateCert |
boolean \| undefined |
Hayır | Yeni bir geliştirme sertifikası oluşturma |
installCert |
boolean \| undefined |
Hayır | Makineye sertifika yükleme |
manifest |
string \| undefined |
Hayır | AppX manifesto dosyasının yolu (varsayılan: giriş klasöründen veya geçerli dizinden otomatik olarak algılanır) |
name |
string \| undefined |
Hayır | Paket adı (varsayılan: manifestodan) |
output |
string \| undefined |
Hayır | Oluşturulan paket için çıkış msix dosya adı (varsayılan olarak <name><version><arch>.msix, ancak version/arch belirlenemediğinde sırasıyla <name><version>.msix, <name><arch>.msix veya <name>.msix olarak geri döner) |
publisher |
string \| undefined |
Hayır | Sertifika oluşturma için Publisher adı |
selfContained |
boolean \| undefined |
Hayır | Bağımsız dağıtım için Windows Uygulama SDK'sı çalışma zamanını paketleme |
skipPri |
boolean \| undefined |
Hayır | PRI dosya oluşturmayı atlama |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
RestoreOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
baseDirectory |
string \| undefined |
Hayır | Winapp çalışma alanı için temel/kök dizin |
configDir |
string \| undefined |
Hayır | Yapılandırmanın okunacağı dizin (varsayılan: geçerli dizin) |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
RunOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
inputFolder |
string |
Yes | Çalıştırılacak uygulamayı içeren giriş klasörü |
args |
string \| undefined |
Hayır | Uygulamaya geçirmek için komut satırı argümanları |
clean |
boolean \| undefined |
Hayır | Yeniden dağıtmadan önce mevcut paketin uygulama verilerini (LocalState, ayarlar vb.) kaldırın. Varsayılan olarak, uygulama verileri yeniden dağıtımlarda korunur. |
debugOutput |
boolean \| undefined |
Hayır | Başlatılan uygulamadan OutputDebugString iletilerini ve ilk şans özel durumlarını yakalayın. Aynı anda bir işleme yalnızca bir hata ayıklayıcısı eklenebilir, bu nedenle diğer hata ayıklayıcılar (Visual Studio, VS Code) aynı anda kullanılamaz. Farklı bir hata ayıklayıcı eklemeniz gerekiyorsa bunun yerine --no-launch kullanın. --no-launch veya --json ile birleştirilemez. |
detach |
boolean \| undefined |
Hayır | Uygulamayı başlatın ve çıkışını beklemeden hemen geri dönün. Başlatma sonrasında uygulamayla etkileşim kurmanız gereken CI/otomasyon için kullanışlıdır. PID'yi stdout'a (veya --json ile JSON'da) yazdırır. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
manifest |
string \| undefined |
Hayır | Package.appxmanifest dosyasının yolu (varsayılan: giriş klasöründen veya mevcut dizinden otomatik algılama) |
noLaunch |
boolean \| undefined |
Hayır | Uygulamayı başlatmadan yalnızca hata ayıklama kimliğini oluşturun ve paketi kaydedin |
outputAppxDirectory |
string \| undefined |
Hayır | Gevşek düzen paketi için çıkış dizini. Belirtilmezse, input-folder dizininin içindeki AppX adlı bir dizin kullanılır. |
symbols |
boolean \| undefined |
Hayır | Daha zengin yerel kilitlenme analizi için sembolleri Microsoft Sembol Sunucusu'ndan indirin. Yalnızca --debug-output ile kullanılır. İlk çalıştırma simgeleri indirir ve yerel olarak önbelleğe alır; sonraki çalıştırmalarda önbellek kullanılır. |
unregisterOnExit |
boolean \| undefined |
Hayır | Uygulama çıktıktan sonra geliştirme paketinin kaydını kaldırın. Yalnızca geliştirme modunda kayıtlı paketleri kaldırır. |
withAlias |
boolean \| undefined |
Hayır | Uygulamayı AUMID etkinleştirmesi yerine çalışma diğer adını kullanarak başlatın. Uygulama geçerli terminalde devralınan stdin/stdout/stderr ile çalışır. Manifest dosyasında bir uap5:ExecutionAlias gerektirir. Bildirime bir çalıştırma takma adı eklemek için "winapp manifest add-alias" komutunu kullanın. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
SignOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
filePath |
string |
Yes | İmzalayacak dosyanın/paketin yolu |
certPath |
string |
Yes | Sertifika dosyasının yolu (PFX biçimi) |
password |
string \| undefined |
Hayır | Sertifika parolası |
timestamp |
string \| undefined |
Hayır | Zaman damgası sunucusu URL'si |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
StoreOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
storeArgs |
string[] \| undefined |
Hayır | Microsoft Store Geliştirici CLI'sına geçirilecek bağımsız değişkenler. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
ToolOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
toolArgs |
string[] \| undefined |
Hayır | SDK aracına geçirecek argümanlar; örneğin, ['makeappx', 'pack', '/d', './folder', '/p', './out.msix']. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıktı modunu etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiClickOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya automationId ile aranacak anlamsal terim (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
double |
boolean \| undefined |
Hayır | Tek tıklama yerine çift tıklama gerçekleştirme |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
right |
boolean \| undefined |
Hayır | Sol tıklama yerine sağ tıklama gerçekleştirme |
window |
number \| undefined |
Hayır | HWND tarafından hedef pencere (liste çıktısından sabit tanıtıcı). --app'den önceliklidir. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiFocusOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya automationId ile aranacak anlamsal terim (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından hedef pencere (liste çıktısından sabit tanıtıcı). --app'den önceliklidir. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiGetFocusedOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından hedef pencere (liste çıktısından sabit tanıtıcı). --app'den önceliklidir. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiGetPropertyOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya automationId ile aranacak anlamsal terim (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
property |
string \| undefined |
Hayır | Okunacak veya filtrelenecek özellik adı |
window |
number \| undefined |
Hayır | HWND tarafından hedef pencere (liste çıktısından sabit tanıtıcı). --app'den önceliklidir. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiGetValueOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiInspectOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
ancestors |
boolean \| undefined |
Hayır | Ağaçta belirtilen öğeden köke kadar yukarı çıkın |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
depth |
number \| undefined |
Hayır | Ağaç inceleme derinliği |
hideDisabled |
boolean \| undefined |
Hayır | Devre dışı bırakılan öğeleri çıkıştan gizleme |
hideOffscreen |
boolean \| undefined |
Hayır | Ekran dışı öğeleri çıkıştan gizleme |
interactive |
boolean \| undefined |
Hayır | Yalnızca etkileşimli/çağrılabilen öğeleri (düğmeler, bağlantılar, girişler, liste öğeleri) gösterir. Varsayılan derinliği 8'e artırır. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiInvokeOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiListWindowsOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiScreenshotOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
captureScreen |
boolean \| undefined |
Hayır | Pencere işleme yerine ekran yakalama (açılır pencereler/bindirmeler dahil). Önce pencereyi ön plana getirir. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
output |
string \| undefined |
Hayır | Çıktıyı dosya yoluna kaydetme (örn. ekran görüntüsü) |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiScrollOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
direction |
string \| undefined |
Hayır | Kaydırma yönü: yukarı, aşağı, sol, sağ |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
to |
string \| undefined |
Hayır | Görünüm kaydırma: üst, alt |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiScrollIntoViewOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiSearchOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
max |
number \| undefined |
Hayır | Arama sonuçları üst sınırı |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiSetValueOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
value |
string \| undefined |
Hayır | Ayarlanacağı değer (TextBox/ComboBox metni, Kaydırıcı için sayı) |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiStatusOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UiWaitForOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
selector |
string \| undefined |
Hayır | Ad veya otomasyonKimliği ile aranacak anlamsal slug (btn-minimize-d1a0 gibi) veya metin |
app |
string \| undefined |
Hayır | Hedef uygulama (işlem adı, pencere başlığı veya PID). Belirsizse pencereleri listeler. |
contains |
boolean \| undefined |
Hayır | Tam eşleşme yerine --value için alt dize eşleştirmesi kullanın |
gone |
boolean \| undefined |
Hayır | Öğenin görünmesi yerine kaybolmasını bekleyin |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
property |
string \| undefined |
Hayır | Okunacak veya filtrelenecek özellik adı |
timeout |
number \| undefined |
Hayır | Milisaniye cinsinden zaman aşımı |
value |
string \| undefined |
Hayır | Öğe değerinin bu dizeye eşit olmasını bekleyin. Akıllı geri dönüş kullanır (TextPattern -> ValuePattern -> Adı). Bunun yerine belirli bir özelliği denetlemek için --property ile birleştirin. |
window |
number \| undefined |
Hayır | HWND tarafından belirlenen hedef pencere (liste çıktısından kararlı tutamak). --app üzerinde üstünlüğü vardır. |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UnregisterOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
force |
boolean \| undefined |
Hayır | Yükleme konumu dizin denetimini atlayın ve paket farklı bir proje ağacından kaydedilmiş olsa bile kaydını kaldırın |
json |
boolean \| undefined |
Hayır | Çıktıyı JSON olarak biçimlendirme |
manifest |
string \| undefined |
Hayır | Package.appxmanifest yolunun (varsayılan: mevcut dizinden otomatik olarak algılanması) |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
UpdateOptions
| Mülkiyet | Türü | Zorunlu | Description |
|---|---|---|---|
setupSdks |
SdkInstallMode \| undefined |
Hayır | SDK yükleme modu: 'kararlı' (varsayılan), 'önizleme', 'deneysel' veya 'hiçbiri' (SDK yüklemesini atla) |
quiet |
boolean \| undefined |
Hayır | İlerleme iletilerini gizleme. |
verbose |
boolean \| undefined |
Hayır | Ayrıntılı çıkışı etkinleştirin. |
cwd |
string \| undefined |
Hayır | CLI işlemi için çalışma dizini (varsayılan olarak process.cwd()). |
Windows developer