npx skills add ...
npx skills add microsoft/winappcli --skill winapp-identity
npx skills add microsoft/winappcli --skill winapp-identity
Enable Windows package identity for desktop apps to access Windows APIs like push notifications, background tasks, share target, and startup tasks. Use when adding Windows notifications, background tasks, or other identity-requiring Windows features to a desktop app.
Use this skill when:
electron.exe is in node_modules, not your build outputAllowExternalContent, TrustedLaunch, etc.create-debug-identity leaves the exe in placePrefer
winapp runfor most frameworks. If your exe is inside your build output folder (.NET, C++, Rust, Flutter, Tauri), usewinapp run <build-output>instead — it registers a full loose layout package and launches the app, simulating an MSIX install. Usecreate-debug-identityonly whenwinapp rundoesn't fit your scenario.
Package.appxmanifest in your project — from winapp init or winapp manifest generate.exe your app runs fromWindows package identity enables your app to use restricted APIs and OS integration features:
A standard .exe (from dotnet build, cmake, etc.) does not have identity. create-debug-identity registers a sparse package with Windows — the exe stays in its original location and Windows associates identity with it via Add-AppxPackage -ExternalLocation. This is different from winapp run, which copies files into a loose layout package.
Package.appxmanifest — extracts identity, capabilities, and assets.debug to the package name (unless --keep-identity) to avoid conflictsAdd-AppxPackage -ExternalLocation — makes your exe "identity-aware"After running, launch your exe normally — Windows will recognize it as having package identity.
winapp init . --use-defaults (creates Package.appxmanifest)winapp cert generatewinapp create-debug-identity ./bin/myapp.exePackage.appxmanifest or Assets/create-debug-identity after any changes to Package.appxmanifest or image assetsGet-AppxPackage *yourapp.debug* | Remove-AppxPackage--keep-identity carefullynpx winapp node add-electron-debug-identity instead (handles Electron-specific paths)winapp run vs create-debug-identitywinapp run | create-debug-identity | |
|---|---|---|
| What it registers | Full loose layout package (entire folder) | Sparse package (single exe) |
| How the app launches | Launched by winapp (AUMID activation or execution alias) | You launch the exe yourself (command line, IDE, etc.) |
| Simulates MSIX install | Yes — closest to production behavior | No — sparse identity only |
| Files stay in place | Copied to an AppX layout directory | Yes — exe stays at its original path |
| Debugger-friendly | Attach to PID after launch, or use --no-launch then launch via alias | Launch directly from your IDE's debugger — the exe has identity regardless |
| Console app support | --with-alias keeps stdin/stdout in terminal | Run exe directly in terminal |
| Best for | Most frameworks (.NET, C++, Rust, Flutter, Tauri) | Electron, or when you need full IDE debugger control (F5 startup debugging) |
Default to winapp run for most development — it simulates a real MSIX install with full identity, capabilities, and file associations:
Use create-debug-identity when:
electron.exe is in node_modules/AllowExternalContent, TrustedLaunch| Scenario | Command | Notes |
|---|---|---|
| Just run with identity | winapp run .\build\Debug | Simplest workflow; add --with-alias for console apps |
| Attach debugger to running app | winapp run .\build\Debug, then attach to PID | Misses startup code |
| Register identity, launch via AUMID | winapp run .\build\Debug --no-launch | Launch with start shell:AppsFolder\<AUMID> or the execution alias (not the exe directly) |
| F5 startup debugging | winapp create-debug-identity .\bin\myapp.exe | IDE controls process from first instruction; best for debugging activation/startup code |
| Capture debug output | winapp run .\build\Debug --debug-output | Captures OutputDebugString; on crash, writes minidump and analyzes managed exceptions automatically. Blocks other debuggers (one debugger per process) |
| Run and auto-clean | winapp run .\build\Debug --unregister-on-exit | Unregisters the dev package after the app exits |
| Launch and detach (CI) | winapp run .\build\Debug --detach | Returns immediately after launch; use --json to get PID for scripting |
| Clean up stale registration | winapp unregister | Removes dev packages for the current project (auto-detects from manifest) |
Using Visual Studio with a packaging project? VS already handles identity, AUMID activation, and debugger attachment from F5. These workflows are most useful for VS Code, terminal-based development, and frameworks VS doesn't natively package (Rust, Flutter, Tauri, Electron, C++).
For full details including IDE setup examples, see the Debugging Guide.
winapp-manifest to generate Package.appxmanifestwinapp-signing — a trusted cert is required for identity registrationwinapp-package to create an installerwinapp-troubleshoot for common error solutions| Error | Cause | Solution |
|---|---|---|
| "Package.appxmanifest not found" | No manifest in current directory | Run winapp init or winapp manifest generate, or pass --manifest |
| "Failed to add package identity" | Previous registration stale or cert untrusted | Run winapp unregister to remove stale packages, then winapp cert install ./devcert.pfx (admin) |
| "Access denied" | Cert not trusted or permission issue | Run winapp cert install ./devcert.pfx as admin |
| APIs still fail after registration | App launched before registration completed | Close app, re-run create-debug-identity, then relaunch |
winapp create-debug-identityEnable package identity for debugging without creating full MSIX. Required for testing Windows APIs (push notifications, share target, etc.) during development. Example: winapp create-debug-identity ./myapp.exe. Requires Package.appxmanifest or appxmanifest.xml in current directory or passed via --manifest. Re-run after changing the manifest or Assets/.
| Argument | Required | Description |
|---|---|---|
<entrypoint> | No | Path to the .exe that will need to run with identity, or entrypoint script. |
| Option | Description | Default |
|---|---|---|
--keep-identity | Keep the package identity from the manifest as-is, without appending '.debug' to the package name and application ID. | (none) |
--manifest | Path to the Package.appxmanifest or appxmanifest.xml | (none) |
--no-install | Do not install the package after creation. | (none) |
# By default, '.debug' is appended to the package name to avoid conflicts with
# an installed MSIX version. Use --keep-identity to keep the manifest identity as-is.
winapp create-debug-identity ./myapp.exe --keep-identity# Create the sparse package layout but don't register it with Windows
winapp create-debug-identity ./myapp.exe --no-installwinapp run .\build\output # GUI apps
winapp run .\build\output --with-alias # console apps (preserves stdin/stdout)winapp create-debug-identity .\bin\Debug\myapp.exe
# Now launch any way you like — F5, terminal, script — the exe has identity