msix 3.7.0 msix: ^3.7.0 copied to clipboard
A command-line tool that create Msix installer from your flutter windows-build files.
MSIX is a Windows app packaging format from Microsoft that combines the best features of MSI, .appx, App-V, and ClickOnce to provide a modern and reliable packaging experience.
This package offers a command line tool for creating MSIX installers from your Flutter app, making it easy to publish your app to the Microsoft Store or host it on a website.
📋 Installation #
pubspec.yaml, add the
msix package as a new dev dependency with
the following command:
PS c:\src\flutter_project> flutter pub add --dev msix
📦 Creating an MSIX installer #
To create a MSIX installer, run the following command:
PS c:\src\flutter_project> flutter pub run msix:create
⚙️ Configuring your installer #
You will almost certainly want to customize various settings in the MSIX
installer, such as the application title, the default icon, and which Windows
capabilities your application needs. You can customize the generated MSIX
installer by adding declarations to an
msix_config: node in your
msix_config: display_name: Flutter App publisher_display_name: Company Name identity_name: company.suite.flutterapp msix_version: 188.8.131.52 logo_path: C:\path\to\logo.png capabilities: internetClient, location, microphone, webcam
Available Configurations #
MSIX configuration (click to expand)
|YAML name||Command-line argument||Description (from Microsoft Package manifest schema reference)||Example|
|A friendly app name that can be displayed to users.|
|A friendly name for the publisher that can be displayed to users.|
|Defines the unique identifier for the app.|
|The version number of the package, in |
|Path to an image file for use as the app icon (size recommended at least 400x400px).|
|List of the capabilities the app requires.|
|Declares the language resources contained in the package.|
|File extensions that the app may be registered to open.|
|Protocols activation that will activate the app.|
|Enable apps for websites using app URI handlers app.|
|Execution alias command (cmd) that will activate the app.|
|App start at startup or user log-in.|
|Generate a MSIX file for publishing to the Microsoft Store.|
|Toast Notifications configuration|
Build configuration (click to expand)
|YAML name||Command-line argument||Description||Example|
|Create MSIX from the debug or release build files (|
|The directory where the output MSIX file should be stored.|
|The filename that should be given to the created MSIX file.|
|Describes the architecture of the code in the package, |
Sign configuration (click to expand)
|YAML name||Command-line argument||Description||Example|
|Path to the certificate content to place in the store.|
|Password for the certificate.|
Required only if publish to the store, or if the
|Options to be provided to the |
Note: when false,
✒️ Signing options #
Published MSIX installers should be signed with a certificate, to help ensure that app installs and updates come from trustworthy sources.
- For development purposes, this package is configured by default to automatically sign your app with a self signed test certificate, which makes it easy to test your install prior to release.
- If you publish your app to the Microsoft Store, the installation package will be signed automatically by the store.
- If you need to use your own signing certificate, for example to release
the app outside of the Microsoft Store, you can use the configuration fields
certificate_passwordto configure a certificate of your choice.
You can also provide custom options to the signing tool with the
--signtool-options command, as shown above. For more information on available
options, see the signtool documentation. Note that using this option overrides
Note: By default, the MSIX package will install the certificate on your
machine. You can disable this by using the
--install-certificate false option, or the YAML
Publishing to the Microsoft Store #
To generate an MSIX file for publishing to the Microsoft Store, use the
--store flag, or alternatively add
store: true to the YAML configuration.
Note: For apps published to the Microsoft Store, the configuration values
all be configured and should match the registered publisher and app name from
the Microsoft Store dashboard, as per this screenshot.
🌐 Publishing outside the store #
You can use the App Installer file to enable your users to install and update the app from local file share.
Note: installing from the web
ms-appinstaller: is disabled for now.
To create a App Installer file, first set the
then run the following command:
PS c:\src\flutter_project> flutter pub run msix:publish
Available configurations for App Installer (click to expand)
App Installer configuration example:
msix_config: display_name: Flutter App app_installer: #<-- app installer configuration publish_folder_path: c:\path\to\myPublishFolder hours_between_update_checks: 0 automatic_background_task: true update_blocks_activation: true show_prompt: true force_update_from_any_version: false msix_version: 184.108.40.206
|YAML name||Command-line argument||Description (from Microsoft schema reference)||Example|
|A path to publish folder, where the msix versions and the .appinstaller file will be saved.|
|Defines the minimal time gap between update checks, when the user open the app. default is 0 (will check for update every time the app opened)|
|Checks for updates in the background every 8 hours independently of whether the user launched the app.|
|Defines the experience when an app update is checked for.|
|Defines if a window is displayed when updates are being installed, and when updates are being checked for.|
|Allows the app to update from version x to version x++ or to downgrade from version x to version x--.|
⚠️ Unsupported Features #
We added the most common features of Msix in this package, however, if you need to add or edit a feature that is not supported yet, you can do this manually.
First, create the unpackaged msix files with the following command
PS c:\src\flutter_project> flutter pub run msix:build
Then edit the files that were created in the build folder.
After that create a msix installer file from those files with the following command
PS c:\src\flutter_project> flutter pub run msix:pack