Pakiet NPM — interfejs API programowy

Dla @microsoft/winappcli jest to odniesienie API TypeScript/JavaScript. Każde polecenie interfejsu wiersza polecenia jest dostępne jako funkcja asynchronizna, która przechwytuje stdout/stderr i zwraca wpisany wynik. Narzędzia pomocnicze do obsługi tożsamości MSIX, debugowania Electron oraz narzędzi do kompilacji są również eksportowane.

Instalacja

npm install @microsoft/winappcli

Szybki start

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

Typowe typy

Każde opakowanie polecenia CLI akceptuje obiekt opcji rozszerzający CommonOptions i zwraca Promise<WinappResult>.

CommonOptions

Opcje podstawowe współużytkowane przez większość poleceń.

Majątek Typ Obowiązkowy Description
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

WinappResult

Wynik zwracany przez każde opakowanie poleceń.

Majątek Typ Obowiązkowy Description
exitCode number Yes Przetwarzanie kodu zakończenia (zawsze 0 w przypadku powodzenia — niezerowe rzuty).
stdout string Yes Przechwycone standardowe dane wyjściowe.
stderr string Yes Przechwycony standardowy błąd.

Narzędzia opakowujące polecenia interfejsu wiersza polecenia

Te funkcje opakowują natywne winapp polecenia CLI. Wszystkie akceptują commonOptions (quiet, verbose, cwd).

certGenerate()

Utwórz certyfikat z podpisem własnym tylko do testowania lokalnego. Publisher musi być zgodna z manifestem (automatycznie wnioskowane, jeśli plik --manifest dostarczony lub Package.appxmanifest znajduje się w katalogu roboczym). Dane wyjściowe: devcert.pfx (hasło domyślne: "hasło"). W przypadku środowiska produkcyjnego uzyskaj certyfikat z zaufanego urzędu certyfikacyjnego. Użyj polecenia "cert install", aby ustanowić zaufanie do tego komputera.

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

Opcje:

Majątek Typ Obowiązkowy Description
exportCer boolean \| undefined No Eksportowanie pliku .cer (tylko klucz publiczny) obok pliku pfx
ifExists IfExists \| undefined No Postępowanie, gdy plik wyjściowy istnieje: "błąd" (niepowodzenie, ustawienie domyślne), "pomiń" (zachowaj istniejący) lub "zastąp" (zamień)
install boolean \| undefined No Zainstaluj certyfikat w lokalnym magazynie komputera po wygenerowaniu
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest lub appxmanifest.xml, aby wyodrębnić informacje o wydawcy z niego
output string \| undefined No Ścieżka wyjściowa wygenerowanego pliku PFX
password string \| undefined No Hasło wygenerowanego pliku PFX
publisher string \| undefined No Nazwa wydawcy dla wygenerowanego certyfikatu. Jeśli nie jest określony, zostanie wywnioskowany z manifestu.
validDays number \| undefined No Liczba dni ważności certyfikatu

Akceptuje również CommonOptions (quiet, verbose, cwd).

certInfo()

Wyświetl szczegóły certyfikatu (temat, odcisk palca, wygaśnięcie). Przydatne do weryfikowania certyfikatu zgodnego z manifestem przed podpisaniem.

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

Opcje:

Majątek Typ Obowiązkowy Description
certPath string Yes Ścieżka do pliku certyfikatu (PFX)
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
password string \| undefined No Hasło do pliku PFX

Akceptuje również CommonOptions (quiet, verbose, cwd).

certInstall()

Ufaj certyfikatowi na tym komputerze (wymaga administratora). Uruchom przed zainstalowaniem pakietów MSIX podpisanych certyfikatami dewelopera. Przykład: winapp cert install ./devcert.pfx. Wymagane tylko raz dla każdego certyfikatu.

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

Opcje:

Majątek Typ Obowiązkowy Description
certPath string Yes Ścieżka do pliku certyfikatu (PFX lub CER)
force boolean \| undefined No Wymuszanie instalacji, nawet jeśli certyfikat już istnieje
password string \| undefined No Hasło do pliku PFX

Akceptuje również CommonOptions (quiet, verbose, cwd).

createDebugIdentity()

Włącz tożsamość pakietu na potrzeby debugowania bez tworzenia pełnego pliku MSIX. Wymagane do testowania interfejsów API Windows (powiadomień push, docelowego punktu udostępniania itp.) podczas rozwijania. Przykład: winapp create-debug-identity ./myapp.exe. Wymaga pliku Package.appxmanifest lub appxmanifest.xml w bieżącym katalogu lub przekazywane za pośrednictwem --manifestu. Uruchom ponownie po zmianie manifestu lub zasobów/.

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

Opcje:

Majątek Typ Obowiązkowy Description
entrypoint string \| undefined No Ścieżka do pliku .exe, który musi być uruchomiony z użyciem określonej tożsamości lub jako skrypt punktu wejścia.
keepIdentity boolean \| undefined No Zachowaj tożsamość pakietu z manifestu as-is, bez dołączania ciągu ".debug" do nazwy pakietu i identyfikatora aplikacji.
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest lub appxmanifest.xml
noInstall boolean \| undefined No Nie instaluj pakietu po utworzeniu.

Akceptuje również CommonOptions (quiet, verbose, cwd).

createExternalCatalog()

Generuje plik wykazu CodeIntegrityExternal.cat z skrótami plików wykonywalnych z określonych katalogów. Używany z flagą TrustedLaunch w manifestach pakietów rozrzedzanych MSIX (AllowExternalContent), aby umożliwić wykonywanie plików zewnętrznych, które nie są uwzględnione w pakiecie.

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

Opcje:

Majątek Typ Obowiązkowy Description
inputFolder string Yes Lista folderów wejściowych z plikami wykonywalnymi do przetworzenia (oddzielonych średnikami)
computeFlatHashes boolean \| undefined No Dołącz płaskie skróty podczas generowania katalogu
ifExists IfExists \| undefined No Zachowanie, gdy plik wyjściowy już istnieje
output string \| undefined No Ścieżka pliku katalogu wyjściowego. Jeśli nie zostanie określona, zostanie użyta domyślna nazwa CodeIntegrityExternal.cat.
recursive boolean \| undefined No Dołączanie plików z podkatalogów
usePageHashes boolean \| undefined No Dołączanie skrótów stron podczas generowania wykazu

Akceptuje również opcja CommonOptions (quiet, verbose, cwd).

getWinappPath()

Wydrukuj ścieżkę do katalogu .winapp. Użyj --global dla lokalizacji udostępnionej pamięci podręcznej lub pomiń folder .winapp projektu lokalnego. Przydatne w przypadku skryptów kompilacji, które muszą odwoływać się do zainstalowanych pakietów.

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

Opcje:

Majątek Typ Obowiązkowy Description
global boolean \| undefined No Pobierz globalny katalog .winapp zamiast lokalnego

Akceptuje również CommonOptions (quiet, verbose, cwd).

init()

Zacznij tutaj, aby zainicjować aplikację Windows z wymaganą konfiguracją. Konfiguruje wszystko, co jest potrzebne do tworzenia aplikacji Windows: tworzy plik Package.appxmanifest z domyślnymi elementami zawartości, pobiera pakiety Windows SDK i Zestaw SDK do aplikacji systemu Windows oraz generuje projekcje. Gdy pakiety zestawu SDK są zarządzane (--setup-sdks stable/preview/experimental), tworzy również plik winapp.yaml do przypinania wersji polecenia "restore"/"update"; w przypadku braków --setup-sdks (np. dla projektów Rust/Tauri, które przynoszą własne powiązania zestawu SDK), nie jest tworzony żaden plik winapp.yaml. Domyślnie interaktywny (użyj --use-defaults, aby pominąć monity). Zamiast tego użyj polecenia "restore", jeśli sklonujesz repozytorium, które ma już plik winapp.yaml. Użyj polecenia "manifest generate", jeśli potrzebujesz tylko manifestu lub "cert generate", jeśli potrzebujesz certyfikatu programistycznego do podpisywania kodu.

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

Opcje:

Majątek Typ Obowiązkowy Description
baseDirectory string \| undefined No Katalog podstawowy/główny dla obszaru roboczego winapp, do użycia lub instalacji.
configDir string \| undefined No Katalog do odczytu/przechowywania konfiguracji (ustawienie domyślne: bieżący katalog)
configOnly boolean \| undefined No Obsługiwać tylko operacje na plikach konfiguracyjnych (utwórz, jeśli brak, sprawdź, czy istnieją). Pomiń kroki instalacji pakietu i innych kroków konfiguracji obszaru roboczego.
ignoreConfig boolean \| undefined No Nie używaj pliku konfiguracji do zarządzania wersjami
noGitignore boolean \| undefined No Nie aktualizuj pliku .gitignore
setupSdks SdkInstallMode \| undefined No Tryb instalacji zestawu SDK: "stable" (ustawienie domyślne), "preview", "experimental" lub "none" (pomiń instalację zestawu SDK)
useDefaults boolean \| undefined No Nie monituj i użyj wartości domyślnej wszystkich monitów

Obsługuje również CommonOptions (quiet, verbose, cwd).

manifestAddAlias()

Dodaj alias wykonywania (uap5:AppExecutionAlias) do pliku Package.appxmanifest. Umożliwia to uruchomienie spakowanej aplikacji z wiersza polecenia przez wpisanie nazwy aliasu. Domyślnie alias jest wnioskowany z atrybutu Wykonywalnego (np. $targetnametoken$.exe staje się aliasem $targetnametoken$.exe).

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

Opcje:

Majątek Typ Obowiązkowy Description
appId string \| undefined No Identyfikator aplikacji, do którego zostanie dodany alias (domyślnie: pierwszy element aplikacji)
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest lub appxmanifest.xml (domyślnie: wyszukaj bieżący katalog)
name string \| undefined No Nazwa aliasu (np. 'myapp.exe'). Ustawienie domyślne: wnioskowane z atrybutu Wykonywalnego w manifeście.

Akceptuje również CommonOptions (quiet, verbose, cwd).

manifestGenerate()

Utwórz plik Package.appxmanifest bez pełnej konfiguracji projektu. Użyj, gdy potrzebujesz tylko manifestu i grafik (bez pakietów SDK, bez certyfikatu). W przypadku pełnej konfiguracji należy zamiast tego użyć polecenia "init". Szablony: "pakietowy" (pełne MSIX), "rzadszy" (aplikacja klasyczna wymagająca interfejsów API Windows).

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

Opcje:

Majątek Typ Obowiązkowy Description
directory string \| undefined No Katalog do generowania manifestu w programie
description string \| undefined No Czytelny dla człowieka opis aplikacji wyświetlany podczas instalacji i w ustawieniach Windows
executable string \| undefined No Ścieżka do pliku wykonywalnego aplikacji. Domyślnie: <nazwa-pakietu>.exe
ifExists IfExists \| undefined No Zachowanie, gdy plik wyjściowy istnieje: "błąd" (niepowodzenie, ustawienie domyślne), "pomiń" (zachowaj istniejącą) lub "zastąp" (zamień)
logoPath string \| undefined No Ścieżka do pliku z obrazem logo
packageName string \| undefined No Nazwa pakietu (domyślna: nazwa folderu)
publisherName string \| undefined No Publisher CN (wartość domyślna: CN=<bieżący użytkownik>)
template ManifestTemplates \| undefined No Typ szablonu manifestu: "pakietowane" (pełna aplikacja MSIX, wartość domyślna) lub "rzadki" (aplikacja desktopowa z tożsamością pakietu dla interfejsów API Windows)
version string \| undefined No Wersja aplikacji w formacie Major.Minor.Build.Revision (np. 1.0.0.0).

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

manifestUpdateAssets()

Wygeneruj nowe zasoby dla obrazów, do których odwołuje się plik Package.appxmanifest z pojedynczego obrazu źródłowego. Obraz źródłowy powinien mieć co najmniej 400 x 400 pikseli.

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

Opcje:

