Внести изменения

Редактировать эту документацию

Переведите документацию или откройте весь проект на своём компьютере.

Ничего не будет опубликовано, пока вы не решите отправить свою работу.

Справочник по CLI

Полный справочник по командам Wails CLI

Обзор

Wails CLI (wails3) — это интерфейс командной строки для создания, разработки, сборки, подписывания, упаковки и анализа приложений Wails 3. Большая часть управления сборкой делегируется файлам Taskfile отдельных проектов (они находятся в каталоге build/ вашего проекта): многие команды wails3 представляют собой тонкие обёртки, которые запускают определённую задачу.

Чтобы получить актуальную справку по любой команде, выполните:

bash
wails3 --help
wails3 <command> --help

Жизненный цикл проекта

Команда Описание
wails3 init Создаёт новый проект из шаблона. Флаги: -n (имя проекта), -t (шаблон; по умолчанию vanilla), -p (имя пакета Go; по умолчанию main), -d (каталог проекта; по умолчанию .), -q (минимальный вывод), -l (вывести список шаблонов), -mod (путь модуля Go), --git (URL репозитория Git), --skipgomodtidy, -s (не показывать предупреждение об удалённом шаблоне), --productname/--productdescription/--productversion/--productcompany/--productcopyright/--productcomments/--productidentifier.
wails3 dev Запускает приложение в режиме разработки с горячей перезагрузкой фронтенда. Флаги: --config (по умолчанию ./build/config.yml), --port (порт сервера разработки Vite), -s (включить HTTPS).
wails3 build Собирает проект. Представляет собой тонкую обёртку над задачей build из Taskfile. Флаги: --tags (передаётся как EXTRA_TAGS=), --obfuscated (собрать с помощью Garble; см. Обфусцированные сборки), --garbleargs (дополнительные флаги, передаваемые garble перед подкомандой build).
wails3 package Запускает платформозависимую задачу package из Taskfile.
wails3 task [name] Запускает любую задачу из Taskfile; если имя не указано, --list выводит все зарегистрированные задачи.
wails3 mcp Запускает MCP-сервер проекта. Для процессов, запущенных агентом, автоматически использует stdio, а при интерактивной работе в терминале — Streamable HTTP через интерфейс обратной петли.
wails3 doctor Выводит диагностический отчёт о вашей среде.
wails3 doctor-ng Более новый вариант doctor с текстовым пользовательским интерфейсом (TUI).
wails3 version Выводит версию CLI.
wails3 releasenotes Выводит примечания к последним выпускам.
wails3 docs Открывает сайт документации в браузере.
wails3 sponsor Открывает страницу для спонсоров.

Генерация

wails3 generate <subcommand>:

Подкоманда Описание
generate bindings Генерирует привязки между Go и фронтендом. Флаги: -d (каталог вывода), -models, -index, -ts, -i (интерфейсы), -b (пакет), -names (сгенерировать Call.ByName), -noevents, -noindex, -dry, -silent, -v, -clean (по умолчанию true), -f, -obfuscated (сгенерировать wails_obfuscated.gen.go со стабильными идентификаторами привязок для сборок Garble; см. Обфусцированные сборки), -obfuscated-output (каталог для сгенерированного файла; по умолчанию каталог основного пакета). Принимает шаблоны пакетов (например, ./...); если они не указаны, используется текущий каталог.
generate icons Преобразует исходный PNG-файл в форматы значков для различных платформ. Флаги: -input, -windowsfilename, -macfilename, -iconcomposerinput, -macassetdir.
generate build-assets Генерирует содержимое каталога build/ (фрагменты Taskfile, файлы NSIS, Info.plist, шаблон .desktop и т. д.) из build/config.yml.
generate runtime Повторно генерирует предварительно собранный файл /wails/runtime.js, поставляемый в webview.
generate syso Генерирует файл ресурсов Windows .syso (значок, манифест и сведения о версии).
generate webview2bootstrapper Генерирует загрузочный установщик WebView2 для Windows.
generate constants Генерирует константы имён событий JS из типов событий Go.
generate template Создаёт каркас нового шаблона проекта.
generate .desktop Генерирует файл Linux .desktop (используется AppImage/DEB/RPM).
generate appimage Генерирует каталог сборки AppImage.

Обновление

wails3 update <subcommand>:

Подкоманда Описание
update build-assets Обновляет каталог build/ из build/config.yml, по возможности сохраняя изменения пользователя.
update cli Самостоятельно обновляет исполняемый файл wails3.

Подписывание кода и упаковка

Команда Описание
wails3 setup signing Интерактивный мастер, который настраивает подписывание для платформ, обнаруженных в build/. Флаги: --platform (можно указывать несколько раз; по умолчанию платформы автоматически определяются по каталогу сборки).
wails3 setup entitlements Интерактивный мастер настройки разрешений macOS. Флаг: --output (путь; по умолчанию build/darwin/entitlements.plist).
wails3 sign [GOOS=…] Команда-обёртка, которая запускает платформенную задачу Taskfile *:sign для текущей ОС (или ОС, указанной с помощью GOOS).
wails3 tool sign Низкоуровневая точка входа для непосредственного подписывания. Флаги: --input, --output, --verbose, --certificate, --password, --thumbprint, --timestamp, --identity, --entitlements, --hardened-runtime, --notarize, --keychain-profile, --pgp-key, --pgp-password, --role.

Подкоманды wails3 signing нет: для учётных данных связки ключей используйте непосредственно xcrun notarytool store-credentials, а для ключей PGP — gpg (мастер wails3 setup signing автоматизирует оба действия).

Инструменты

wails3 tool <subcommand>:

Подкоманда Описание
tool checkport Проверяет, открыт ли TCP-порт (полезно при ожидании запуска Vite).
tool watcher Запускает команду при каждом изменении отслеживаемых файлов.
tool cp Кроссплатформенное копирование файлов.
tool buildinfo Выводит встроенную информацию о сборке Go из бинарного файла.
tool package Создаёт пакет Linux (deb, rpm, archlinux) на основе build/linux/nfpm.
tool version Повышает семантическую версию проекта.
tool lipo Объединяет бинарные файлы для нескольких архитектур macOS в один универсальный бинарный файл.
tool capabilities Проверяет наличие GTK3/GTK4 и WebKit в системе.
tool sign (См. раздел «Подписывание кода и упаковка».)

Сервисы

wails3 service <subcommand>:

Подкоманда Описание
service init Создаёт каркас нового пакета сервиса.

iOS

wails3 ios <subcommand>:

Подкоманда Описание
ios overlay:gen Создаёт оверлей Go для промежуточного слоя моста iOS.
ios xcode:gen Создаёт проект Xcode в каталоге вывода.

Пути результатов сборки

  • Нативные бинарные файлы помещаются в bin/<APP_NAME> (или в bin/<APP_NAME>.exe в Windows). build/bin/ не существует.
  • Упакованные результаты (.app, .dmg, установщик NSIS, MSIX, DEB/RPM/AppImage) также помещаются в bin/ (либо в платформенные подкаталоги, созданные соответствующей задачей Taskfile).

Глобальные флаги

Флаг Применяется к Описание
--no-colour Все команды Отключает цвета ANSI в выводе CLI.

Есть вопросы? Задайте их в Discord или ознакомьтесь с примерами.

Редактировать страницу

Последнее обновление: