Important
Installation • Usage • Documentation • GUI • Feedback
The Windows App Development CLI is a single command-line interface for managing Windows SDKs, packaging, generating app identity, manifests, certificates, and using build tools with any app framework. This tool bridges the gap between cross-platform development and Windows-native capabilities.
Whether you're building with Electron, .NET/Win32, CMake, or Python, this CLI gives you access to:
- Modern Windows APIs - Windows App SDK and Windows SDK with automatic setup and code generation
- App Identity - Debug and test by adding app identity without full packaging in a snap
- MSIX Packaging - App packaging with signing and Store readiness
- Developer Tools - Manifests, certificates, assets, and build integration
Perfect for:
- Electron/cross-platform developers wanting native Windows features or targeting Windows
- Developers testing and deploying adding app identity for development or packaging for deployment
- CI/CD pipelines automating Windows app builds
Checkout our getting started guides for step by step instructions:
- Electron guide: step by step guide of using Windows App SDK APIs in a new Electron application with a C# addon, debugging with identity, and MSIX packaging.
- Packaging an EXE/CLI: step by step guide of packaging an existing exe/cli as MSIX
The easiest way to use the CLI is via WinGet (Windows Package Manager). In Terminal, simply run:
winget install Microsoft.WinAppCli
You can install the CLI for Electron projects via NPM:
npm install @microsoft/winappcli --save-dev
Download the latest build from GitHub Releases: 👉 Download Latest Build
Once installed (see Installation above), verify the installation by calling the CLI:
winapp --helpor if using Electron/Node.js
npx winapp --helpSetup Commands:
init- Initialize project with Windows SDK and App SDKrestore- Restore packages and dependenciesupdate- Update packages and dependencies to latest versions
App Identity & Debugging:
package- Create MSIX packages from directoriescreate-debug-identity- Add temporary app identity for debuggingmanifest- Generate and manage AppxManifest.xml files
Certificates & Signing:
Development Tools:
tool- Access Windows SDK toolsget-winapp-path- Get paths to installed SDK components
Node.js/Electron Specific:
node create-addon- Generate native C# or C++ addonsnode add-electron-debug-identity- Add identity to Electron processes- Windows AI Addon for Electron - The Windows AI Addon for Electron is a Node.js native addon that provides access to the Windows AI APIs directly from JavaScript.
The full CLI usage can be found here: Documentation
This repository will continue to be added with samples. Currently the following samples exist:
- Electron sample: a default Electron Forge generated application + initialized a winapp project with appxmanifest, assets + native addon + C# addon + generates cert
- Electron WinML sample: a simple Electron application using Windows ML for classifying images
- File an issue, feature request or bug: please ensure that you are not filing a duplicate issue
- Send feedback to windowsdevelopertoolkit@microsoft.com: Do you love this tool? Are there features or fixes you want to see? Let us know!
We are actively working on improving Node and Python support. These features are experimental and we are aware of several issues with these app types.
This repository also contains an experimental app (GUI) that wraps the CLI and provides an intuitive, drag-and-drop experience. See the docs for more details. Download the app here.
Need help or have questions about the Windows App Development CLI? Visit our Support Guide for information about our issue templates and triage process.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit Contributor License Agreements.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
To build the CLI:
# Build the CLI and package for npm from the repo root
.\scripts\build-cli.ps1
The binaries and packages will be placed in the artifacts folder
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.