Majątek Typ Obowiązkowy Description
imagePath string Yes Ścieżka do pliku obrazu źródłowego (SVG, PNG, ICO, JPG, BMP, GIF)
lightImage string \| undefined No Ścieżka do obrazu źródłowego dla wariantów motywu jasnego (SVG, PNG, ICO, JPG, BMP, GIF)
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest lub appxmanifest.xml (domyślnie: wyszukaj bieżący katalog)

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

packageApp()

Utwórz instalator MSIX na podstawie utworzonej aplikacji. Uruchom po zbudowaniu aplikacji. Manifest (Package.appxmanifest lub appxmanifest.xml) jest wymagany do pakowania — musi znajdować się w bieżącym katalogu roboczym, przekazywany jako --manifest lub znajdować się w folderze wejściowym. Użyj --cert devcert.pfx, aby podpisać się do testowania. Przykład: winapp package ./dist --manifest Package.appxmanifest --cert ./devcert.pfx

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

Opcje:

Majątek Typ Obowiązkowy Description
inputFolder string Yes Folder wejściowy z układem pakietu
cert string \| undefined No Ścieżka do certyfikatu podpisywania (w przypadku podania funkcji automatycznego podpisywania)
certPassword string \| undefined No Hasło certyfikatu (domyślne: hasło)
executable string \| undefined No Ścieżka do pliku wykonywalnego względem folderu wejściowego.
generateCert boolean \| undefined No Generowanie nowego certyfikatu programistycznego
installCert boolean \| undefined No Instalowanie certyfikatu na komputerze
manifest string \| undefined No Ścieżka do pliku manifestu AppX (ustawienie domyślne: automatyczne wykrywanie z folderu wejściowego lub bieżącego katalogu)
name string \| undefined No Nazwa pakietu (wartość domyślna: z manifestu)
output string \| undefined No Nazwa pliku msix wyjściowego dla wygenerowanego pakietu (domyślnie <name><version><arch>.msix, powracając do <name>><arch.msix> lub <name.msix>, gdy nie można ustalić wersji/architektury)
publisher string \| undefined No Nazwa wydawcy do generowania certyfikatów
selfContained boolean \| undefined No Pakietowanie środowiska uruchomieniowego Zestaw SDK do aplikacji systemu Windows na potrzeby samodzielnego wdrażania
skipPri boolean \| undefined No Pomiń generowanie plików PRI

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

restore()

Użyj polecenia po sklonowaniu repozytorium lub gdy brakuje folderu .winapp/. Ponownie instaluje pakiety zestawu SDK z istniejącego pliku winapp.yaml bez zmieniania wersji. Wymaga pliku winapp.yaml (utworzonego przez 'init'). Aby sprawdzić nowsze wersje zestawu SDK, zamiast tego użyj polecenia "update".

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

Opcje:

Majątek Typ Obowiązkowy Description
baseDirectory string \| undefined No Katalog podstawowy/główny dla obszaru roboczego winapp
configDir string \| undefined No Katalog do odczytu konfiguracji z (ustawienie domyślne: bieżący katalog)

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

run()

Tworzy pakietowy układ, rejestruje aplikację i uruchamia spakowaną aplikację.

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

Opcje:

Majątek Typ Obowiązkowy Description
inputFolder string Yes Folder wejściowy zawierający aplikację do uruchomienia
args string \| undefined No Argumenty wiersza poleceń przekazywane aplikacji
clean boolean \| undefined No Przed ponownym wdrożeniem usuń dane aplikacji istniejącego pakietu (LocalState, ustawienia itp.). Domyślnie dane aplikacji są zachowywane w ramach ponownych wdrożeń.
debugOutput boolean \| undefined No Przechwyć komunikaty OutputDebugString i pierwszorzędne wyjątki z uruchomionej aplikacji. Tylko jeden debuger może dołączać do procesu w danym momencie, więc inne debugery (Visual Studio, VS Code) nie mogą być używane jednocześnie. Użyj --no-launch zamiast tego, jeśli musisz dołączyć inny debuger. Nie można połączyć z --no-launch ani --json.
detach boolean \| undefined No Uruchom aplikację i natychmiast powróć bez oczekiwania na jej zamknięcie. Przydatne do CI/automatyzacji, gdzie musisz wchodzić w interakcję z aplikacją po jej uruchomieniu. Drukuje PID do stdout (lub w formacie JSON przy użyciu --json).
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest (ustawienie domyślne: automatyczne wykrywanie z folderu wejściowego lub bieżącego katalogu)
noLaunch boolean \| undefined No Twórz tylko tożsamość debugowania i rejestruj pakiet bez uruchamiania aplikacji
outputAppxDirectory string \| undefined No Katalog wyjściowy dla luźnego pakietu layoutu. Jeśli nie zostanie określony, zostanie użyty katalog o nazwie AppX wewnątrz katalogu input-folder.
symbols boolean \| undefined No Pobierz symbole z serwera symboli Microsoft, aby uzyskać bogatszą analizę awarii natywnej. Używane tylko z --debug-output. Pierwsze uruchomienie pobiera symbole i zapisuje je w pamięci podręcznej lokalnie; kolejne uruchomienia korzystają z tej pamięci podręcznej.
unregisterOnExit boolean \| undefined No Wyrejestrowywanie pakietu programistycznego po zakończeniu działania aplikacji. Usuwa tylko pakiety zarejestrowane w trybie programowania.
withAlias boolean \| undefined No Uruchom aplikację przy użyciu aliasu uruchamiania zamiast aktywacji za pomocą identyfikatora AUMID. Aplikacja działa w bieżącym terminalu z dziedziczonymi stdin/stdout/stderr. Wymaga elementu uap5:ExecutionAlias w manifeście. Użyj polecenia "winapp manifest add-alias", aby dodać alias uruchamiania do manifestu.

Akceptuje również CommonOptions (quiet, verbose, cwd).

sign()

Podpisywanie kodu pakietu MSIX lub pliku wykonywalnego. Przykład: winapp sign ./app.msix ./devcert.pfx. Użyj znacznika --timestamp dla kompilacji produkcyjnych, aby zachować ważność po wygaśnięciu certyfikatu. Polecenie "package" może podpisywać się automatycznie za pomocą polecenia --cert.

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

Opcje:

Majątek Typ Obowiązkowy Description
filePath string Yes Ścieżka do pliku/pakietu w celu podpisania
certPath string Yes Ścieżka do pliku certyfikatu (format PFX)
password string \| undefined No Hasło certyfikatu
timestamp string \| undefined No Adres URL serwera sygnatury czasowej

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

store()

Uruchom polecenie Microsoft Store Developer CLI. To polecenie spowoduje pobranie deweloperskiego interfejsu wiersza polecenia Microsoft Store, jeśli nie został jeszcze pobrany. Dowiedz się więcej o CLI (interfejsie wiersza polecenia) dla deweloperów Microsoft Store tutaj: https://aka.ms/msstoredevcli

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

Opcje:

Majątek Typ Obowiązkowy Description
storeArgs string[] \| undefined No Argumenty przekazywane do interfejsu wiersza polecenia dewelopera Microsoft Store.

Akceptuje również CommonOptions (quiet, verbose, cwd).

tool()

Uruchom narzędzia zestawu SDK Windows bezpośrednio (makeappx, signtool, makepri itp.). W razie potrzeby automatycznie pobiera narzędzia kompilacji. W przypadku większości zadań preferuj polecenia wyższego poziomu, takie jak "package" lub "sign". Przykład: narzędzie winapp makeappx pack /d ./folder /p ./out.msix

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

Opcje:

Majątek Typ Obowiązkowy Description
toolArgs string[] \| undefined No Argumenty do przekazania do narzędzia SDK, np. ['makeappx', 'pack', '/d', './folder', '/p', './out.msix'].

Akceptuje również CommonOptions (quiet, verbose, cwd).

uiClick()

Kliknij element, używając wyszukiwania tekstu lub ślimaka przy użyciu symulacji myszy. Działa na elementach, które nie obsługują elementu InvokePattern (np. nagłówki kolumn, elementy listy). Użyj --double, aby wykonać dwukrotne kliknięcie, --right, aby wykonać kliknięcie prawym przyciskiem.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wyświetla listę okien w przypadku niejednoznaczności.
double boolean \| undefined No Wykonaj dwukrotne kliknięcie zamiast jednego kliknięcia
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
right boolean \| undefined No Wykonaj kliknięcie prawym przyciskiem myszy zamiast kliknięcia po lewej stronie
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również CommonOptions (quiet, verbose, cwd).

uiFocus()

Przenieś fokus klawiatury do określonego elementu przy użyciu funkcji UIA SetFocus.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wypisuje okna, jeśli są niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilny uchwyt z wyjścia listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiGetFocused()

Pokaż element, który aktualnie ma fokus klawiatury w aplikacji docelowej.

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

Opcje:

Majątek Typ Obowiązkowy Description
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiGetProperty()

Odczytywanie wartości właściwości UIA z elementu. Określ właściwość --dla pojedynczej właściwości lub pomiń dla wszystkich.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
property string \| undefined No Nazwa właściwości do odczytu lub filtrowania
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiGetValue()

Odczytaj bieżącą wartość z elementu. Próbuje TextPattern (RichEditBox, Document), ValuePattern (TextBox, ComboBox, Slider), a następnie Name (etykiety). Użycie: winapp ui get-value <selector> -a <app>

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiInspect()

Wyświetl drzewo elementów interfejsu użytkownika z slugami semantycznymi, typami elementów, nazwami i granicami.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
ancestors boolean \| undefined No Przejdź w górę drzewa z określonego elementu do korzenia
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
depth number \| undefined No Głębokość inspekcji drzewa
hideDisabled boolean \| undefined No Ukryj wyłączone elementy z danych wyjściowych
hideOffscreen boolean \| undefined No Ukryj elementy niewidoczne na ekranie w danych wyjściowych
interactive boolean \| undefined No Pokaż tylko elementy interakcyjne/wywoływane (przyciski, linki, dane wejściowe, elementy listy). Zwiększa domyślną głębokość do 8.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiInvoke()

Uaktywnij element za pomocą wyszukiwania slug lub tekstu. Próbuje InvokePattern, TogglePattern, SelectionItemPattern i ExpandCollapsePattern w kolejności.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiListWindows()

Wyświetl listę wszystkich widocznych okien wraz z ich HWND, tytułami, procesami i rozmiarami. Użyj -a, aby filtrować według nazwy aplikacji. Użyj HWND z -w, aby celować w konkretne okno.

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

Opcje:

Majątek Typ Obowiązkowy Description
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiScreenshot()

Przechwyć okno lub element docelowy jako obraz PNG. Gdy istnieje wiele okien (np. okien dialogowych), przechwytuje każdy z nich do oddzielnego pliku. W pliku --json zwraca ścieżkę pliku i wymiary. Użyj --capture-screen do nakładek typu popup.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
captureScreen boolean \| undefined No Przechwytywanie z ekranu (obejmuje wyskakujące okienka/nakładki) zamiast renderowania okien. Najpierw przenosi okno na pierwszy plan.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
output string \| undefined No Zapisz dane wyjściowe w ścieżce pliku (np. zrzut ekranu)
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiScroll()

Przewiń element kontenera przy użyciu ScrollPattern. Użyj '--direction', aby przewinąć przyrostowo, lub '--to', aby skoczyć do góry/dołu.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
direction string \| undefined No Kierunek przewijania: w górę, w dół, w lewo, w prawo
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
to string \| undefined No Przewiń do pozycji: góra, dół
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiScrollIntoView()

Przewiń określony element do widocznego obszaru, używając wzorca ScrollItemPattern dla UIA.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiSearch()

Przeszukaj drzewo elementów pod kątem elementów pasujących do zapytania tekstowego. Zwraca wszystkie dopasowania z slugami semantycznymi.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
max number \| undefined No Maksymalna liczba wyników wyszukiwania
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiSetValue()

Ustaw wartość elementu przy użyciu UIA ValuePattern. Działa dla TextBox, ComboBox, Slider i innych edytowalnych kontrolek. Użycie: winapp ui set-value <selektor><wartość> -a <aplikacja>

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
value string \| undefined No Wartość do ustawienia (tekst dla TextBox/ComboBox, liczba dla suwaka)
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiStatus()

Połącz się z aplikacją docelową i wyświetl informacje o połączeniu.

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

Opcje:

Majątek Typ Obowiązkowy Description
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

uiWaitFor()

Poczekaj, aż element pojawi się, zniknie lub właściwość osiągnie wartość docelową. Sondowanie w odstępach czasu 100 ms aż do spełnienia warunku lub przekroczenia limitu czasu.

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

Opcje:

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
contains boolean \| undefined No Użyj dopasowania części ciągu dla parametru --value zamiast dokładnego dopasowania
gone boolean \| undefined No Poczekaj, aż element zniknie zamiast pojawić się
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
property string \| undefined No Nazwa właściwości do odczytu lub filtrowania
timeout number \| undefined No Limit czasu w milisekundach
value string \| undefined No Poczekaj, aż wartość elementu będzie równa temu ciągowi. Używa inteligentnego rezerwowego rozwiązania (TextPattern —> ValuePattern —> Name). Połącz z --property, aby sprawdzić określoną właściwość zamiast.
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

unregister()

Wyrejestrowuje sideloadowany pakiet deweloperski. Usuwa tylko pakiety zarejestrowane w trybie programowania (np. za pomocą polecenia "winapp run" lub "create-debug-identity").

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

Opcje:

Majątek Typ Obowiązkowy Description
force boolean \| undefined No Pomiń sprawdzanie katalogu lokalizacji instalacji i wyrejestrowywanie, nawet jeśli pakiet został zarejestrowany z innego drzewa projektu
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest (ustawienie domyślne: automatyczne wykrywanie z bieżącego katalogu)

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

update()

Sprawdź i zainstaluj nowsze wersje zestawu SDK. Aktualizuje plik winapp.yaml z najnowszymi wersjami i ponownie instaluje pakiety. Wymaga istniejącego pliku winapp.yaml (utworzonego przez 'init'). Użyj opcji --setup-sdks preview dla zestawów SDK w wersji zapoznawczej. Aby ponownie zainstalować bieżące wersje bez aktualizowania, zamiast tego użyj polecenia "restore".

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

Opcje:

Majątek Typ Obowiązkowy Description
setupSdks SdkInstallMode \| undefined No Tryb instalacji zestawu SDK: "stable" (ustawienie domyślne), "preview", "experimental" lub "none" (pomiń instalację zestawu SDK)

Akceptuje również opcje CommonOptions (quiet, verbose, cwd).

Funkcje użytkowe

execWithBuildTools()

Wykonaj polecenie, dodając ścieżkę binarną BuildTools do zmiennej PATH

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

Parametry:

Parametr Typ Obowiązkowy Description
command string Yes Polecenie do wykonania
options ExecSyncOptions No Opcje przekazywania do narzędzia execSync (opcjonalnie)

Zwraca: Dane wyjściowe z execSync

addMsixIdentityToExe()

Dodaje informacje o tożsamości pakietu z pliku appxmanifest.xml do osadzonego manifestu pliku wykonywalnego

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

Parametry:

Parametr Typ Obowiązkowy Description
exePath string Yes Ścieżka do pliku wykonywalnego
appxManifestPath string \| undefined No Ścieżka do pliku appxmanifest.xml zawierającego dane tożsamości pakietu
options MsixIdentityOptions No Opcjonalna konfiguracja

addElectronDebugIdentity()

Dodaje tożsamość pakietu do procesu debugowania Electron.

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

Parametry:

Parametr Typ Obowiązkowy Description
options MsixIdentityOptions No Opcje konfiguracji

clearElectronDebugIdentity()

Czyści/usuwa tożsamość pakietu z procesu debugowania Electron poprzez przywrócenie z kopii zapasowej

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

Parametry:

Parametr Typ Obowiązkowy Description
options MsixIdentityOptions No Opcje konfiguracji

getGlobalWinappPath()

Pobieranie ścieżki do globalnego katalogu ".winapp"

function getGlobalWinappPath(): string

Zwraca: Pełna ścieżka do globalnego katalogu .winapp

getLocalWinappPath()

Uzyskaj ścieżkę do lokalnego katalogu .winapp

function getLocalWinappPath(): string

Zwraca: Pełna ścieżka do lokalnego katalogu .winapp

Node.js polecenia CLI

Te polecenia są dostępne wyłącznie za pośrednictwem programu npx winapp node <subcommand> i nie są eksportowane jako funkcje programowe.

node create-addon

Generowanie natywnych plików dodatków dla projektu Electron. Obsługuje szablony języka C++ (node-gyp) i C# (node-api-dotnet).

npx winapp node create-addon [options]

Opcje:

Flaga Description
--name <name> Nazwa dodatku (wartość domyślna zależy od szablonu)
--template <type> Szablon dodatku: cpp lub cs (ustawienie domyślne: cpp)
--verbose Włączanie pełnych danych wyjściowych

Uwaga: Należy uruchomić z katalogu głównego projektu Electron (katalog zawierający package.json).

Przykłady:

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

Dodaj tożsamość pakietu do procesu debugowania Electron, korzystając z rozrzedzonego pakietowania. Tworzy kopię zapasową electron.exe pliku, generuje rozrzedzony manifest MSIX, dodaje identyfikator do pliku wykonywalnego i rejestruje rozrzedzony pakiet. Wymaga elementu Package.appxmanifest (utwórz element z elementem winapp init lub winapp manifest generate).

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

Opcje:

Flaga Description
--manifest <path> Ścieżka do niestandardowego Package.appxmanifest (wartość domyślna: Package.appxmanifest w bieżącym katalogu)
--no-install Nie instaluj pakietu po utworzeniu
--keep-identity Zachowaj tożsamość manifestu w niezmienionej formie, bez dołączania sufiksu .debug
--verbose Włączanie pełnych danych wyjściowych

Uwaga: Należy uruchomić z katalogu głównego projektu Electron (katalog zawierający element node_modules/electron). Aby cofnąć, użyj npx winapp node clear-electron-debug-identity.

Przykłady:

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

node clear-electron-debug-identity

Usuń tożsamość pakietu z procesu debugowania Electron. Przywraca electron.exe z kopii zapasowej utworzonej przez add-electron-debug-identity i usuwa pliki kopii zapasowej.

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

Opcje:

Flaga Description
--verbose Włączanie pełnych danych wyjściowych

Uwaga: Należy uruchomić polecenie z katalogu głównego projektu Electron (katalog zawierający node_modules/electron).

Przykłady:

npx winapp node clear-electron-debug-identity

Dokumentacja typów

ExecSyncOptions

Ponownie wyeksportowane z Node.js dla wygody. Zobacz dokumentacjęNode.js.

MsixIdentityOptions

Majątek Typ Obowiązkowy Description
verbose boolean \| undefined No
noInstall boolean \| undefined No
keepIdentity boolean \| undefined No
manifest string \| undefined No

MsixIdentityResult

Majątek Typ Obowiązkowy Description
success boolean Yes

ElectronDebugIdentityResult

Majątek Typ Obowiązkowy Description
success boolean Yes
electronExePath string Yes
backupPath string Yes
manifestPath string Yes
assetsDir string Yes

ClearElectronDebugIdentityResult

Majątek Typ Obowiązkowy Description
success boolean Yes
electronExePath string Yes
restoredFromBackup boolean Yes

CallWinappCliOptions

Majątek Typ Obowiązkowy Description
exitOnError boolean \| undefined No

CallWinappCliResult

Majątek Typ Obowiązkowy Description
exitCode number Yes

CallWinappCliCaptureOptions

Majątek Typ Obowiązkowy Description
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd())

CallWinappCliCaptureResult

Majątek Typ Obowiązkowy Description
exitCode number Yes
stdout string Yes
stderr string Yes

GenerateCppAddonOptions

Majątek Typ Obowiązkowy Description
name string \| undefined No
projectRoot string \| undefined No
verbose boolean \| undefined No

GenerateCppAddonResult

Majątek Typ Obowiązkowy Description
success boolean Yes
addonName string Yes
addonPath string Yes
needsTerminalRestart boolean Yes
files string[] Yes

GenerateCsAddonOptions

Majątek Typ Obowiązkowy Description
name string \| undefined No
projectRoot string \| undefined No
verbose boolean \| undefined No

GenerateCsAddonResult

Majątek Typ Obowiązkowy Description
success boolean Yes
addonName string Yes
addonPath string Yes
needsTerminalRestart boolean Yes
files string[] Yes

IfExists

IfExists wartości.

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

SdkInstallMode

Wartości SdkInstallMode.

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

ManifestTemplates

Wartości ManifestTemplates.

type ManifestTemplates = "packaged" | "sparse"

CertGenerateOptions

Majątek Typ Obowiązkowy Description
exportCer boolean \| undefined No Eksportowanie pliku .cer (tylko klucz publiczny) obok pliku pfx
ifExists IfExists \| undefined No Zachowanie, gdy plik wyjściowy istnieje: "błąd" (niepowodzenie, ustawienie domyślne), "pomiń" (zachowaj istniejącą) lub "zastąp" (zamień)
install boolean \| undefined No Zainstaluj certyfikat w lokalnym magazynie komputera po wygenerowaniu
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest lub appxmanifest.xml, aby wyodrębnić informacje o wydawcy z niego
output string \| undefined No Ścieżka wyjściowa wygenerowanego pliku PFX
password string \| undefined No Hasło wygenerowanego pliku PFX
publisher string \| undefined No Nazwa wydawcy dla wygenerowanego certyfikatu. Jeśli nie jest określony, zostanie wywnioskowany z manifestu.
validDays number \| undefined No Liczba dni ważności certyfikatu
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

CertInfoOptions

Majątek Typ Obowiązkowy Description
certPath string Yes Ścieżka do pliku certyfikatu (PFX)
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
password string \| undefined No Hasło do pliku PFX
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

CertInstallOptions

Majątek Typ Obowiązkowy Description
certPath string Yes Ścieżka do pliku certyfikatu (PFX lub CER)
force boolean \| undefined No Wymuszanie instalacji, nawet jeśli certyfikat już istnieje
password string \| undefined No Hasło do pliku PFX
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

CreateDebugIdentityOptions

Majątek Typ Obowiązkowy Description
entrypoint string \| undefined No Ścieżka do pliku .exe, który musi być uruchomiony z użyciem określonej tożsamości lub jako skrypt punktu wejścia.
keepIdentity boolean \| undefined No Zachowaj tożsamość pakietu z manifestu as-is, bez dołączania ciągu ".debug" do nazwy pakietu i identyfikatora aplikacji.
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest lub appxmanifest.xml
noInstall boolean \| undefined No Nie instaluj pakietu po utworzeniu.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

CreateExternalCatalogOptions

Majątek Typ Obowiązkowy Description
inputFolder string Yes Lista folderów wejściowych z plikami wykonywalnymi do przetworzenia (oddzielonych średnikami)
computeFlatHashes boolean \| undefined No Dołącz płaskie skróty podczas generowania katalogu
ifExists IfExists \| undefined No Zachowanie, gdy plik wyjściowy już istnieje
output string \| undefined No Ścieżka pliku katalogu wyjściowego. Jeśli nie zostanie określona, zostanie użyta domyślna nazwa CodeIntegrityExternal.cat.
recursive boolean \| undefined No Dołączanie plików z podkatalogów
usePageHashes boolean \| undefined No Dołączanie skrótów stron podczas generowania wykazu
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

GetWinappPathOptions

Majątek Typ Obowiązkowy Description
global boolean \| undefined No Pobierz globalny katalog .winapp zamiast lokalnego
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

InitOptions

