mirror of https://github.com/microsoft/PowerToys.git synced 2026-05-18 05:05:25 +02:00

Files

Niels Laute 0819a6268b [CmdPal] Move dev docs to doc/devdocs/modules/cmdpal (#46926 )

## Summary

Move Command Palette developer documentation from
\src/modules/cmdpal/doc\ to \doc/devdocs/modules/cmdpal\, consistent
with the location of other module dev docs.

Also updates the spell-check exclude path for the moved \.pdn\ file.

Points 2 and 3 from the issue (extension settings how-to and details
pane markdown documentation) are addressed in the windows-dev-docs-pr
repo.

Closes #38107

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

2026-04-12 12:33:30 -05:00

2.6 KiB

Raw Blame History

Local PowerToys Extension Development

This guide is for iterating on src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.PowerToys/Microsoft.CmdPal.Ext.PowerToys.csproj.

The extension is registered through the shared sparse package defined in src/PackageIdentity/AppxManifest.xml. That manifest declares Microsoft.CmdPal.Ext.PowerToys.exe at the sparse package root, so the sparse package and the extension must be built for the same platform and configuration, for example x64\Debug.

Local development loop

Build src/PackageIdentity/PackageIdentity.vcxproj.

This creates PowerToysSparse.msix in the repo output root for the selected platform and configuration, and prints the Add-AppxPackage command you should run next.
Trust the development certificate before running Add-AppxPackage.

The PackageIdentity build creates or reuses src/PackageIdentity/.user/PowerToysSparse.certificate.sample.cer.

Import it into CurrentUser\TrustedPeople:
```
$repoRoot = "C:/git/PowerToys"
Import-Certificate -FilePath "$repoRoot/src/PackageIdentity/.user/PowerToysSparse.certificate.sample.cer" -CertStoreLocation Cert:\CurrentUser\TrustedPeople
```
If Windows still reports a trust failure such as 0x800B0109, also import the same certificate into Cert:\CurrentUser\TrustedRoot.
Run the Add-AppxPackage command printed by the PackageIdentity build.

That registers Microsoft.PowerToys.SparseApp as a sparse package and points it at the matching output root through -ExternalLocation.

The command will look like this:
```
Add-AppxPackage -Path "<repo>\<Platform>\<Configuration>\PowerToysSparse.msix" -ExternalLocation "<repo>\<Platform>\<Configuration>"
```
Build src/modules/cmdpal/ext/Microsoft.CmdPal.Ext.PowerToys/Microsoft.CmdPal.Ext.PowerToys.csproj in the same platform and configuration.

This project writes Microsoft.CmdPal.Ext.PowerToys.exe directly into the sparse package root, such as x64\Debug or ARM64\Debug. That matches the Executable="Microsoft.CmdPal.Ext.PowerToys.exe" entry in src/PackageIdentity/AppxManifest.xml.
Restart Command Palette.

Close any running CmdPal instance and launch it again so it reloads app extensions and picks up the rebuilt Microsoft.CmdPal.Ext.PowerToys binaries.

When to repeat each step

Rebuild and re-register PackageIdentity when the sparse package manifest changes, the signing certificate changes, or you switch to a different output root such as ARM64\Debug.
For normal code changes in Microsoft.CmdPal.Ext.PowerToys, rebuilding the extension project and restarting CmdPal is enough.

2.6 KiB Raw Blame History

Local PowerToys Extension Development

Local development loop

When to repeat each step

2.6 KiB

Raw Blame History