Paket NPM — API Terprogram

Referensi TypeScript/JavaScript API untuk @microsoft/winappcli. Setiap perintah CLI tersedia sebagai fungsi asinkron yang menangkap stdout/stderr dan mengembalikan hasil yang ditik. Perangkat pembantu untuk identitas MSIX, identitas debug Electron, dan alat pengembangan juga diekspor.

Installation

npm install @microsoft/winappcli

Cepat Mulai

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' });

Jenis umum

Setiap pembungkus perintah CLI menerima objek opsi yang diperluas CommonOptions dan mengembalikan Promise<WinappResult>.

CommonOptions

Opsi dasar yang umum di sebagian besar perintah.

Harta benda Tipe Required Deskripsi
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

WinappResult

Hasil yang dikembalikan oleh setiap pembungkus perintah.

Harta benda Tipe Required Deskripsi
exitCode number Yes Proses kode keluar (selalu 0 pada keberhasilan - bukan nol melempar).
stdout string Yes Output yang diambil secara standar.
stderr string Yes Kesalahan standar yang diambil.

Pembungkus perintah CLI

Fungsi-fungsi ini membungkus perintah CLI asli winapp . Semua menerima CommonOptions (quiet, verbose, cwd).

certGenerate()

Buat sertifikat yang ditandatangani sendiri hanya untuk pengujian lokal. Publisher harus sesuai dengan manifes (ditentukan secara otomatis jika --manifest disediakan atau Package.appxmanifest ada di direktori kerja). Output: devcert.pfx (kata sandi default: 'password'). Untuk produksi, dapatkan sertifikat dari CA tepercaya. Gunakan 'penginstalan sertifikasi' untuk mempercayai komputer ini.