Majątek Typ Obowiązkowy Description
baseDirectory string \| undefined No Katalog podstawowy/główny dla obszaru roboczego winapp, do użycia lub instalacji.
configDir string \| undefined No Katalog do odczytu/przechowywania konfiguracji (ustawienie domyślne: bieżący katalog)
configOnly boolean \| undefined No Obsługiwać tylko operacje na plikach konfiguracyjnych (utwórz, jeśli brak, sprawdź, czy istnieją). Pomiń kroki instalacji pakietu i innych kroków konfiguracji obszaru roboczego.
ignoreConfig boolean \| undefined No Nie używaj pliku konfiguracji do zarządzania wersjami
noGitignore boolean \| undefined No Nie aktualizuj pliku .gitignore
setupSdks SdkInstallMode \| undefined No Tryb instalacji zestawu SDK: "stable" (ustawienie domyślne), "preview", "experimental" lub "none" (pomiń instalację zestawu SDK)
useDefaults boolean \| undefined No Nie monituj i użyj wartości domyślnej wszystkich monitów
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

ManifestAddAliasOptions

Majątek Typ Obowiązkowy Description
appId string \| undefined No Identyfikator aplikacji, do którego zostanie dodany alias (domyślnie: pierwszy element aplikacji)
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest lub appxmanifest.xml (domyślnie: wyszukaj bieżący katalog)
name string \| undefined No Nazwa aliasu (np. 'myapp.exe'). Ustawienie domyślne: wnioskowane z atrybutu Wykonywalnego w manifeście.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

ManifestGenerateOptions

Majątek Typ Obowiązkowy Description
directory string \| undefined No Katalog do generowania manifestu w programie
description string \| undefined No Czytelny dla człowieka opis aplikacji wyświetlany podczas instalacji i w ustawieniach Windows
executable string \| undefined No Ścieżka do pliku wykonywalnego aplikacji. Domyślnie: <nazwa-pakietu>.exe
ifExists IfExists \| undefined No Zachowanie, gdy plik wyjściowy istnieje: "błąd" (niepowodzenie, ustawienie domyślne), "pomiń" (zachowaj istniejącą) lub "zastąp" (zamień)
logoPath string \| undefined No Ścieżka do pliku z obrazem logo
packageName string \| undefined No Nazwa pakietu (domyślna: nazwa folderu)
publisherName string \| undefined No Publisher CN (wartość domyślna: CN=<bieżący użytkownik>)
template ManifestTemplates \| undefined No Typ szablonu manifestu: "pakietowane" (pełna aplikacja MSIX, wartość domyślna) lub "rzadki" (aplikacja desktopowa z tożsamością pakietu dla interfejsów API Windows)
version string \| undefined No Wersja aplikacji w formacie Major.Minor.Build.Revision (np. 1.0.0.0).
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

ManifestUpdateAssetsOptions

Majątek Typ Obowiązkowy Description
imagePath string Yes Ścieżka do pliku obrazu źródłowego (SVG, PNG, ICO, JPG, BMP, GIF)
lightImage string \| undefined No Ścieżka do obrazu źródłowego dla wariantów motywu jasnego (SVG, PNG, ICO, JPG, BMP, GIF)
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest lub appxmanifest.xml (domyślnie: wyszukaj bieżący katalog)
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

PackageOptions

Majątek Typ Obowiązkowy Description
inputFolder string Yes Folder wejściowy z układem pakietu
cert string \| undefined No Ścieżka do certyfikatu podpisywania (w przypadku podania funkcji automatycznego podpisywania)
certPassword string \| undefined No Hasło certyfikatu (domyślne: hasło)
executable string \| undefined No Ścieżka do pliku wykonywalnego względem folderu wejściowego.
generateCert boolean \| undefined No Generowanie nowego certyfikatu programistycznego
installCert boolean \| undefined No Instalowanie certyfikatu na komputerze
manifest string \| undefined No Ścieżka do pliku manifestu AppX (ustawienie domyślne: automatyczne wykrywanie z folderu wejściowego lub bieżącego katalogu)
name string \| undefined No Nazwa pakietu (wartość domyślna: z manifestu)
output string \| undefined No Nazwa pliku msix wyjściowego dla wygenerowanego pakietu (domyślnie <name><version><arch>.msix, powracając do <name>><arch.msix> lub <name.msix>, gdy nie można ustalić wersji/architektury)
publisher string \| undefined No Nazwa wydawcy do generowania certyfikatów
selfContained boolean \| undefined No Pakietowanie środowiska uruchomieniowego Zestaw SDK do aplikacji systemu Windows na potrzeby samodzielnego wdrażania
skipPri boolean \| undefined No Pomiń generowanie plików PRI
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

RestoreOptions

Majątek Typ Obowiązkowy Description
baseDirectory string \| undefined No Katalog podstawowy/główny dla obszaru roboczego winapp
configDir string \| undefined No Katalog do odczytu konfiguracji z (ustawienie domyślne: bieżący katalog)
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

RunOptions

Majątek Typ Obowiązkowy Description
inputFolder string Yes Folder wejściowy zawierający aplikację do uruchomienia
args string \| undefined No Argumenty wiersza poleceń przekazywane aplikacji
clean boolean \| undefined No Przed ponownym wdrożeniem usuń dane aplikacji istniejącego pakietu (LocalState, ustawienia itp.). Domyślnie dane aplikacji są zachowywane w ramach ponownych wdrożeń.
debugOutput boolean \| undefined No Przechwyć komunikaty OutputDebugString i pierwszorzędne wyjątki z uruchomionej aplikacji. Tylko jeden debuger może dołączać do procesu w danym momencie, więc inne debugery (Visual Studio, VS Code) nie mogą być używane jednocześnie. Użyj --no-launch zamiast tego, jeśli musisz dołączyć inny debuger. Nie można połączyć z --no-launch ani --json.
detach boolean \| undefined No Uruchom aplikację i natychmiast powróć bez oczekiwania na jej zamknięcie. Przydatne do CI/automatyzacji, gdzie musisz wchodzić w interakcję z aplikacją po jej uruchomieniu. Drukuje PID do stdout (lub w formacie JSON przy użyciu --json).
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest (ustawienie domyślne: automatyczne wykrywanie z folderu wejściowego lub bieżącego katalogu)
noLaunch boolean \| undefined No Twórz tylko tożsamość debugowania i rejestruj pakiet bez uruchamiania aplikacji
outputAppxDirectory string \| undefined No Katalog wyjściowy dla luźnego pakietu layoutu. Jeśli nie zostanie określony, zostanie użyty katalog o nazwie AppX wewnątrz katalogu input-folder.
symbols boolean \| undefined No Pobierz symbole z serwera symboli Microsoft, aby uzyskać bogatszą analizę awarii natywnej. Używane tylko z --debug-output. Pierwsze uruchomienie pobiera symbole i zapisuje je w pamięci podręcznej lokalnie; kolejne uruchomienia korzystają z tej pamięci podręcznej.
unregisterOnExit boolean \| undefined No Wyrejestrowywanie pakietu programistycznego po zakończeniu działania aplikacji. Usuwa tylko pakiety zarejestrowane w trybie programowania.
withAlias boolean \| undefined No Uruchom aplikację przy użyciu aliasu uruchamiania zamiast aktywacji za pomocą identyfikatora AUMID. Aplikacja działa w bieżącym terminalu z dziedziczonymi stdin/stdout/stderr. Wymaga elementu uap5:ExecutionAlias w manifeście. Użyj polecenia "winapp manifest add-alias", aby dodać alias uruchamiania do manifestu.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

