Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Справочник по TypeScript/JavaScript API для @microsoft/winappcli.
Каждая команда CLI доступна как асинхронная функция, которая фиксирует stdout/stderr и возвращает типизированный результат.
Вспомогательные утилиты для идентификации MSIX, идентификаторов отладки Electron и средств сборки также экспортируются.
Installation
npm install @microsoft/winappcli
Быстрый старт
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' });
Общие типы
Каждая обертка команды CLI принимает объект options, который расширяет CommonOptions и возвращает Promise<WinappResult>.
CommonOptions
Базовые параметры, используемые большинством команд.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробный вывод. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
WinappResult
Результат, возвращаемый каждым оболочкой команд.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
exitCode |
number |
Да | Код выхода процесса (всегда равен 0 при успешном выполнении, ненулевое значение вызывает ошибку). |
stdout |
string |
Да | Захваченные стандартные выходные данные. |
stderr |
string |
Да | Зафиксирована стандартная ошибка. |
Оболочки команд CLI
Эти функции упаковывают собственные winapp команды CLI. Все принимают CommonOptions (quiet, verbose, cwd).
certGenerate()
Создайте самозаверяющий сертификат только для локального тестирования. Publisher должен соответствовать манифесту (автоматически выводимо, если --manifest предоставлен или Package.appxmanifest находится в рабочем каталоге). Выходные данные: devcert.pfx (пароль по умолчанию: password). Для производственной среды получите сертификат из доверенного Центра сертификации (ЦС). Используйте cert install для доверия на этом компьютере.
function certGenerate(options?: CertGenerateOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
exportCer |
boolean \| undefined |
Нет | Экспорт файла .cer (только открытый ключ) вместе с PFX |
ifExists |
IfExists \| undefined |
Нет | Поведение при наличии выходного файла: "error" (сбой, по умолчанию), "skip" (сохранить существующий) или "overwrite" (заменить) |
install |
boolean \| undefined |
Нет | Установите сертификат в локальное хранилище машины после генерации |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
manifest |
string \| undefined |
Нет | Путь к файлу Package.appxmanifest или appxmanifest.xml для извлечения сведений о издателе |
output |
string \| undefined |
Нет | Выходной путь для созданного PFX-файла |
password |
string \| undefined |
Нет | Пароль для созданного PFX-файла |
publisher |
string \| undefined |
Нет | Имя издателя созданного сертификата. Если не указано, будет выводиться из манифеста. |
validDays |
number \| undefined |
Нет | Количество дней действия сертификата |
Также принимает CommonOptions (quiet, verbose, cwd).
certInfo()
Отображение сведений о сертификате (тема, отпечаток, срок действия). Полезно для проверки соответствия сертификата манифесту перед подписью.
function certInfo(options: CertInfoOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
certPath |
string |
Да | Путь к файлу сертификата (PFX) |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
password |
string \| undefined |
Нет | Пароль для PFX-файла |
Также принимает CommonOptions (quiet, verbose, cwd).
certInstall()
Доверяйте сертификату на этом компьютере (требуется администратор). Запустите перед установкой пакетов MSIX, подписанных с помощью сертификатов разработки. Пример: winapp cert install ./devcert.pfx. Требуется только один раз для каждого сертификата.
function certInstall(options: CertInstallOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
certPath |
string |
Да | Путь к файлу сертификата (PFX или CER) |
force |
boolean \| undefined |
Нет | Принудительная установка, даже если сертификат уже существует |
password |
string \| undefined |
Нет | Пароль для PFX-файла |
Также принимает CommonOptions (quiet, verbose, cwd).
createDebugIdentity()
Для отладки включите идентификатор пакета без создания полного MSIX. Требуется для тестирования api Windows (push-уведомлений, общего доступа и т. д.) во время разработки. Пример: winapp create-debug-identity ./myapp.exe. Требуется наличие файла Package.appxmanifest или appxmanifest.xml в текущем каталоге или передача с помощью --manifest. Повторно запустите после изменения манифеста или ресурсов/.
function createDebugIdentity(options?: CreateDebugIdentityOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
entrypoint |
string \| undefined |
Нет | Путь к .exe, который должен выполняться с удостоверением или скриптом точки входа. |
keepIdentity |
boolean \| undefined |
Нет | Сохраняйте идентификатор пакета из манифеста как есть, не добавляя ".debug" к имени пакета и идентификатору приложения. |
manifest |
string \| undefined |
Нет | Путь к Package.appxmanifest или appxmanifest.xml |
noInstall |
boolean \| undefined |
Нет | Не устанавливайте пакет после создания. |
Также принимает CommonOptions (quiet, verbose, cwd).
createExternalCatalog()
Создает файл каталога CodeIntegrityExternal.cat с хэшами исполняемых файлов из указанных каталогов. Используется с флагом TrustedLaunch в манифестах разреженных пакетов MSIX (AllowExternalContent), чтобы разрешить выполнение внешних файлов, не включенных в пакет.
function createExternalCatalog(options: CreateExternalCatalogOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
inputFolder |
string |
Да | Список входных папок с исполняемыми файлами для обработки (разделенных точкой с запятой) |
computeFlatHashes |
boolean \| undefined |
Нет | Включение плоских хэшей при создании каталога |
ifExists |
IfExists \| undefined |
Нет | Поведение, когда выходной файл уже существует |
output |
string \| undefined |
Нет | Путь к файлу выходного каталога. Если не указано, используется имя CodeIntegrityExternal.cat по умолчанию. |
recursive |
boolean \| undefined |
Нет | Включение файлов из подкаталогов |
usePageHashes |
boolean \| undefined |
Нет | Включение хэшей страниц при создании каталога |
Также принимает CommonOptions (quiet, verbose, cwd).
getWinappPath()
Распечатайте путь к каталогу WINAPP. Используйте --global для расположения общего кэша или опустите папку project-local .winapp. Полезно для сценариев сборки, которые должны ссылаться на установленные пакеты.
function getWinappPath(options?: GetWinappPathOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
global |
boolean \| undefined |
Нет | Получите глобальный каталог .winapp вместо локального |
Также принимает CommonOptions (quiet, verbose, cwd).
init()
Начните здесь для инициализации приложения Windows с требуемой настройкой. Настраивает все необходимое для разработки приложений Windows: создает Package.appxmanifest с ресурсами по умолчанию, загружает пакеты Windows SDK и Windows App SDK, и создает проекции. Когда пакеты SDK управляются (--setup-sdks stable/preview/experimental), также создается файл winapp.yaml для закрепления версий для 'restore'/'update'. С --setup-sdks none (например, для проектов Rust/Tauri, которые используют собственные привязки SDK), файл winapp.yaml не создается. Интерактивный режим установлен по умолчанию (используйте --use-defaults, чтобы пропустить запросы). Используйте "restore" вместо этого, если вы клонировали репозиторий, который уже имеет winapp.yaml. Используйте "создание манифеста", если вам нужен только манифест или "создать сертификат", если требуется сертификат разработки для подписи кода.
function init(options?: InitOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
baseDirectory |
string \| undefined |
Нет | Базовый или корневой каталог для рабочей области Winapp для использования или установки. |
configDir |
string \| undefined |
Нет | Каталог для чтения и хранения конфигурации (по умолчанию: текущий каталог) |
configOnly |
boolean \| undefined |
Нет | Проводите только операции с файлами конфигурации (создание при отсутствии, проверка, если существует). Пропустите установку пакета и другие действия по настройке рабочей области. |
ignoreConfig |
boolean \| undefined |
Нет | Не используйте файл конфигурации для управления версиями |
noGitignore |
boolean \| undefined |
Нет | Не обновляйте файл .gitignore |
setupSdks |
SdkInstallMode \| undefined |
Нет | Режим установки пакета SDK: "стабильный" (по умолчанию), "предварительная версия", "экспериментальный" или "нет" (пропустить установку пакета SDK) |
useDefaults |
boolean \| undefined |
Нет | Не запрашивайте и используйте значения по умолчанию для всех запросов. |
Также принимает CommonOptions (quiet, verbose, cwd).
manifestAddAlias()
Добавьте псевдоним выполнения (uap5:AppExecutionAlias) в package.appxmanifest. Это позволяет запустить упаковаемое приложение из командной строки, введя имя псевдонима. По умолчанию псевдоним выводится из исполняемого атрибута (например, $targetnametoken$.exe становится псевдонимом $targetnametoken$.exe).
function manifestAddAlias(options?: ManifestAddAliasOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
appId |
string \| undefined |
Нет | Идентификатор приложения для добавления псевдонима в приложение (по умолчанию: первый элемент Приложение) |
manifest |
string \| undefined |
Нет | Путь к файлу Package.appxmanifest или appxmanifest.xml (по умолчанию: поиск текущего каталога) |
name |
string \| undefined |
Нет | Имя псевдонима (например, 'myapp.exe'). По умолчанию: определяется из атрибута Исполняемого файла в манифесте. |
Также принимает CommonOptions (quiet, verbose, cwd).
manifestGenerate()
Создайте Package.appxmanifest без полной настройки проекта. Используйте, если требуются только манифест и ресурсы изображений (без SDK, без сертификата). Для полной настройки используйте вместо этого init. Шаблоны: "упакованный" (полный MSIX), "разреженный" (классическое приложение, требующее Windows API).
function manifestGenerate(options?: ManifestGenerateOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
directory |
string \| undefined |
Нет | Каталог для создания манифеста в |
description |
string \| undefined |
Нет | Описание приложения, доступного для чтения пользователем во время установки и в параметрах Windows |
executable |
string \| undefined |
Нет | Путь к исполняемому файлу приложения. По умолчанию: <имя-пакета>.exe |
ifExists |
IfExists \| undefined |
Нет | Поведение при наличии выходного файла: "error" (сбой, по умолчанию), "skip" (сохранить существующий) или "overwrite" (заменить) |
logoPath |
string \| undefined |
Нет | Путь к файлу изображения логотипа |
packageName |
string \| undefined |
Нет | Имя пакета (по умолчанию: имя папки) |
publisherName |
string \| undefined |
Нет | Publisher CN (по умолчанию: CN=<текущий пользователь>) |
template |
ManifestTemplates \| undefined |
Нет | Тип шаблона манифеста: «packaged» (полное приложение MSIX, по умолчанию) или «sparse» (классическое приложение с удостоверением пакета для API Windows). |
version |
string \| undefined |
Нет | Версия приложения в формате Major.Minor.Build.Revision (например, 1.0.0.0). |
Также принимает CommonOptions (quiet, verbose, cwd).
manifestUpdateAssets()
Сгенерируйте новые ассеты для изображений, на которые ссылается файл Package.appxmanifest, из одного исходного образа. Исходное изображение должно быть не менее 400x400 пикселей.
function manifestUpdateAssets(options: ManifestUpdateAssetsOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
imagePath |
string |
Да | Путь к файлу исходного изображения (SVG, PNG, ICO, JPG, BMP, GIF) |
lightImage |
string \| undefined |
Нет | Путь к исходному изображению для вариантов светлой темы (SVG, PNG, ICO, JPG, BMP, GIF) |
manifest |
string \| undefined |
Нет | Путь к файлу Package.appxmanifest или appxmanifest.xml (по умолчанию: поиск текущего каталога) |
Также принимает CommonOptions (quiet, verbose, cwd).
packageApp()
Создайте установщик MSIX из созданного приложения. Запустите после создания приложения. Манифест (Package.appxmanifest или appxmanifest.xml) необходим для упаковки. Он должен находиться в текущем рабочем каталоге, передан как --manifest или находиться в входной папке. Используйте --cert devcert.pfx, чтобы подписаться на тестирование. Пример: пакет winapp ./dist --manifest Package.appxmanifest --cert ./devcert.pfx
function packageApp(options: PackageOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
inputFolder |
string |
Да | Входная папка с макетом пакета |
cert |
string \| undefined |
Нет | Путь к сертификату подписания — при условии предоставления будет выполнена автоматическая подпись. |
certPassword |
string \| undefined |
Нет | Пароль сертификата (по умолчанию: пароль) |
executable |
string \| undefined |
Нет | Путь к исполняемому файлу относительно входной папки. |
generateCert |
boolean \| undefined |
Нет | Создание нового сертификата разработки |
installCert |
boolean \| undefined |
Нет | Установка сертификата на компьютер |
manifest |
string \| undefined |
Нет | Путь к файлу манифеста AppX (по умолчанию: автоматическое обнаружение из входной папки или текущего каталога) |
name |
string \| undefined |
Нет | Имя пакета (по умолчанию: из манифеста) |
output |
string \| undefined |
Нет | Выходное имя msix-файла для созданного пакета (по умолчанию <имя><версия><арх>.msix, возвращаясь к <имя><версия>.msix, <имя><арх>.msix, или <имя>.msix, если версия/арх не может быть определена) |
publisher |
string \| undefined |
Нет | Имя издателя для создания сертификатов |
selfContained |
boolean \| undefined |
Нет | Упакуйте среду выполнения Windows App SDK для автономного развертывания |
skipPri |
boolean \| undefined |
Нет | Пропуск создания файлов PRI |
Также принимает CommonOptions (quiet, verbose, cwd).
restore()
Используется после клонирования репозитория или если отсутствует .winapp/папка. Переустановка пакетов SDK из существующего winapp.yaml без изменения версий. Требуется winapp.yaml (создано 'init'). Чтобы проверить наличие более новых версий пакета SDK, используйте вместо этого команду update.
function restore(options?: RestoreOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
baseDirectory |
string \| undefined |
Нет | Базовый или корневой каталог для рабочей области Winapp |
configDir |
string \| undefined |
Нет | Каталог для чтения конфигурации из (по умолчанию: текущий каталог) |
Также принимает CommonOptions (quiet, verbose, cwd).
run()
Создает упакованный макет, регистрирует приложение и запускает упакованое приложение.
function run(options: RunOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
inputFolder |
string |
Да | Входная папка, содержащая приложение для запуска |
args |
string \| undefined |
Нет | Аргументы командной строки для передачи в приложение |
clean |
boolean \| undefined |
Нет | Удалите данные приложения существующего пакета (LocalState, параметры и т. д.) перед повторной развертыванием. По умолчанию данные приложения сохраняются во время повторного развертывания. |
debugOutput |
boolean \| undefined |
Нет | Запись сообщений OutputDebugString и исключений первого шанса из запущенного приложения. Одновременно с процессом может быть связан только один отладчик, поэтому другие отладчики, такие как Visual Studio или VS Code, нельзя использовать одновременно. Используйте --no-launch вместо этого, если необходимо подключить другой отладчик. Нельзя использовать вместе с --no-launch или --json. |
detach |
boolean \| undefined |
Нет | Запустите приложение и вернитесь немедленно, не ожидая его выхода. Полезно для взаимодействия с приложением после запуска в среде CI/автоматизации. Выводит PID в stdout (или в виде JSON с помощью --json). |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
manifest |
string \| undefined |
Нет | Путь к Package.appxmanifest (по умолчанию: автоматическое обнаружение из входной папки или текущего каталога) |
noLaunch |
boolean \| undefined |
Нет | Только создайте удостоверение отладки и зарегистрируйте пакет без запуска приложения |
outputAppxDirectory |
string \| undefined |
Нет | Выходной каталог для свободного пакета макета. Если не указано, будет использоваться каталог с именем AppX внутри каталога входной папки. |
symbols |
boolean \| undefined |
Нет | Скачайте символы из сервера символов Microsoft для более полного анализа аварийного сбоя. Используется только с режимом --debug-output. Первый запуск загружает символы и кэширует их локально; последующие запуски используют кэш. |
unregisterOnExit |
boolean \| undefined |
Нет | Отмена регистрации пакета разработки после завершения работы приложения. Удаляет только пакеты, зарегистрированные в режиме разработки. |
withAlias |
boolean \| undefined |
Нет | Запустите приложение с помощью псевдонима выполнения вместо активации AUMID. Приложение выполняется в текущем терминале с унаследованным stdin/stdout/stderr. Требуется uap5:ExecutionAlias в манифесте. Используйте "winapp manifest add-alias", чтобы добавить исполнительный псевдоним в манифест. |
Также принимает CommonOptions (quiet, verbose, cwd).
sign()
Подписывайте код пакета MSIX или исполняемого файла. Пример: знак winapp ./app.msix ./devcert.pfx. Используйте метку --timestamp для рабочих сборок, чтобы оставаться действительными после истечения срока действия сертификата. Команда "package" может автоматически подписаться с помощью --cert.
function sign(options: SignOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
filePath |
string |
Да | Путь к файлу или пакету для подписывания |
certPath |
string |
Да | Путь к файлу сертификата (формат PFX) |
password |
string \| undefined |
Нет | Пароль сертификата |
timestamp |
string \| undefined |
Нет | URL-адрес сервера метки времени |
Также принимает CommonOptions (quiet, verbose, cwd).
store()
Выполните команду Developer CLI в Microsoft Store. Эта команда загрузит Microsoft Store Developer CLI, если он еще не загружен. Дополнительные сведения о интерфейсе командной строки разработчика Microsoft Store см. здесь: https://aka.ms/msstoredevcli
function store(options?: StoreOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
storeArgs |
string[] \| undefined |
Нет | Аргументы, передаваемые в интерфейс командной строки разработчика Microsoft Store. |
Также принимает CommonOptions (quiet, verbose, cwd).
tool()
Запустите средства sdk Windows напрямую (makeappx, signtool, makepri и т. д.). При необходимости автоматически загружает средства сборки. Для большинства задач предпочитайте команды более высокого уровня, такие как "package" или "sign". Пример: инструмент winapp makeappx pack /d ./folder /p ./out.msix
function tool(options?: ToolOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
toolArgs |
string[] \| undefined |
Нет | Аргументы для передачи в средство SDK, например ['makeappx", "pack", "/d", "./folder", "/p", "./out.msix"]. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiClick()
Щелкните элемент по slug или текстовому поиску с помощью имитации действий мыши. Работает над элементами, которые не поддерживают InvokePattern (например, заголовки столбцов, элементы списка). Используйте --double для двойного щелчка, --right для щелчка правой кнопкой мыши.
function uiClick(options?: UiClickOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
double |
boolean \| undefined |
Нет | Дважды щелкните вместо одного щелчка. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
right |
boolean \| undefined |
Нет | Щелкните правой кнопкой мыши вместо левого щелчка. |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiFocus()
Переместите фокус клавиатуры на указанный элемент с помощью UIA SetFocus.
function uiFocus(options?: UiFocusOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiGetFocused()
Показать элемент, который в настоящее время имеет фокус клавиатуры в целевом приложении.
function uiGetFocused(options?: UiGetFocusedOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiGetProperty()
Чтение значений свойств UIA из элемента. Укажите --property для одного свойства или пропустите для всех.
function uiGetProperty(options?: UiGetPropertyOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени / ID автоматизации |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если они нечеткие. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
property |
string \| undefined |
Нет | Имя свойства для чтения или фильтрации |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiGetValue()
Прочитать текущее значение из элемента. Пробует TextPattern (RichEditBox, Document), ValuePattern (TextBox, ComboBox, Slider), а затем Name (метки). Использование: winapp ui get-value <селектор> -a <приложение>
function uiGetValue(options?: UiGetValueOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или automationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Отображает окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный хэндл из результата списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiInspect()
Просмотрите дерево элементов пользовательского интерфейса с семантическими метками, типами элементов, именами и границами.
function uiInspect(options?: UiInspectOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или идентификатору автоматизации |
ancestors |
boolean \| undefined |
Нет | Подниматься по дереву от указанного элемента к корню |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если неясно. |
depth |
number \| undefined |
Нет | Глубина инспекции дерева |
hideDisabled |
boolean \| undefined |
Нет | Скрытие отключенных элементов из выходных данных |
hideOffscreen |
boolean \| undefined |
Нет | Скрытие внеэкранных элементов из выходных данных |
interactive |
boolean \| undefined |
Нет | Показывать только интерактивные и вызываемые элементы (кнопки, ссылки, входные данные, элементы списка). Увеличивает глубину по умолчанию до 8. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный хэндл из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiInvoke()
Активация элемента путем поиска по фрагменту или тексту. Пытается последовательно использовать шаблоны InvokePattern, TogglePattern, SelectionItemPattern и ExpandCollapsePattern.
function uiInvoke(options?: UiInvokeOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Список окон, если их идентификация неоднозначна. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiListWindows()
Перечислите все видимые окна вместе с их HWND, заголовком, процессом и размером. Используйте -a для фильтрации по имени приложения. Используйте HWND с -w для адресации определенного окна.
function uiListWindows(options?: UiListWindowsOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
Также принимает CommonOptions (quiet, verbose, cwd).
uiScreenshot()
Захват целевого окна или элемента в виде изображения PNG. При наличии нескольких окон (например, диалоговых окон) записывает каждый из них в отдельный файл. С помощью --json возвращает путь к файлу и измерения. Используйте --capture-screen для наложения всплывающих экранов.
function uiScreenshot(options?: UiScreenshotOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
captureScreen |
boolean \| undefined |
Нет | Запись с экрана (включает всплывающие окна или наложения) вместо отрисовки окна. Сначала выводит окно на передний план. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
output |
string \| undefined |
Нет | Сохранение выходных данных в путь к файлу (например, снимок экрана) |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiScroll()
Прокрутите элемент контейнера с помощью ScrollPattern. Используйте "--direction", чтобы прокручивать постепенно, или "--to", чтобы переходить к верхней или нижней части.
function uiScroll(options?: UiScrollOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
direction |
string \| undefined |
Нет | Направление прокрутки: вверх, вниз, влево, вправо |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
to |
string \| undefined |
Нет | Прокрутка к позиции: в начало, в конец |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiScrollIntoView()
Прокрутите указанный элемент в видимой области с помощью UIA ScrollItemPattern.
function uiScrollIntoView(options?: UiScrollIntoViewOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiSearch()
Выполните поиск дерева элементов для элементов, соответствующих текстовому запросу. Возвращает все совпадения с семантическими слагами.
function uiSearch(options?: UiSearchOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
max |
number \| undefined |
Нет | Максимальное количество результатов поиска |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiSetValue()
Задайте значение для элемента с помощью UIA ValuePattern. Работает для TextBox, ComboBox, Slider и других редактируемых элементов управления. Использование: winapp ui set-value <селектор><значение> -a <приложение>
function uiSetValue(options?: UiSetValueOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
value |
string \| undefined |
Нет | Значение для установки (текст для TextBox/ComboBox, число для ползунка) |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiStatus()
Подключитесь к целевому приложению и отображайте сведения о подключении.
function uiStatus(options?: UiStatusOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
uiWaitFor()
Подождите, пока элемент появится, исчезнет или имеет свойство, достигающее целевого значения. Опросы по интервалам 100 мс до тех пор, пока условие не будет выполнено или истекло время ожидания.
function uiWaitFor(options?: UiWaitForOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
contains |
boolean \| undefined |
Нет | Используйте сопоставление подстрок для --value вместо точного соответствия |
gone |
boolean \| undefined |
Нет | Ожидать исчезновения элемента вместо его появления |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
property |
string \| undefined |
Нет | Имя свойства для чтения или фильтрации |
timeout |
number \| undefined |
Нет | Тайм-аут в миллисекундах |
value |
string \| undefined |
Нет | Подождите, пока значение элемента не станет равным этой строке. Использует умную резервную функцию (TextPattern —> ValuePattern —> Name). Совместите с --property, чтобы проверить конкретное свойство. |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
Также принимает CommonOptions (quiet, verbose, cwd).
unregister()
Отменяет регистрацию загруженного извне пакета разработки. Удаляет только пакеты, зарегистрированные в режиме разработки (например, с помощью winapp run или create-debug-identity).
function unregister(options?: UnregisterOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
force |
boolean \| undefined |
Нет | Пропустить проверку директории местоположения установки и отменить регистрацию, даже если пакет был зарегистрирован из другого дерева проектов. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
manifest |
string \| undefined |
Нет | Путь к Package.appxmanifest (по умолчанию: автоматическое обнаружение из текущего каталога) |
Также принимает CommonOptions (quiet, verbose, cwd).
update()
Проверьте и установите более новые версии пакета SDK. Обновляет winapp.yaml с последними версиями и переустановывает пакеты. Необходим существующий файл winapp.yaml, созданный командой 'init'. Используйте --setup-sdks preview для предварительного тестирования SDK. Чтобы переустановить текущие версии без обновления, используйте вместо этого команду restore.
function update(options?: UpdateOptions): Promise<WinappResult>
Варианты.
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
setupSdks |
SdkInstallMode \| undefined |
Нет | Режим установки пакета SDK: "стабильный" (по умолчанию), "предварительная версия", "экспериментальный" или "нет" (пропустить установку пакета SDK) |
Также принимает CommonOptions (quiet, verbose, cwd).
Служебные функции
execWithBuildTools()
Выполнение команды с помощью пути bin BuildTools, добавленного в среду PATH
function execWithBuildTools(command: string, options?: ExecSyncOptions): string | Buffer<ArrayBufferLike>
Параметры:
| Parameter | Тип | Обязательный | Description |
|---|---|---|---|
command |
string |
Да | Команда для выполнения |
options |
ExecSyncOptions |
Нет | Параметры передачи в execSync (необязательно) |
Возвращает: Выходные данные execSync
addMsixIdentityToExe()
Добавляет информацию об идентификации пакета из файла appxmanifest.xml в встроенный манифест исполняемого файла
function addMsixIdentityToExe(exePath: string, appxManifestPath?: string | undefined, options?: MsixIdentityOptions): Promise<MsixIdentityResult>
Параметры:
| Parameter | Тип | Обязательный | Description |
|---|---|---|---|
exePath |
string |
Да | Путь к исполняемому файлу |
appxManifestPath |
string \| undefined |
Нет | Путь к файлу appxmanifest.xml, содержащему данные идентификации пакета |
options |
MsixIdentityOptions |
Нет | Дополнительные настройки |
addElectronDebugIdentity()
Добавляет идентификацию пакета в процесс отладки Electron
function addElectronDebugIdentity(options?: MsixIdentityOptions): Promise<ElectronDebugIdentityResult>
Параметры:
| Parameter | Тип | Обязательный | Description |
|---|---|---|---|
options |
MsixIdentityOptions |
Нет | Параметры конфигурации |
clearElectronDebugIdentity()
Удаление идентификатора пакета из процесса отладки Electron путем восстановления из резервной копии.
function clearElectronDebugIdentity(options?: MsixIdentityOptions): Promise<ClearElectronDebugIdentityResult>
Параметры:
| Parameter | Тип | Обязательный | Description |
|---|---|---|---|
options |
MsixIdentityOptions |
Нет | Параметры конфигурации |
getGlobalWinappPath()
Получите путь к глобальному каталогу .winapp
function getGlobalWinappPath(): string
Возвращает: Полный путь к глобальному каталогу .winapp
getLocalWinappPath()
Получение пути к локальному каталогу .winapp
function getLocalWinappPath(): string
Возвращает: Полный путь к локальному каталогу .winapp
Команды CLI Node.js
Эти команды доступны исключительно через npx winapp node <subcommand> и не экспортируются как программные функции.
node create-addon
Создайте собственные файлы надстроек для проекта Electron. Поддерживает шаблоны C++ (node-gyp) и C# (node-api-dotnet).
npx winapp node create-addon [options]
Варианты.
| Flag | Description |
|---|---|
--name <name> |
Имя надстройки (по умолчанию зависит от шаблона) |
--template <type> |
Шаблон надстройки: cpp или cs (по умолчанию: cpp) |
--verbose |
Включите подробный вывод |
Примечание: Должен выполняться из корневого каталога проекта Electron (каталога, содержащего
package.json).
Примеры:
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
Добавьте идентификатор пакета в процесс отладки Electron с помощью sparse packaging. Создает резервную копию electron.exe, создает разреженный манифест MSIX, добавляет идентификатор в исполняемый файл и регистрирует разреженный пакет. Требуется Package.appxmanifest (создайте с помощью winapp init или winapp manifest generate).
npx winapp node add-electron-debug-identity [options]
Варианты.
| Flag | Description |
|---|---|
--manifest <path> |
Путь к пользовательскому Package.appxmanifest (по умолчанию: Package.appxmanifest в текущем каталоге) |
--no-install |
Не устанавливайте пакет после создания |
--keep-identity |
Сохраните идентификатор манифеста без изменений, без добавления суффикса .debug |
--verbose |
Включите подробный вывод |
Примечание: Должен выполняться из корневого каталога проекта Electron (каталог, содержащий
node_modules/electron). Чтобы отменить, используйтеnpx winapp node clear-electron-debug-identity.
Примеры:
npx winapp node add-electron-debug-identity
npx winapp node add-electron-debug-identity --manifest ./custom/Package.appxmanifest
node clear-electron-debug-identity
Удалите идентификатор пакета из процесса отладки Electron. Восстанавливает electron.exe из резервной копии, созданной add-electron-debug-identity и удаляет файлы резервного копирования.
npx winapp node clear-electron-debug-identity [options]
Варианты.
| Flag | Description |
|---|---|
--verbose |
Включите подробный вывод |
Примечание: Должен выполняться из корневого каталога, содержащего проект Electron (
node_modules/electron).
Примеры:
npx winapp node clear-electron-debug-identity
Справочник по типам
ExecSyncOptions
Повторно экспортируется из Node.js для удобства. См. документы Node.js.
MsixIdentityOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
verbose |
boolean \| undefined |
Нет | |
noInstall |
boolean \| undefined |
Нет | |
keepIdentity |
boolean \| undefined |
Нет | |
manifest |
string \| undefined |
Нет |
MsixIdentityResult
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
success |
boolean |
Да |
ElectronDebugIdentityResult
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
success |
boolean |
Да | |
electronExePath |
string |
Да | |
backupPath |
string |
Да | |
manifestPath |
string |
Да | |
assetsDir |
string |
Да |
ClearElectronDebugIdentityResult
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
success |
boolean |
Да | |
electronExePath |
string |
Да | |
restoredFromBackup |
boolean |
Да |
CallWinappCliOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
exitOnError |
boolean \| undefined |
Нет |
CallWinappCliResult
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
exitCode |
number |
Да |
CallWinappCliCaptureOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()) |
CallWinappCliCaptureResult
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
exitCode |
number |
Да | |
stdout |
string |
Да | |
stderr |
string |
Да |
GenerateCppAddonOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
name |
string \| undefined |
Нет | |
projectRoot |
string \| undefined |
Нет | |
verbose |
boolean \| undefined |
Нет |
GenerateCppAddonResult
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
success |
boolean |
Да | |
addonName |
string |
Да | |
addonPath |
string |
Да | |
needsTerminalRestart |
boolean |
Да | |
files |
string[] |
Да |
GenerateCsAddonOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
name |
string \| undefined |
Нет | |
projectRoot |
string \| undefined |
Нет | |
verbose |
boolean \| undefined |
Нет |
GenerateCsAddonResult
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
success |
boolean |
Да | |
addonName |
string |
Да | |
addonPath |
string |
Да | |
needsTerminalRestart |
boolean |
Да | |
files |
string[] |
Да |
IfExists
Значения IfExists
type IfExists = "error" | "overwrite" | "skip"
SdkInstallMode
Значения SdkInstallMode.
type SdkInstallMode = "stable" | "preview" | "experimental" | "none"
ManifestTemplates
Значения ManifestTemplates.
type ManifestTemplates = "packaged" | "sparse"
CertGenerateOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
exportCer |
boolean \| undefined |
Нет | Экспорт файла .cer (только открытый ключ) вместе с PFX |
ifExists |
IfExists \| undefined |
Нет | Поведение при наличии выходного файла: "error" (сбой, по умолчанию), "skip" (сохранить существующий) или "overwrite" (заменить) |
install |
boolean \| undefined |
Нет | Установите сертификат в локальное хранилище машины после генерации |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
manifest |
string \| undefined |
Нет | Путь к файлу Package.appxmanifest или к файлу appxmanifest.xml для извлечения сведений о издателе |
output |
string \| undefined |
Нет | Выходной путь для созданного PFX-файла |
password |
string \| undefined |
Нет | Пароль для созданного PFX-файла |
publisher |
string \| undefined |
Нет | Имя издателя созданного сертификата. Если не указано, будет выводиться из манифеста. |
validDays |
number \| undefined |
Нет | Количество дней действия сертификата |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
CertInfoOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
certPath |
string |
Да | Путь к файлу сертификата (PFX) |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
password |
string \| undefined |
Нет | Пароль для PFX-файла |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробный вывод. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
CertInstallOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
certPath |
string |
Да | Путь к файлу сертификата (PFX или CER) |
force |
boolean \| undefined |
Нет | Принудительная установка, даже если сертификат существует. |
password |
string \| undefined |
Нет | Пароль для PFX-файла |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
CreateDebugIdentityOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
entrypoint |
string \| undefined |
Нет | Путь к .exe, который должен выполняться под учетной записью или как стартовый скрипт. |
keepIdentity |
boolean \| undefined |
Нет | Сохраняйте идентификатор пакета из манифеста без изменений, не добавляя ".debug" к имени пакета и идентификатору приложения. |
manifest |
string \| undefined |
Нет | Путь к Package.appxmanifest или appxmanifest.xml |
noInstall |
boolean \| undefined |
Нет | Не устанавливайте пакет после создания. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
CreateExternalCatalogOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
inputFolder |
string |
Да | Список входных папок с исполняемыми файлами для обработки (разделенных точкой с запятой) |
computeFlatHashes |
boolean \| undefined |
Нет | Включите плоские хэши при создании каталога |
ifExists |
IfExists \| undefined |
Нет | Поведение, когда выходной файл уже существует |
output |
string \| undefined |
Нет | Путь к файлу выходного каталога. Если не указано, используется имя CodeIntegrityExternal.cat по умолчанию. |
recursive |
boolean \| undefined |
Нет | Включение файлов из подкаталогов |
usePageHashes |
boolean \| undefined |
Нет | Включение хэшей страниц при создании каталога |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
GetWinappPathOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
global |
boolean \| undefined |
Нет | Получите глобальный каталог .winapp вместо локального |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробный вывод. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
InitOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
baseDirectory |
string \| undefined |
Нет | Базовый или корневой каталог для рабочей области Winapp для использования или установки. |
configDir |
string \| undefined |
Нет | Каталог для чтения и хранения конфигурации (по умолчанию: текущий каталог) |
configOnly |
boolean \| undefined |
Нет | Обрабатывайте только операции с файлами конфигурации (создайте, если отсутствует, проверьте, если существует). Пропустите установку пакета и другие действия по настройке рабочей области. |
ignoreConfig |
boolean \| undefined |
Нет | Не используйте файл конфигурации для управления версиями |
noGitignore |
boolean \| undefined |
Нет | Не обновляйте файл .gitignore |
setupSdks |
SdkInstallMode \| undefined |
Нет | Режим установки пакета SDK: "стабильный" (по умолчанию), "предварительная версия", "экспериментальный" или "нет" (пропустить установку пакета SDK) |
useDefaults |
boolean \| undefined |
Нет | Не запрашивайте и используйте значения по умолчанию для всех запросов. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
ManifestAddAliasOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
appId |
string \| undefined |
Нет | Идентификатор приложения, к которому добавляется псевдоним (по умолчанию: первый элемент приложения) |
manifest |
string \| undefined |
Нет | Путь к файлу Package.appxmanifest или appxmanifest.xml (по умолчанию: поиск текущего каталога) |
name |
string \| undefined |
Нет | Имя псевдонима (например, 'myapp.exe'). По умолчанию: определяется атрибутом Исполняемого файла в манифесте. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
ManifestGenerateOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
directory |
string \| undefined |
Нет | Каталог для создания манифеста в |
description |
string \| undefined |
Нет | Описание приложения, доступного для чтения пользователем во время установки и в параметрах Windows |
executable |
string \| undefined |
Нет | Путь к исполняемому файлу приложения. По умолчанию: <package-name>.exe |
ifExists |
IfExists \| undefined |
Нет | Поведение при наличии выходного файла: "error" (сбой, по умолчанию), "skip" (сохранить существующий) или "overwrite" (заменить) |
logoPath |
string \| undefined |
Нет | Путь к файлу изображения логотипа |
packageName |
string \| undefined |
Нет | Имя пакета (по умолчанию: имя папки) |
publisherName |
string \| undefined |
Нет | Publisher CN (по умолчанию: CN=<текущий пользователь>) |
template |
ManifestTemplates \| undefined |
Нет | Тип шаблона манифеста: "упакованный" (полное приложение MSIX, по умолчанию) или "с разреженной конфигурацией" (настольное приложение с удостоверением пакета для API Windows) |
version |
string \| undefined |
Нет | Версия приложения в формате Major.Minor.Build.Revision (например, 1.0.0.0). |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
ManifestUpdateAssetsOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
imagePath |
string |
Да | Путь к файлу исходного изображения (SVG, PNG, ICO, JPG, BMP, GIF) |
lightImage |
string \| undefined |
Нет | Путь к исходному изображению для вариантов светлой темы (SVG, PNG, ICO, JPG, BMP, GIF) |
manifest |
string \| undefined |
Нет | Путь к файлу Package.appxmanifest или appxmanifest.xml (по умолчанию: поиск текущего каталога) |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
PackageOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
inputFolder |
string |
Да | Входная папка с макетом пакета |
cert |
string \| undefined |
Нет | Путь к сертификату подписания — при условии предоставления будет выполнена автоматическая подпись. |
certPassword |
string \| undefined |
Нет | Пароль сертификата (по умолчанию: пароль) |
executable |
string \| undefined |
Нет | Путь к исполняемому файлу относительно входной папки. |
generateCert |
boolean \| undefined |
Нет | Создание нового сертификата разработки |
installCert |
boolean \| undefined |
Нет | Установка сертификата на компьютер |
manifest |
string \| undefined |
Нет | Путь к файлу манифеста AppX (по умолчанию: автоматическое обнаружение из входной папки или текущего каталога) |
name |
string \| undefined |
Нет | Имя пакета (по умолчанию: из манифеста) |
output |
string \| undefined |
Нет | Выходное имя msix-файла для созданного пакета (по умолчанию <имя><версия><арх>.msix, возвращаясь к <имя><версия>.msix, <имя><арх>.msix, или <имя>.msix, если версия/арх не может быть определена) |
publisher |
string \| undefined |
Нет | Имя издателя для создания сертификатов |
selfContained |
boolean \| undefined |
Нет | Упакуйте среду выполнения Windows App SDK для автономного развертывания |
skipPri |
boolean \| undefined |
Нет | Пропуск создания файлов PRI |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
RestoreOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
baseDirectory |
string \| undefined |
Нет | Базовый или корневой каталог для рабочей области Winapp |
configDir |
string \| undefined |
Нет | Каталог для чтения конфигурации из (по умолчанию: текущий каталог) |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
RunOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
inputFolder |
string |
Да | Входная папка, содержащая приложение для запуска |
args |
string \| undefined |
Нет | Аргументы командной строки для передачи в приложение |
clean |
boolean \| undefined |
Нет | Удалите данные приложения существующего пакета (LocalState, параметры и т. д.) перед повторной развертыванием. По умолчанию данные приложения сохраняются во время повторного развертывания. |
debugOutput |
boolean \| undefined |
Нет | Запись сообщений OutputDebugString и исключений первого шанса из запущенного приложения. Одновременно с процессом может быть связан только один отладчик, поэтому другие отладчики, такие как Visual Studio или VS Code, нельзя использовать одновременно. Используйте --no-launch вместо этого, если необходимо подключить другой отладчик. Нельзя использовать вместе с --no-launch или --json. |
detach |
boolean \| undefined |
Нет | Запустите приложение и вернитесь немедленно, не ожидая его выхода. Полезно для взаимодействия с приложением после запуска в среде CI/автоматизации. Выводит PID в stdout (или в виде JSON с помощью --json). |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
manifest |
string \| undefined |
Нет | Путь к Package.appxmanifest (по умолчанию: автоматическое обнаружение из входной папки или текущего каталога) |
noLaunch |
boolean \| undefined |
Нет | Только создайте удостоверение отладки и зарегистрируйте пакет без запуска приложения |
outputAppxDirectory |
string \| undefined |
Нет | Выходной каталог для свободного пакета макета. Если не указано, будет использоваться каталог с именем AppX внутри каталога входной папки. |
symbols |
boolean \| undefined |
Нет | Скачайте символы из сервера символов Microsoft для более полного анализа аварийного сбоя. Используется только с режимом --debug-output. Первый запуск загружает символы и кэширует их локально; последующие запуски используют кэш. |
unregisterOnExit |
boolean \| undefined |
Нет | Отмена регистрации пакета разработки после завершения работы приложения. Удаляет только пакеты, зарегистрированные в режиме разработки. |
withAlias |
boolean \| undefined |
Нет | Запустите приложение с помощью псевдонима выполнения вместо активации AUMID. Приложение выполняется в текущем терминале с унаследованным stdin/stdout/stderr. Требуется uap5:ExecutionAlias в манифесте. Используйте "winapp manifest add-alias", чтобы добавить исполнительный псевдоним в манифест. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
SignOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
filePath |
string |
Да | Путь к файлу или пакету для подписывания |
certPath |
string |
Да | Путь к файлу сертификата (формат PFX) |
password |
string \| undefined |
Нет | Пароль сертификата |
timestamp |
string \| undefined |
Нет | URL-адрес сервера метки времени |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
StoreOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
storeArgs |
string[] \| undefined |
Нет | Аргументы, передаваемые в интерфейс командной строки разработчика Microsoft Store. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
ToolOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
toolArgs |
string[] \| undefined |
Нет | Аргументы для передачи в средство SDK, например ['makeappx", "pack", "/d", "./folder", "/p", "./out.msix"]. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiClickOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
double |
boolean \| undefined |
Нет | Дважды щелкните вместо одного щелчка. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
right |
boolean \| undefined |
Нет | Щелкните правой кнопкой мыши вместо левого щелчка. |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiFocusOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiGetFocusedOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiGetPropertyOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
property |
string \| undefined |
Нет | Имя свойства для чтения или фильтрации |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiGetValueOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiInspectOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
ancestors |
boolean \| undefined |
Нет | Подниматься по дереву от указанного элемента к корню |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
depth |
number \| undefined |
Нет | Глубина инспекции дерева |
hideDisabled |
boolean \| undefined |
Нет | Скрытие отключенных элементов из выходных данных |
hideOffscreen |
boolean \| undefined |
Нет | Скрытие внеэкранных элементов из выходных данных |
interactive |
boolean \| undefined |
Нет | Показывать только интерактивные и вызываемые элементы (кнопки, ссылки, входные данные, элементы списка). Увеличивает глубину по умолчанию до 8. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiInvokeOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiListWindowsOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiScreenshotOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
captureScreen |
boolean \| undefined |
Нет | Запись с экрана (включает всплывающие окна или наложения) вместо отрисовки окна. Сначала выводит окно на передний план. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
output |
string \| undefined |
Нет | Сохранение выходных данных в путь к файлу (например, снимок экрана) |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiScrollOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
direction |
string \| undefined |
Нет | Направление прокрутки: вверх, вниз, влево, вправо |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
to |
string \| undefined |
Нет | Прокрутка к позиции: в начало, в конец |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiScrollIntoViewOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiSearchOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
max |
number \| undefined |
Нет | Максимальное количество результатов поиска |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiSetValueOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
value |
string \| undefined |
Нет | Значение для установки (текст для TextBox/ComboBox, число для ползунка) |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiStatusOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UiWaitForOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
selector |
string \| undefined |
Нет | Семантический идентификатор (например, btn-minimize-d1a0) или текст для поиска по имени или AutomationId |
app |
string \| undefined |
Нет | Целевое приложение (имя процесса, название окна или PID). Перечисляет окна, если есть неоднозначность. |
contains |
boolean \| undefined |
Нет | Используйте сопоставление подстроки для --value вместо точного соответствия |
gone |
boolean \| undefined |
Нет | Ожидание исчезновения элемента вместо его появления |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
property |
string \| undefined |
Нет | Имя свойства для чтения или фильтрации |
timeout |
number \| undefined |
Нет | Тайм-аут в миллисекундах |
value |
string \| undefined |
Нет | Подождите, пока значение элемента станет равным этой строке. Использует смарт-резерв (TextPattern —> ValuePattern —> Имя). Объедините с --property, чтобы вместо этого проверить определенное свойство. |
window |
number \| undefined |
Нет | Целевое окно по HWND (стабильный дескриптор из выходных данных списка). Имеет приоритет над --app. |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UnregisterOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
force |
boolean \| undefined |
Нет | Пропустить проверку каталога местоположения установки и отменить регистрацию, даже если пакет был зарегистрирован из другого проектного дерева. |
json |
boolean \| undefined |
Нет | Форматирование выходных данных в формате JSON |
manifest |
string \| undefined |
Нет | Путь к Package.appxmanifest (по умолчанию: автоматическое обнаружение из текущего каталога) |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
UpdateOptions
| Недвижимость | Тип | Обязательный | Description |
|---|---|---|---|
setupSdks |
SdkInstallMode \| undefined |
Нет | Режим установки пакета SDK: "стабильный" (по умолчанию), "предварительная версия", "экспериментальный" или "нет" (пропустить установку пакета SDK) |
quiet |
boolean \| undefined |
Нет | Подавление сообщений о ходе выполнения. |
verbose |
boolean \| undefined |
Нет | Включите подробные выходные данные. |
cwd |
string \| undefined |
Нет | Рабочий каталог для процесса CLI (по умолчанию — process.cwd()). |
Совместная работа с нами на GitHub
Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.
Windows developer