function certGenerate(options?: CertGenerateOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
exportCer boolean \| undefined No Ekspor berkas .cer (hanya kunci publik) bersama berkas .pfx
ifExists IfExists \| undefined No Perilaku ketika file output ada: 'error' (fail, default), 'skip' (keep existing), atau 'overwrite' (replace)
install boolean \| undefined No Menginstal sertifikat ke penyimpanan komputer lokal setelah pembuatan
json boolean \| undefined No Format output sebagai JSON
manifest string \| undefined No Jalur ke file Package.appxmanifest atau appxmanifest.xml untuk mengekstraksi informasi penerbit dari
output string \| undefined No Jalur output untuk file PFX yang dihasilkan
password string \| undefined No Kata sandi untuk file PFX yang dihasilkan
publisher string \| undefined No Nama penerbit untuk sertifikat yang dihasilkan. Jika tidak ditentukan, akan disimpulkan dari manifes.
validDays number \| undefined No Jumlah hari sertifikat valid

Juga menerima CommonOptions (quiet, verbose, cwd).

certInfo()

Tampilkan detail sertifikat (subjek, thumbprint, kedaluwarsa). Berguna untuk memverifikasi sertifikat yang cocok dengan manifes Anda sebelum menandatangani.

function certInfo(options: CertInfoOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
certPath string Yes Jalur ke file sertifikat (PFX)
json boolean \| undefined No Format output sebagai JSON
password string \| undefined No Kata sandi untuk file PFX

Juga menerima CommonOptions (quiet, verbose, cwd).

certInstall()

Percayai sertifikat pada komputer ini (memerlukan admin). Jalankan sebelum menginstal paket MSIX yang ditandatangani dengan sertifikat dev. Contoh: winapp cert install ./devcert.pfx. Hanya diperlukan sekali per sertifikat.

function certInstall(options: CertInstallOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
certPath string Yes Jalur ke file sertifikat (PFX atau CER)
force boolean \| undefined No Penginstalan paksa meskipun sertifikat sudah ada
password string \| undefined No Kata sandi untuk file PFX

Juga menerima CommonOptions (quiet, verbose, cwd).

createDebugIdentity()

Aktifkan identitas paket untuk debugging tanpa membuat MSIX penuh. Diperlukan untuk menguji API Windows (pemberitahuan push, target berbagi, dll.) selama pengembangan. Contoh: winapp create-debug-identity ./myapp.exe. Memerlukan Package.appxmanifest atau appxmanifest.xml di direktori saat ini atau diteruskan melalui --manifest. Jalankan kembali setelah mengubah manifes atau Aset/.

function createDebugIdentity(options?: CreateDebugIdentityOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
entrypoint string \| undefined No Jalur ke .exe yang perlu dijalankan dengan kredensial identitas, atau skrip entry point.
keepIdentity boolean \| undefined No Pertahankan identitas paket dari manifes as-is, tanpa menambahkan '.debug' ke nama paket dan ID aplikasi.
manifest string \| undefined No Jalur ke Package.appxmanifest atau appxmanifest.xml
noInstall boolean \| undefined No Jangan instal paket setelah pembuatan.

Juga menerima CommonOptions (quiet, verbose, cwd).

createExternalCatalog()

Menghasilkan file katalog CodeIntegrityExternal.cat dengan hash file yang dapat dieksekusi dari direktori tertentu. Digunakan dengan flag TrustedLaunch dalam manifes-manifes paket sparse MSIX (AllowExternalContent) untuk memungkinkan eksekusi file eksternal yang tidak disertakan dalam paket.

function createExternalCatalog(options: CreateExternalCatalogOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
inputFolder string Yes Daftar folder input dengan file yang dapat dieksekusi untuk diproses (dipisahkan oleh titik koma)
computeFlatHashes boolean \| undefined No Sertakan hash datar saat membuat katalog
ifExists IfExists \| undefined No Perilaku ketika file output sudah ada
output string \| undefined No Jalur file katalog output. Jika tidak ditentukan, nama CodeIntegrityExternal.cat default digunakan.
recursive boolean \| undefined No Sertakan file dari subdirektori
usePageHashes boolean \| undefined No Sertakan hash pada halaman saat membuat katalog

Juga menerima CommonOptions (quiet, verbose, cwd).

getWinappPath()

Cetak jalur ke direktori .winapp. Gunakan --global untuk lokasi cache bersama, atau hilangkan untuk folder .winapp lokal proyek. Berguna untuk skrip build yang perlu mereferensikan paket yang diinstal.

function getWinappPath(options?: GetWinappPathOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
global boolean \| undefined No Dapatkan direktori .winapp global alih-alih lokal

Juga menerima CommonOptions (quiet, verbose, cwd).

init()

Mulai di sini untuk menginisialisasi aplikasi Windows dengan penyiapan yang diperlukan. Menyiapkan semua yang diperlukan untuk pengembangan aplikasi Windows: membuat Package.appxmanifest dengan aset default, mengunduh Windows paket SDK dan SDK Aplikasi Windows, dan menghasilkan proyeksi. Ketika paket SDK dikelola (--setup-sdks stabil/pratinjau/eksperimental), juga membuat winapp.yaml untuk menetapkan versi bagi 'restore'/'update'; dengan --setup-sdks none (misalnya, untuk proyek Rust/Tauri yang menggunakan binding SDK mereka sendiri), tidak ada winapp.yaml yang dibuat. Interaktif secara default (gunakan --use-defaults untuk melewati perintah). Gunakan 'restore' sebagai gantinya jika Anda mengkloning repositori yang sudah memiliki winapp.yaml. Gunakan 'hasil manifes' jika Anda hanya memerlukan manifes, atau 'hasilkan sertifikasi' jika Anda memerlukan sertifikat pengembangan untuk penandatanganan kode.

function init(options?: InitOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
baseDirectory string \| undefined No Direktori dasar/akar untuk ruang kerja winapp, untuk konsumsi atau penginstalan.
configDir string \| undefined No Direktori untuk membaca/menyimpan konfigurasi (default: direktori saat ini)
configOnly boolean \| undefined No Hanya mengelola operasi berkas konfigurasi (buat jika tidak ada, validasi jika ada). Lewati penginstalan paket dan langkah-langkah penyiapan ruang kerja lainnya.
ignoreConfig boolean \| undefined No Jangan gunakan file konfigurasi untuk manajemen versi
noGitignore boolean \| undefined No Jangan perbarui file .gitignore
setupSdks SdkInstallMode \| undefined No Mode penginstalan SDK: 'stabil' (default), 'pratinjau', 'eksperimental', atau 'tidak ada' (lewati penginstalan SDK)
useDefaults boolean \| undefined No Jangan tampilkan prompt, dan gunakan pengaturan default untuk semua isian

Juga menerima CommonOptions (quiet, verbose, cwd).

manifestAddAlias()

Tambahkan alias eksekusi (uap5:AppExecutionAlias) ke Package.appxmanifest. Ini memungkinkan peluncuran aplikasi yang dipaketkan dari baris perintah dengan mengetikkan nama alias. Secara default, alias disimpulkan dari atribut Executable (misalnya $targetnametoken$.exe menjadi $targetnametoken$.exe alias).

function manifestAddAlias(options?: ManifestAddAliasOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
appId string \| undefined No Id Aplikasi untuk menambahkan alias ke (default: elemen Aplikasi pertama)
manifest string \| undefined No Jalur ke file Package.appxmanifest atau appxmanifest.xml (default: cari direktori saat ini)
name string \| undefined No Nama alias (misalnya 'myapp.exe'). Default: disimpulkan dari atribut Executable pada manifes.

Juga menerima CommonOptions (quiet, verbose, cwd).

manifestGenerate()

Buat Package.appxmanifest tanpa penyiapan proyek penuh. Gunakan saat Anda hanya memerlukan manifes dan aset gambar (tanpa SDK, tanpa sertifikat). Untuk penyiapan penuh, gunakan 'init' sebagai gantinya. Templat: 'dipaketkan' (MSIX penuh), 'sparse' (aplikasi desktop membutuhkan API Windows).

function manifestGenerate(options?: ManifestGenerateOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
directory string \| undefined No Direktori untuk membuat berkas manifes di
description string \| undefined No Deskripsi aplikasi yang dapat dibaca manusia ditampilkan selama penginstalan dan di Pengaturan Windows
executable string \| undefined No Jalur ke aplikasi yang dapat dieksekusi. Default: <nama-paket>.exe
ifExists IfExists \| undefined No Perilaku ketika file output ada: 'error' (gagal, default), 'skip' (biarkan yang ada), atau 'overwrite' (ganti)
logoPath string \| undefined No Jalur ke file gambar logo
packageName string \| undefined No Nama paket (default: nama folder)
publisherName string \| undefined No Publisher CN (default: CN=<pengguna saat ini>)
template ManifestTemplates \| undefined No Jenis templat manifes: 'dikemas' (aplikasi MSIX lengkap, default) atau 'sparse' (aplikasi desktop dengan identitas paket untuk API Windows)
version string \| undefined No Versi aplikasi dalam format Major.Minor.Build.Revision (misalnya, 1.0.0.0).

Juga menerima CommonOptions (quiet, verbose, cwd).

manifestUpdateAssets()

Hasilkan aset baru untuk gambar yang dirujuk dalam Package.appxmanifest dari satu gambar sumber. Gambar sumber harus setidaknya 400x400 piksel.

function manifestUpdateAssets(options: ManifestUpdateAssetsOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
imagePath string Yes Jalur ke file gambar sumber (SVG, PNG, ICO, JPG, BMP, GIF)
lightImage string \| undefined No Jalur ke gambar sumber untuk varian tema ringan (SVG, PNG, ICO, JPG, BMP, GIF)
manifest string \| undefined No Jalur ke file Package.appxmanifest atau appxmanifest.xml (default: cari direktori saat ini)

Juga menerima CommonOptions (quiet, verbose, cwd).

packageApp()

Buat penginstal MSIX dari aplikasi bawaan Anda. Jalankan setelah membangun aplikasi Anda. Manifes (Package.appxmanifest atau appxmanifest.xml) diperlukan untuk pengemasan - manifes harus berada di direktori kerja saat ini, diteruskan sebagai --manifest atau berada di folder input. Gunakan --cert devcert.pfx untuk menandatangani pengujian. Contoh: paket winapp ./dist --manifest Package.appxmanifest --cert ./devcert.pfx

function packageApp(options: PackageOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
inputFolder string Yes Folder masukan dengan tata letak paket
cert string \| undefined No Jalur ke sertifikat penandatanganan (akan ditandatangani secara otomatis jika disediakan)
certPassword string \| undefined No Kata sandi sertifikat (default: kata sandi)
executable string \| undefined No Jalur ke executable relatif terhadap folder input.
generateCert boolean \| undefined No Membuat sertifikat pengembangan baru
installCert boolean \| undefined No Menginstal sertifikat ke komputer
manifest string \| undefined No Jalur ke file manifes AppX (default: deteksi otomatis dari folder input atau direktori saat ini)
name string \| undefined No Nama paket (default: dari manifest)
output string \| undefined No Nama file msix output untuk paket yang dihasilkan (default ke <nama><versi><arch.msix>, kembali ke <nama><version.msix>, <nama><arch.msix>, atau <name.msix> saat versi/arch tidak dapat ditentukan)
publisher string \| undefined No nama Publisher untuk pembuatan sertifikat
selfContained boolean \| undefined No Bundel SDK Aplikasi Windows runtime untuk penyebaran mandiri
skipPri boolean \| undefined No Lewati pembuatan file PRI

Juga menerima CommonOptions (quiet, verbose, cwd).

restore()

Gunakan setelah mengkloning repositori atau ketika folder .winapp/ hilang. Menginstal ulang paket SDK dari winapp.yaml yang ada tanpa mengubah versi. Membutuhkan winapp.yaml (dibuat oleh 'init'). Untuk memeriksa versi SDK yang lebih baru, gunakan 'perbarui' sebagai gantinya.

function restore(options?: RestoreOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
baseDirectory string \| undefined No Direktori dasar/akar untuk ruang kerja winapp
configDir string \| undefined No Direktori untuk membaca konfigurasi dari (default: direktori saat ini)

Juga menerima CommonOptions (quiet, verbose, cwd).

run()

Membuat tata letak paket, mendaftarkan Aplikasi, dan meluncurkan aplikasi paket.

function run(options: RunOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
inputFolder string Yes Folder input yang berisi aplikasi yang akan dijalankan
args string \| undefined No Parameter baris perintah untuk diteruskan ke aplikasi
clean boolean \| undefined No Hapus data aplikasi paket yang ada (LocalState, pengaturan, dll.) sebelum menyebarkan ulang. Secara default, data aplikasi dipertahankan di seluruh penyebaran ulang.
debugOutput boolean \| undefined No Tangkap pesan OutputDebugString dan pengecualian kesempatan pertama dari aplikasi yang diluncurkan. Hanya satu debugger yang dapat dilampirkan ke proses pada satu waktu, sehingga debugger lain (Visual Studio, VS Code) tidak dapat digunakan secara bersamaan. Gunakan --no-launch sebagai gantinya jika Anda perlu melampirkan debugger yang berbeda. Tidak dapat dikombinasikan dengan --no-launch atau --json.
detach boolean \| undefined No Luncurkan aplikasi dan segera kembali tanpa menunggunya keluar. Berguna untuk CI/automation di mana Anda perlu berinteraksi dengan aplikasi setelah peluncuran. Mencetak PID ke stdout (atau di JSON dengan --json).
json boolean \| undefined No Format output sebagai JSON
manifest string \| undefined No Jalur ke Package.appxmanifest (default: deteksi otomatis dari folder input atau direktori saat ini)
noLaunch boolean \| undefined No Hanya buat identitas debug dan daftarkan paket tanpa meluncurkan aplikasi
outputAppxDirectory string \| undefined No Direktori output untuk paket tata letak yang longgar. Jika tidak ditentukan, direktori bernama AppX di dalam direktori input-folder akan digunakan.
symbols boolean \| undefined No Unduh simbol dari Microsoft Symbol Server untuk analisis crash asli yang lebih kaya. Hanya digunakan dengan --debug-output. Pada jalankan pertama, simbol diunduh dan disimpan secara lokal; pada jalankan berikutnya, cache digunakan.
unregisterOnExit boolean \| undefined No Batalkan pendaftaran paket pengembangan setelah aplikasi keluar. Hanya menghapus paket yang terdaftar dalam mode pengembangan.
withAlias boolean \| undefined No Luncurkan aplikasi menggunakan alias eksekusinya alih-alih aktivasi AUMID. Aplikasi berjalan di terminal saat ini dengan stdin/stdout/stderr yang diwariskan. Memerlukan uap5:ExecutionAlias dalam sebuah manifes. Gunakan "winapp manifest add-alias" untuk menambahkan alias eksekusi ke manifes.

Juga menerima CommonOptions (quiet, verbose, cwd).

sign()

Menandatangani digital paket MSIX atau file eksekusi. Contoh: winapp sign ./app.msix ./devcert.pfx. Gunakan --timestamp untuk build produksi agar tetap valid setelah sertifikasi kedaluwarsa. Perintah 'paket' dapat ditandatangani secara otomatis dengan --cert.

function sign(options: SignOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
filePath string Yes Jalur ke file/paket yang akan ditandatangani
certPath string Yes Jalur ke file sertifikat (format PFX)
password string \| undefined No Kata sandi sertifikat
timestamp string \| undefined No URL server tanda waktu

Juga menerima CommonOptions (quiet, verbose, cwd).

store()

Jalankan perintah Microsoft Store Developer CLI. Perintah ini akan mengunduh Microsoft Store Developer CLI jika belum diunduh. Pelajari selengkapnya tentang CLI Pengembang Microsoft Store di sini: https://aka.ms/msstoredevcli

function store(options?: StoreOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
storeArgs string[] \| undefined No Argumen untuk diteruskan ke CLI Pengembang Microsoft Store.

Juga menerima CommonOptions (quiet, verbose, cwd).

tool()

Jalankan Windows alat SDK secara langsung (makeappx, signtool, makepri, dll.). Unduh otomatis Build Tools jika diperlukan. Untuk sebagian besar tugas, lebih suka perintah tingkat yang lebih tinggi seperti 'paket' atau 'tanda tangan'. Contoh: winapp tool makeappx pack /d ./folder /p ./out.msix

function tool(options?: ToolOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
toolArgs string[] \| undefined No Argumen untuk diteruskan ke alat SDK, contohnya ['makeappx', 'pack', '/d', './folder', '/p', './out.msix'].

Juga menerima CommonOptions (quiet, verbose, cwd).

uiClick()

Klik elemen dengan simpul atau pencarian teks menggunakan simulasi mouse. Bekerja pada elemen yang tidak mendukung InvokePattern (misalnya, header kolom, item daftar). Gunakan --double untuk klik dua kali, --right untuk klik kanan.

function uiClick(options?: UiClickOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
double boolean \| undefined No Lakukan klik ganda alih-alih satu klik
json boolean \| undefined No Format output sebagai JSON
right boolean \| undefined No Lakukan klik kanan alih-alih klik kiri
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiFocus()

Pindahkan fokus keyboard ke elemen yang ditentukan menggunakan UIA SetFocus.

function uiFocus(options?: UiFocusOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiGetFocused()

Tampilkan elemen yang saat ini memiliki fokus keyboard di aplikasi target.

function uiGetFocused(options?: UiGetFocusedOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiGetProperty()

Membaca nilai properti UIA dari sebuah elemen. Tentukan --property untuk satu properti atau hilangkan untuk semua.

function uiGetProperty(options?: UiGetPropertyOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
property string \| undefined No Nama properti untuk dibaca atau disaring
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiGetValue()

Baca nilai saat ini dari elemen. Mencoba TextPattern (RichEditBox, Document), ValuePattern (TextBox, ComboBox, Slider), lalu Name (label). Penggunaan perintah: winapp ui get-value <selector> -a <app>

function uiGetValue(options?: UiGetValueOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiInspect()

Lihat pohon elemen UI dengan simpul semantik, jenis elemen, nama, dan batas.

function uiInspect(options?: UiInspectOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
ancestors boolean \| undefined No Berjalan ke atas pohon dari elemen yang ditentukan ke akar
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
depth number \| undefined No Kedalaman pemeriksaan pohon
hideDisabled boolean \| undefined No Sembunyikan elemen yang dinonaktifkan dari output
hideOffscreen boolean \| undefined No Sembunyikan elemen di luar layar dari output
interactive boolean \| undefined No Tampilkan hanya elemen interaktif/yang dapat dipanggil (tombol, tautan, input, item daftar). Meningkatkan kedalaman default menjadi 8.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiInvoke()

Aktifkan elemen dengan slug atau pencarian teks. Mencoba InvokePattern, TogglePattern, SelectionItemPattern, dan ExpandCollapsePattern secara berurutan.

function uiInvoke(options?: UiInvokeOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiListWindows()

Cantumkan semua jendela yang terlihat dengan HWND, judul, proses, dan ukurannya. Gunakan -a untuk memfilter menurut nama aplikasi. Gunakan HWND dengan -w untuk menargetkan jendela tertentu.

function uiListWindows(options?: UiListWindowsOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON

Juga menerima CommonOptions (quiet, verbose, cwd).

uiScreenshot()

Ambil jendela target atau elemen sebagai gambar PNG. Ketika ada beberapa jendela (misalnya, dialog), mengambil masing-masing ke file terpisah. Dengan --json, mengembalikan jalur dan dimensi file. Gunakan --capture-screen untuk menampilkan overlay popup.

function uiScreenshot(options?: UiScreenshotOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
captureScreen boolean \| undefined No Tangkap dari layar (termasuk popup/overlay) bukan rendering jendela. Membawa jendela ke latar depan terlebih dahulu.
json boolean \| undefined No Format output sebagai JSON
output string \| undefined No Simpan output ke jalur file (misalnya, cuplikan layar)
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiScroll()

Gulir elemen kontainer menggunakan ScrollPattern. Gunakan --direction untuk menggulir secara bertahap, atau --untuk melompat ke atas/bawah.

function uiScroll(options?: UiScrollOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
direction string \| undefined No Arah gulir: atas, bawah, kiri, kanan
json boolean \| undefined No Format output sebagai JSON
to string \| undefined No Gulir ke posisi: atas, bawah
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiScrollIntoView()

Gulir elemen yang ditentukan ke area yang terlihat menggunakan UIA ScrollItemPattern.

function uiScrollIntoView(options?: UiScrollIntoViewOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiSearch()

Cari pohon elemen untuk elemen yang cocok dengan kueri teks. Mengembalikan semua kecocokan dengan simpul semantik.

function uiSearch(options?: UiSearchOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
max number \| undefined No Hasil pencarian maksimum
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiSetValue()

Tetapkan nilai pada elemen menggunakan UIA ValuePattern. Berfungsi untuk TextBox, ComboBox, Slider, dan kontrol lain yang dapat diedit. Penggunaan: winapp ui set-value <selector><value> -a <app>

function uiSetValue(options?: UiSetValueOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
value string \| undefined No Nilai yang akan diatur (teks untuk TextBox/ComboBox, angka untuk Slider)
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiStatus()

Sambungkan ke aplikasi target dan tampilkan info koneksi.

function uiStatus(options?: UiStatusOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

uiWaitFor()

Tunggu hingga elemen muncul, menghilang, atau properti mencapai nilai target. Sistem melakukan pemeriksaan setiap 100ms hingga kondisi terpenuhi atau batas waktu terlampaui.

function uiWaitFor(options?: UiWaitForOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
contains boolean \| undefined No Gunakan pencocokan substring untuk --value alih-alih kecocokan persis
gone boolean \| undefined No Tunggu hingga elemen menghilang alih-alih muncul
json boolean \| undefined No Format output sebagai JSON
property string \| undefined No Nama properti untuk dibaca atau disaring
timeout number \| undefined No Batas waktu dalam milidetik
value string \| undefined No Tunggu nilai elemen sama dengan string ini. Menggunakan fallback cerdas (TextPattern -> ValuePattern -> Name). Gabungkan dengan --property untuk memeriksa properti tertentu sebagai gantinya.
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.

Juga menerima CommonOptions (quiet, verbose, cwd).

unregister()

Membatalkan pendaftaran paket pengembangan yang diinstal secara sideload. Hanya menghapus paket yang terdaftar dalam mode pengembangan (misalnya, melalui 'winapp run' atau 'create-debug-identity').

function unregister(options?: UnregisterOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
force boolean \| undefined No Lewati pemeriksaan direktori lokasi penginstalan dan batalkan pendaftaran meskipun paket terdaftar dari pohon proyek yang berbeda
json boolean \| undefined No Format output sebagai JSON
manifest string \| undefined No Jalur ke Package.appxmanifest (default: deteksi otomatis dari direktori saat ini)

Juga menerima CommonOptions (quiet, verbose, cwd).

update()

Periksa dan instal versi SDK yang lebih baru. Memperbarui winapp.yaml dengan versi terbaru dan menginstal ulang paket. Memerlukan winapp.yaml yang ada (dibuat oleh 'init'). Gunakan pratinjau --setup-sdks untuk pratinjau SDK. Untuk menginstal ulang versi saat ini tanpa memperbarui, gunakan 'pulihkan' sebagai gantinya.

function update(options?: UpdateOptions): Promise<WinappResult>

Opsi:

Harta benda Tipe Required Deskripsi
setupSdks SdkInstallMode \| undefined No Mode penginstalan SDK: 'stabil' (default), 'pratinjau', 'eksperimental', atau 'tidak ada' (lewati penginstalan SDK)

Juga menerima CommonOptions (quiet, verbose, cwd).

Fungsi utilitas

execWithBuildTools()

Jalankan perintah dengan jalur bin BuildTools yang ditambahkan ke lingkungan PATH

function execWithBuildTools(command: string, options?: ExecSyncOptions): string | Buffer<ArrayBufferLike>

Parameter:

Parameter Tipe Required Deskripsi
command string Yes Perintah yang akan dijalankan
options ExecSyncOptions No Opsi untuk diteruskan ke execSync (opsional)

Kembali: Hasil keluaran dari execSync

addMsixIdentityToExe()

Menambahkan informasi identitas paket dari file appxmanifest.xml ke manifes tersemat yang dapat dieksekusi

function addMsixIdentityToExe(exePath: string, appxManifestPath?: string | undefined, options?: MsixIdentityOptions): Promise<MsixIdentityResult>

Parameter:

Parameter Tipe Required Deskripsi
exePath string Yes Jalur ke file yang dapat dieksekusi
appxManifestPath string \| undefined No Jalur ke file appxmanifest.xml yang berisi data identitas paket
options MsixIdentityOptions No Konfigurasi opsional

addElectronDebugIdentity()

Menambahkan identitas paket ke proses debug Electron

function addElectronDebugIdentity(options?: MsixIdentityOptions): Promise<ElectronDebugIdentityResult>

Parameter:

Parameter Tipe Required Deskripsi
options MsixIdentityOptions No Opsi konfigurasi

clearElectronDebugIdentity()

Menghapus/menghilangkan identitas paket dari proses debug Electron dengan mengembalikan dari cadangan

function clearElectronDebugIdentity(options?: MsixIdentityOptions): Promise<ClearElectronDebugIdentityResult>

Parameter:

Parameter Tipe Required Deskripsi
options MsixIdentityOptions No Opsi konfigurasi

getGlobalWinappPath()

Dapatkan jalur ke direktori .winapp global

function getGlobalWinappPath(): string

Hasil: Jalur lengkap ke direktori .winapp global

getLocalWinappPath()

Dapatkan jalur ke direktori .winapp lokal

function getLocalWinappPath(): string

Kembali: Jalur lengkap ke direktori .winapp lokal

perintah CLI Node.js

Perintah ini tersedia secara eksklusif melalui npx winapp node <subcommand> dan tidak diekspor sebagai fungsi terprogram.

node create-addon

Hasilkan file addon asli untuk proyek Electron. Mendukung templat C++ (node-gyp) dan C# (node-api-dotnet).

npx winapp node create-addon [options]

Opsi:

Tanda Deskripsi
--name <name> Nama addon (default tergantung pada templat)
--template <type> Templat addon: cpp atau cs (default: cpp)
--verbose Mengaktifkan output verbose

Catatan: Harus dijalankan dari akar proyek Electron (direktori yang berisi package.json).

Contoh: 

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

Tambahkan identitas paket ke proses debug Electron menggunakan kemasan sparse. Membuat cadangan electron.exe, menghasilkan file manifes MSIX berformat jarang, menambahkan identitas pada file yang dapat dieksekusi, dan mendaftarkan paket berformat jarang. Memerlukan Package.appxmanifest (buat satu dengan winapp init atau winapp manifest generate).

npx winapp node add-electron-debug-identity [options]

Opsi:

Tanda Deskripsi
--manifest <path> Jalur ke kustom Package.appxmanifest (default: Package.appxmanifest di direktori saat ini)
--no-install Jangan instal paket setelah pembuatan
--keep-identity Pertahankan identitas manifes sebagaimana adanya, tanpa menambahkan akhiran .debug
--verbose Mengaktifkan output verbose

Catatan: Harus dijalankan dari akar proyek Electron (direktori yang berisi node_modules/electron). Untuk membatalkan, gunakan npx winapp node clear-electron-debug-identity.

Contoh: 

npx winapp node add-electron-debug-identity
npx winapp node add-electron-debug-identity --manifest ./custom/Package.appxmanifest

node clear-electron-debug-identity

Hapus identitas paket dari proses debug Electron. electron.exe Memulihkan dari cadangan yang dibuat oleh add-electron-debug-identity dan menghapus file cadangan.

npx winapp node clear-electron-debug-identity [options]

Opsi:

Tanda Deskripsi
--verbose Mengaktifkan output verbose

Catatan: Harus dijalankan dari akar proyek Electron (direktori yang berisi node_modules/electron).

Contoh: 

npx winapp node clear-electron-debug-identity

Referensi Tipe

ExecSyncOptions

Diekspor ulang dari Node.js untuk kenyamanan. Lihat dokumenNode.js.

MsixIdentityOptions

Harta benda Tipe Required Deskripsi
verbose boolean \| undefined No
noInstall boolean \| undefined No
keepIdentity boolean \| undefined No
manifest string \| undefined No

MsixIdentityResult

Harta benda Tipe Required Deskripsi
success boolean Yes

ElectronDebugIdentityResult

Harta benda Tipe Required Deskripsi
success boolean Yes
electronExePath string Yes
backupPath string Yes
manifestPath string Yes
assetsDir string Yes

ClearElectronDebugIdentityResult

Harta benda Tipe Required Deskripsi
success boolean Yes
electronExePath string Yes
restoredFromBackup boolean Yes

CallWinappCliOptions

Harta benda Tipe Required Deskripsi
exitOnError boolean \| undefined No

CallWinappCliResult

Harta benda Tipe Required Deskripsi
exitCode number Yes

CallWinappCliCaptureOptions

Harta benda Tipe Required Deskripsi
cwd string \| undefined No Direktori kerja untuk proses CLI (pengaturan awal ke process.cwd())

CallWinappCliCaptureResult

Harta benda Tipe Required Deskripsi
exitCode number Yes
stdout string Yes
stderr string Yes

GenerateCppAddonOptions

Harta benda Tipe Required Deskripsi
name string \| undefined No
projectRoot string \| undefined No
verbose boolean \| undefined No

GenerateCppAddonResult

Harta benda Tipe Required Deskripsi
success boolean Yes
addonName string Yes
addonPath string Yes
needsTerminalRestart boolean Yes
files string[] Yes

GenerateCsAddonOptions

Harta benda Tipe Required Deskripsi
name string \| undefined No
projectRoot string \| undefined No
verbose boolean \| undefined No

GenerateCsAddonResult

Harta benda Tipe Required Deskripsi
success boolean Yes
addonName string Yes
addonPath string Yes
needsTerminalRestart boolean Yes
files string[] Yes

IfExists

Nilai IfExists.

type IfExists = "error" | "overwrite" | "skip"

SdkInstallMode

Nilai dari SdkInstallMode.

type SdkInstallMode = "stable" | "preview" | "experimental" | "none"

ManifestTemplates

Nilai dari ManifestTemplates.

type ManifestTemplates = "packaged" | "sparse"

CertGenerateOptions

Harta benda Tipe Required Deskripsi
exportCer boolean \| undefined No Ekspor file .cer (kunci publik saja) bersama .pfx
ifExists IfExists \| undefined No Perilaku ketika file output ada: 'error' (gagal, default), 'skip' (biarkan yang ada), atau 'overwrite' (ganti)
install boolean \| undefined No Menginstal sertifikat ke penyimpanan komputer lokal setelah pembuatan
json boolean \| undefined No Format output sebagai JSON
manifest string \| undefined No Jalur ke file Package.appxmanifest atau appxmanifest.xml untuk mengekstrak informasi penerbit dari
output string \| undefined No Jalur output untuk file PFX yang dihasilkan
password string \| undefined No Kata sandi untuk file PFX yang dihasilkan
publisher string \| undefined No Nama penerbit untuk sertifikat yang dihasilkan. Jika tidak ditentukan, akan disimpulkan dari manifes.
validDays number \| undefined No Jumlah hari sertifikat valid
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan output verbose.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara default ke process.cwd()).

CertInfoOptions

Harta benda Tipe Required Deskripsi
certPath string Yes Jalur ke file sertifikat (PFX)
json boolean \| undefined No Format output sebagai JSON
password string \| undefined No Kata sandi untuk file PFX
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan output verbose.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara default ke process.cwd()).

CertInstallOptions

Harta benda Tipe Required Deskripsi
certPath string Yes Jalur ke file sertifikat (PFX atau CER)
force boolean \| undefined No Penginstalan paksa meskipun sertifikat sudah ada
password string \| undefined No Kata sandi untuk file PFX
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan output mendetail.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara default mengarah ke process.cwd()).

CreateDebugIdentityOptions

Harta benda Tipe Required Deskripsi
entrypoint string \| undefined No Jalur ke .exe yang perlu dijalankan dengan kredensial identitas, atau skrip entry point.
keepIdentity boolean \| undefined No Pertahankan identitas paket dari manifes as-is, tanpa menambahkan '.debug' ke nama paket dan ID aplikasi.
manifest string \| undefined No Jalur ke Package.appxmanifest atau appxmanifest.xml
noInstall boolean \| undefined No Jangan instal paket setelah pembuatan.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan output rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara default menggunakan process.cwd()).

CreateExternalCatalogOptions

Harta benda Tipe Required Deskripsi
inputFolder string Yes Daftar folder input dengan file yang dapat dieksekusi untuk diproses (dipisahkan oleh titik koma)
computeFlatHashes boolean \| undefined No Sertakan hash datar saat membuat katalog
ifExists IfExists \| undefined No Perilaku ketika file output sudah ada
output string \| undefined No Jalur file katalog output. Jika tidak ditentukan, nama CodeIntegrityExternal.cat default digunakan.
recursive boolean \| undefined No Sertakan file dari subdirektori
usePageHashes boolean \| undefined No Sertakan hash pada halaman saat membuat katalog
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran detail.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara default adalah process.cwd()).

GetWinappPathOptions

Harta benda Tipe Required Deskripsi
global boolean \| undefined No Dapatkan direktori .winapp global alih-alih lokal
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan output rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara default menggunakan process.cwd()).

InitOptions

Harta benda Tipe Required Deskripsi
baseDirectory string \| undefined No Direktori dasar/akar untuk ruang kerja winapp, untuk konsumsi atau penginstalan.
configDir string \| undefined No Direktori untuk membaca/menyimpan konfigurasi (default: direktori saat ini)
configOnly boolean \| undefined No Hanya mengelola operasi berkas konfigurasi (buat jika tidak ada, validasi jika ada). Lewati penginstalan paket dan langkah-langkah penyiapan ruang kerja lainnya.
ignoreConfig boolean \| undefined No Jangan gunakan file konfigurasi untuk manajemen versi
noGitignore boolean \| undefined No Jangan perbarui file .gitignore
setupSdks SdkInstallMode \| undefined No Mode penginstalan SDK: 'stabil' (default), 'pratinjau', 'eksperimental', atau 'tidak ada' (lewati penginstalan SDK)
useDefaults boolean \| undefined No Jangan tampilkan prompt, dan gunakan pengaturan default untuk semua isian
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih terperinci.
cwd string \| undefined No Direktori kerja untuk proses CLI secara default adalah process.cwd().

ManifestAddAliasOptions

Harta benda Tipe Required Deskripsi
appId string \| undefined No Id Aplikasi untuk menambahkan alias ke (default: elemen Aplikasi pertama)
manifest string \| undefined No Jalur ke file Package.appxmanifest atau appxmanifest.xml (default: cari direktori saat ini)
name string \| undefined No Nama alias (misalnya 'myapp.exe'). Default: disimpulkan dari atribut Executable pada manifes.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara bawaan ke process.cwd()).

ManifestGenerateOptions

Harta benda Tipe Required Deskripsi
directory string \| undefined No Direktori untuk membuat berkas manifes di
description string \| undefined No Deskripsi aplikasi yang dapat dibaca manusia ditampilkan selama penginstalan dan di Pengaturan Windows
executable string \| undefined No Jalur ke aplikasi yang dapat dieksekusi. Default: <nama-paket>.exe
ifExists IfExists \| undefined No Perilaku ketika file output ada: 'error' (gagal, default), 'skip' (biarkan yang ada), atau 'overwrite' (ganti)
logoPath string \| undefined No Jalur ke file gambar logo
packageName string \| undefined No Nama paket (default: nama folder)
publisherName string \| undefined No Publisher CN (default: CN=<pengguna saat ini>)
template ManifestTemplates \| undefined No Jenis templat manifes: 'dikemas' (aplikasi MSIX lengkap, default) atau 'sparse' (aplikasi desktop dengan identitas paket untuk API Windows)
version string \| undefined No Versi aplikasi dalam format Major.Minor.Build.Revision (misalnya, 1.0.0.0).
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan output verbose.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

ManifestUpdateAssetsOptions

Harta benda Tipe Required Deskripsi
imagePath string Yes Jalur ke file gambar sumber (SVG, PNG, ICO, JPG, BMP, GIF)
lightImage string \| undefined No Jalur ke gambar sumber untuk varian tema ringan (SVG, PNG, ICO, JPG, BMP, GIF)
manifest string \| undefined No Jalur ke file Package.appxmanifest atau appxmanifest.xml (default: cari direktori saat ini)
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

PackageOptions

Harta benda Tipe Required Deskripsi
inputFolder string Yes Folder masukan dengan tata letak paket
cert string \| undefined No Jalur ke sertifikat penandatanganan (akan ditandatangani secara otomatis jika disediakan)
certPassword string \| undefined No Kata sandi sertifikat (default: kata sandi)
executable string \| undefined No Jalur ke executable relatif terhadap folder input.
generateCert boolean \| undefined No Membuat sertifikat pengembangan baru
installCert boolean \| undefined No Menginstal sertifikat ke komputer
manifest string \| undefined No Jalur ke file manifes AppX (default: deteksi otomatis dari folder input atau direktori saat ini)
name string \| undefined No Nama paket (default: dari manifest)
output string \| undefined No Nama file msix output untuk paket yang dihasilkan (default ke <nama><versi><arch.msix>, kembali ke <nama><version.msix>, <nama><arch.msix>, atau <name.msix> saat versi/arch tidak dapat ditentukan)
publisher string \| undefined No nama Publisher untuk pembuatan sertifikat
selfContained boolean \| undefined No Bundel SDK Aplikasi Windows runtime untuk penyebaran mandiri
skipPri boolean \| undefined No Lewati pembuatan file PRI
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

RestoreOptions

Harta benda Tipe Required Deskripsi
baseDirectory string \| undefined No Direktori dasar/akar untuk ruang kerja winapp
configDir string \| undefined No Direktori untuk membaca konfigurasi dari (default: direktori saat ini)
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

RunOptions

Harta benda Tipe Required Deskripsi
inputFolder string Yes Folder input yang berisi aplikasi yang akan dijalankan
args string \| undefined No Parameter baris perintah untuk diteruskan ke aplikasi
clean boolean \| undefined No Hapus data aplikasi paket yang ada (LocalState, pengaturan, dll.) sebelum menyebarkan ulang. Secara default, data aplikasi dipertahankan di seluruh penyebaran ulang.
debugOutput boolean \| undefined No Tangkap pesan OutputDebugString dan pengecualian kesempatan pertama dari aplikasi yang diluncurkan. Hanya satu debugger yang dapat dilampirkan ke proses pada satu waktu, sehingga debugger lain (Visual Studio, VS Code) tidak dapat digunakan secara bersamaan. Gunakan --no-launch sebagai gantinya jika Anda perlu melampirkan debugger yang berbeda. Tidak dapat dikombinasikan dengan --no-launch atau --json.
detach boolean \| undefined No Luncurkan aplikasi dan segera kembali tanpa menunggunya keluar. Berguna untuk CI/automation di mana Anda perlu berinteraksi dengan aplikasi setelah peluncuran. Mencetak PID ke stdout (atau di JSON dengan --json).
json boolean \| undefined No Format output sebagai JSON
manifest string \| undefined No Jalur ke Package.appxmanifest (default: deteksi otomatis dari folder input atau direktori saat ini)
noLaunch boolean \| undefined No Hanya buat identitas debug dan daftarkan paket tanpa meluncurkan aplikasi
outputAppxDirectory string \| undefined No Direktori output untuk paket tata letak yang longgar. Jika tidak ditentukan, direktori bernama AppX di dalam direktori input-folder akan digunakan.
symbols boolean \| undefined No Unduh simbol dari Microsoft Symbol Server untuk analisis crash asli yang lebih kaya. Hanya digunakan dengan --debug-output. Pada jalankan pertama, simbol diunduh dan disimpan secara lokal; pada jalankan berikutnya, cache digunakan.
unregisterOnExit boolean \| undefined No Batalkan pendaftaran paket pengembangan setelah aplikasi keluar. Hanya menghapus paket yang terdaftar dalam mode pengembangan.
withAlias boolean \| undefined No Luncurkan aplikasi menggunakan alias eksekusinya alih-alih aktivasi AUMID. Aplikasi berjalan di terminal saat ini dengan stdin/stdout/stderr yang diwariskan. Memerlukan uap5:ExecutionAlias dalam manifest. Gunakan "winapp manifest add-alias" untuk menambahkan alias eksekusi ke manifes.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

SignOptions

Harta benda Tipe Required Deskripsi
filePath string Yes Jalur ke file/paket yang akan ditandatangani
certPath string Yes Jalur ke file sertifikat (format PFX)
password string \| undefined No Kata sandi sertifikat
timestamp string \| undefined No URL server tanda waktu
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

StoreOptions

Harta benda Tipe Required Deskripsi
storeArgs string[] \| undefined No Argumen untuk diteruskan ke CLI Pengembang Microsoft Store.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

ToolOptions

Harta benda Tipe Required Deskripsi
toolArgs string[] \| undefined No Argumen untuk diteruskan ke alat SDK, contohnya ['makeappx', 'pack', '/d', './folder', '/p', './out.msix'].
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiClickOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
double boolean \| undefined No Lakukan klik ganda alih-alih satu klik
json boolean \| undefined No Format output sebagai JSON
right boolean \| undefined No Lakukan klik kanan alih-alih klik kiri
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiFocusOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiGetFocusedOptions

Harta benda Tipe Required Deskripsi
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiGetPropertyOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
property string \| undefined No Nama properti untuk dibaca atau disaring
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiGetValueOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiInspectOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
ancestors boolean \| undefined No Berjalan ke atas pohon dari elemen yang ditentukan ke akar
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
depth number \| undefined No Kedalaman pemeriksaan pohon
hideDisabled boolean \| undefined No Sembunyikan elemen yang dinonaktifkan dari output
hideOffscreen boolean \| undefined No Sembunyikan elemen di luar layar dari output
interactive boolean \| undefined No Tampilkan hanya elemen interaktif/yang dapat dipanggil (tombol, tautan, input, item daftar). Meningkatkan kedalaman default menjadi 8.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiInvokeOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiListWindowsOptions

Harta benda Tipe Required Deskripsi
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiScreenshotOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
captureScreen boolean \| undefined No Tangkap dari layar (termasuk popup/overlay) bukan rendering jendela. Membawa jendela ke latar depan terlebih dahulu.
json boolean \| undefined No Format output sebagai JSON
output string \| undefined No Simpan output ke jalur file (misalnya, cuplikan layar)
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiScrollOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
direction string \| undefined No Arah gulir: atas, bawah, kiri, kanan
json boolean \| undefined No Format output sebagai JSON
to string \| undefined No Gulir ke posisi: atas, bawah
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiScrollIntoViewOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiSearchOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
max number \| undefined No Hasil pencarian maksimum
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiSetValueOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
value string \| undefined No Nilai yang akan diatur (teks untuk TextBox/ComboBox, angka untuk Slider)
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (default ke process.cwd()).

UiStatusOptions

Harta benda Tipe Required Deskripsi
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
json boolean \| undefined No Format output sebagai JSON
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan keluaran yang lebih rinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara otomatis menggunakan process.cwd() sebagai default).

UiWaitForOptions

Harta benda Tipe Required Deskripsi
selector string \| undefined No Slug semantik (misalnya, btn-minimize-d1a0) atau teks untuk mencari berdasarkan nama/automationId
app string \| undefined No Aplikasi target (nama proses, judul jendela, atau PID). Menampilkan daftar jendela jika ambigu.
contains boolean \| undefined No Gunakan pencocokan substring untuk --value alih-alih kecocokan persis
gone boolean \| undefined No Tunggu hingga elemen menghilang alih-alih muncul
json boolean \| undefined No Format output sebagai JSON
property string \| undefined No Nama properti untuk dibaca atau disaring
timeout number \| undefined No Batas waktu dalam milidetik
value string \| undefined No Tunggu nilai elemen sama dengan string ini. Menggunakan fallback cerdas (TextPattern -> ValuePattern -> Name). Gabungkan dengan --property untuk memeriksa properti tertentu sebagai gantinya.
window number \| undefined No Jendela target menurut HWND (pegangan stabil dari keluaran daftar). Lebih diutamakan daripada --app.
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan output verbose.
cwd string \| undefined No Direktori kerja untuk proses Command Line Interface (CLI) (secara default ke process.cwd()).

UnregisterOptions

Harta benda Tipe Required Deskripsi
force boolean \| undefined No Lewati pemeriksaan direktori lokasi penginstalan dan batalkan pendaftaran meskipun paket terdaftar dari pohon proyek yang berbeda
json boolean \| undefined No Format output sebagai JSON
manifest string \| undefined No Jalur ke Package.appxmanifest (default: deteksi otomatis dari direktori saat ini)
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan output terperinci.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara default menggunakan process.cwd()).

UpdateOptions

Harta benda Tipe Required Deskripsi
setupSdks SdkInstallMode \| undefined No Mode penginstalan SDK: 'stabil' (default), 'pratinjau', 'eksperimental', atau 'tidak ada' (lewati penginstalan SDK)
quiet boolean \| undefined No Sembunyikan pesan kemajuan.
verbose boolean \| undefined No Aktifkan output verbose.
cwd string \| undefined No Direktori kerja untuk proses CLI (secara default ke process.cwd()).
  • Last updated on