SignOptions

Majątek Typ Obowiązkowy Description
filePath string Yes Ścieżka do pliku/pakietu w celu podpisania
certPath string Yes Ścieżka do pliku certyfikatu (format PFX)
password string \| undefined No Hasło certyfikatu
timestamp string \| undefined No Adres URL serwera sygnatury czasowej
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

StoreOptions

Majątek Typ Obowiązkowy Description
storeArgs string[] \| undefined No Argumenty przekazywane do interfejsu wiersza polecenia dewelopera Microsoft Store.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

ToolOptions

Majątek Typ Obowiązkowy Description
toolArgs string[] \| undefined No Argumenty do przekazania do narzędzia SDK, np. ['makeappx', 'pack', '/d', './folder', '/p', './out.msix'].
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiClickOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
double boolean \| undefined No Wykonaj dwukrotne kliknięcie zamiast jednego kliknięcia
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
right boolean \| undefined No Wykonaj kliknięcie prawym przyciskiem myszy zamiast kliknięcia po lewej stronie
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiFocusOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiGetFocusedOptions

Majątek Typ Obowiązkowy Description
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiGetPropertyOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
property string \| undefined No Nazwa właściwości do odczytu lub filtrowania
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiGetValueOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiInspectOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
ancestors boolean \| undefined No Przejdź po drzewie z określonego elementu do korzenia
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
depth number \| undefined No Głębokość inspekcji drzewa
hideDisabled boolean \| undefined No Ukryj wyłączone elementy z danych wyjściowych
hideOffscreen boolean \| undefined No Ukryj elementy poza ekranem z danych wyjściowych
interactive boolean \| undefined No Pokaż tylko elementy interakcyjne/wywoływane (przyciski, linki, dane wejściowe, elementy listy). Zwiększa domyślną głębokość do 8.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiInvokeOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiListWindowsOptions

Majątek Typ Obowiązkowy Description
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiScreenshotOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
captureScreen boolean \| undefined No Przechwytywanie z ekranu (obejmuje wyskakujące okienka/nakładki) zamiast renderowania okien. Najpierw przenosi okno na pierwszy plan.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
output string \| undefined No Zapisz wynik w ścieżce pliku (np. zrzut ekranu)
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiScrollOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
direction string \| undefined No Kierunek przewijania: w górę, w dół, w lewo, w prawo
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
to string \| undefined No Przewiń do pozycji: góra, dół
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiScrollIntoViewOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiSearchOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
max number \| undefined No Maksymalna liczba wyników wyszukiwania
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiSetValueOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy/automationId
value string \| undefined No Wartość do ustawienia (tekst dla TextBox/ComboBox, liczba dla suwaka)
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiStatusOptions

Majątek Typ Obowiązkowy Description
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wykazuje okna, jeśli niejednoznaczne.
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
window number \| undefined No Okno docelowe według HWND (stabilne dojście z danych wyjściowych listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UiWaitForOptions

Majątek Typ Obowiązkowy Description
selector string \| undefined No Slug semantyczny (np. btn-minimize-d1a0) lub tekst do wyszukiwania według nazwy lub automationId
app string \| undefined No Aplikacja docelowa (nazwa procesu, tytuł okna lub PID). Wypisuje okna, jeśli są niejednoznaczne.
contains boolean \| undefined No Użyj dopasowania części ciągu dla parametru --value zamiast dokładnego dopasowania
gone boolean \| undefined No Poczekaj, aż element zniknie zamiast pojawić się
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
property string \| undefined No Nazwa właściwości do odczytu lub filtrowania
timeout number \| undefined No Limit czasu w milisekundach
value string \| undefined No Poczekaj, aż wartość elementu będzie równa temu ciągowi. Używa inteligentnego rezerwowego rozwiązania (TextPattern —> ValuePattern —> Name). Połącz z --property, aby sprawdzić określoną właściwość zamiast.
window number \| undefined No Okno docelowe według HWND (stabilny uchwyt z wyjściowej listy). Ma pierwszeństwo przed --app.
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UnregisterOptions

Majątek Typ Obowiązkowy Description
force boolean \| undefined No Pomiń sprawdzanie katalogu lokalizacji instalacji i wyrejestrowywanie, nawet jeśli pakiet został zarejestrowany z innego drzewa projektu
json boolean \| undefined No Formatuj dane wyjściowe w formacie JSON
manifest string \| undefined No Ścieżka do pliku Package.appxmanifest (ustawienie domyślne: automatyczne wykrywanie z bieżącego katalogu)
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).

UpdateOptions

Majątek Typ Obowiązkowy Description
setupSdks SdkInstallMode \| undefined No Tryb instalacji zestawu SDK: "stable" (ustawienie domyślne), "preview", "experimental" lub "none" (pomiń instalację zestawu SDK)
quiet boolean \| undefined No Pomijanie komunikatów o postępie.
verbose boolean \| undefined No Włącz pełne dane wyjściowe.
cwd string \| undefined No Katalog roboczy dla procesu CLI (domyślnie process.cwd()).
  • Last updated on