Microsoft PowerToys

https://learn.microsoft.com/en-us/windows/powertoys/
Admin
Microsoft PowerToys is a set of free, open-source utilities designed to help power users and...
Tokens:209,154
Snippets:2,100
Trust Score:10
Update:6 days ago
Show doc for...
Tokens:
Raw
### Build installer locally with PowerShell

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension-winget

Verifies .NET 9 and Inno Setup are installed, builds the installer with build-exe.ps1, and lists the generated installer file. Requires .NET 9 and Inno Setup installed locally.

```powershell
# verify .Net 9 is installed
dotnet --version

# verify Inno Setup is installed
Test-Path "${env:ProgramFiles(x86)}\Inno Setup 6\iscc.exe"

# build installer, this step takes a while
.\build-exe.ps1 -Version "0.0.1.0"

# verify that <ExtensionName>-Setup-0.0.1.0.exe is listed
Get-ChildItem "bin\Release\installer\" -File

```

--------------------------------

### Install and verify WingetCreate

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension-winget

Install wingetcreate if not already installed, then verify the installation with wingetcreate --version.

```powershell
# Install wingetcreate if not already installed
winget install Microsoft.WingetCreate

# Verify installation
wingetcreate --version

```

--------------------------------

### Copilot prompt to generate winget install command

Source: https://learn.microsoft.com/en-us/windows/powertoys/install

Example prompt for Copilot to generate a winget command that installs PowerToys silently and logs output to C:\temp\install.log. Customize the prompt to fit your requirements.

```text
Generate a `winget` command to install Microsoft PowerToys with arguments to install silently and log the output to a file at the following path: C:\temp\install.log

```

--------------------------------

### GitHub Actions workflow for building and releasing extension EXE installer

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension-winget

Use this workflow template to automate the build and release of a Command Palette extension EXE installer. It requires updating the global constants (GITHUB_REPO_URL, DISPLAY_NAME, EXTENSION_NAME, FOLDER_NAME) and copying the file to a new workflow file. The workflow builds x64 and ARM64 installers, uploads them as artifacts, creates a GitHub release, and prints a build summary.

```yaml
# TEMPLATE: Extension EXE Installer Build and Release Workflow
# 
# To use this template for a new extension:
# 1. Copy this file to a new workflow file (e.g., release-myextension-exe.yml)
# 2. Update Global constants with your data:
# - GITHUB_REPO_URL with your GitHub repository URL (e.g., https://github.com/yourusername/YourRepository)
# - DISPLAY_NAME with your display name (e.g., My Extension)
# - EXTENSION_NAME with your extension name (e.g., CmdPalMyExtension)
# - FOLDER_NAME with your project folder name (e.g., CmdPalMyExtension)

name: CmdPal Extension - Build EXE Installer

on:
  workflow_dispatch:
    inputs:
      version:
        description: 'Version number (leave empty to auto-detect)'
        required: false
        type: string
      release_notes:
        description: 'What is new in this version'
        required: false
        default: 'New release with latest updates and improvements.'
        type: string


# Global constants: UPDATE THESE, example; DISPLAY_NAME: ${{ vars.DISPLAY_NAME || 'CmdPal Name' }}
env:
  DISPLAY_NAME: ${{ vars.DISPLAY_NAME || 'DISPLAY_NAME' }}
  EXTENSION_NAME: ${{ vars.EXTENSION_NAME || 'EXTENSION_NAME' }}
  FOLDER_NAME: ${{ vars.FOLDER_NAME || 'FOLDER_NAME' }}
  GITHUB_REPO_URL: ${{ vars.GITHUB_REPO_URL || 'GITHUB_REPO_URL' }}


jobs:
  build:
    runs-on: windows-2022
    permissions:
      contents: write
      actions: read
    
    steps:
    - name: Checkout code
      uses: actions/checkout@v4
    
    - name: Setup .NET 9
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: '9.0.x'
    
    - name: Install Inno Setup
      run: choco install innosetup -y --no-progress
      shell: pwsh
    
    - name: Get version from project
      id: version
      run: |
        if ("${{ github.event.inputs.version }}" -ne "") {
          $version = "${{ github.event.inputs.version }}"
        } else {
          $projectFile = "${{ env.FOLDER_NAME }}/${{ env.EXTENSION_NAME }}.csproj"
          $xml = [xml](Get-Content $projectFile)
          $version = $xml.Project.PropertyGroup.AppxPackageVersion | Select-Object -First 1
          if (-not $version) { throw "Version not found in project file" }
        }
        echo "VERSION=$version" >> $env:GITHUB_OUTPUT
        Write-Host "Using version: $version"
      shell: pwsh
    
    - name: Build EXE installers (x64 and ARM64)
      run: |
        Set-Location "${{ env.FOLDER_NAME }}/${{ env.FOLDER_NAME }}"
        .\build-exe.ps1 -Version "${{ steps.version.outputs.VERSION }}" -Platforms @("x64", "arm64")
      shell: pwsh
    
    - name: Upload x64 installer artifact
      uses: actions/upload-artifact@v4
      with:
        name: ${{ env.EXTENSION_NAME }}-x64-installer
        path: ${{ env.FOLDER_NAME }}/bin/Release/installer/*-x64.exe
        if-no-files-found: error

    - name: Upload ARM64 installer artifact
      uses: actions/upload-artifact@v4
      with:
        name: ${{ env.EXTENSION_NAME }}-arm64-installer
        path: ${{ env.FOLDER_NAME }}/bin/Release/installer/*-arm64.exe
        if-no-files-found: warn
    
    - name: Create GitHub Release
      uses: softprops/action-gh-release@v1
      with:
        tag_name: ${{ env.EXTENSION_NAME }}-v${{ steps.version.outputs.VERSION }}
        name: "${{ env.DISPLAY_NAME }} v${{ steps.version.outputs.VERSION }}"
        body: |
          ## 🎯 ${{ env.DISPLAY_NAME }} ${{ steps.version.outputs.VERSION }}
          
          ## What's New
          ${{ github.event.inputs.release_notes }}
          
          ## 📦 Installation
          
          Download the installer for your system architecture:
          
          - **x64 (Intel/AMD)**: `${{ env.DISPLAY_NAME }}-Setup-${{ steps.version.outputs.VERSION }}-x64.exe`
          - **ARM64 (Windows on ARM)**: `${{ env.DISPLAY_NAME }}-Setup-${{ steps.version.outputs.VERSION }}-arm64.exe`
          
          1. Download the appropriate installer from the Assets section below
          2. Run the installer with administrator privileges
          3. The extension will be registered and available in Command Palette
          
          
          ## 🔗 More Information
          
          Repository: ${{ env.GITHUB_REPO_URL }}
        files: ${{ env.FOLDER_NAME }}/bin/Release/installer/*.exe
        draft: false
        prerelease: false
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    
    - name: Build summary
      run: |
        Write-Host "🎉 ${{ env.DISPLAY_NAME }} Release Complete!" -ForegroundColor Green
        Write-Host "Version: ${{ steps.version.outputs.VERSION }}" -ForegroundColor Yellow
        Write-Host "📁 Installer uploaded to GitHub Release" -ForegroundColor Green
      shell: pwsh

```

--------------------------------

### Install PowerToys using Scoop

Source: https://learn.microsoft.com/en-us/windows/powertoys/install

Run these commands in PowerShell or command line to add the extras bucket and install PowerToys via Scoop. The first command adds the bucket, the second installs the package.

```powershell
scoop bucket add extras
scoop install powertoys

```

--------------------------------

### Example output of Get-WindowsCapability for OCR language packs

Source: https://learn.microsoft.com/en-us/windows/powertoys/text-extractor

Example output from the Get-WindowsCapability command, showing the language code and state for each OCR language pack. Languages with State: NotPresent must be installed before they can be used.

```PowerShell
Name  : Language.OCR~~~el-GR~0.0.1.0
State : NotPresent

Name  : Language.OCR~~~en-GB~0.0.1.0
State : NotPresent

Name  : Language.OCR~~~en-US~0.0.1.0
State : Installed

Name  : Language.OCR~~~es-ES~0.0.1.0
State : NotPresent

Name  : Language.OCR~~~es-MX~0.0.1.0
State : NotPresent

```

--------------------------------

### Image Resizer CLI usage examples

Source: https://learn.microsoft.com/en-us/windows/powertoys/image-resizer

Examples of using the Image Resizer CLI from PowerShell. Includes showing help, displaying current configuration, resizing with explicit dimensions, using preset size 0 with a custom output directory, and preserving the source LastWriteTime.

```powershell
# Show help
PowerToys.ImageResizerCLI.exe --help

# Show current config
PowerToys.ImageResizerCLI.exe --show-config

# Resize with explicit dimensions
PowerToys.ImageResizerCLI.exe --width 800 --height 600 .\image.png

# Use preset size 0 (Custom) and output to a folder
PowerToys.ImageResizerCLI.exe --size 0 -d "C:\Output" .\photo.png

# Preserve source LastWriteTime
PowerToys.ImageResizerCLI.exe --width 800 --height 600 --keep-date-modified -d "C:\Output" .\image.png
```

--------------------------------

### Install and configure with WinGet (complete-setup.dsc.config.winget)

Source: https://learn.microsoft.com/en-us/windows/powertoys/dsc-configure/microsoft-dsc

DSC configuration file that installs PowerToys via WinGet and configures app settings and PowerToys Run. Save as complete-setup.dsc.config.winget.

```yaml
# yaml-language-server: $schema=https://aka.ms/configuration-dsc-schema/0.2
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
metadata:
  winget:
    processor: dscv3
resources:
  - name: Install PowerToys
    type: Microsoft.WinGet.DSC/WinGetPackage
    properties:
      id: Microsoft.PowerToys
      source: winget
      ensure: Present
  
  - name: Enable utilities
    type: Microsoft.PowerToys/AppSettings
    properties:
      settings:
        properties:
          startup: true
          theme: "dark"
        name: App
        version: 1.0
  
  - name: Configure PowerToys Run
    type: Microsoft.PowerToys/PowerLauncherSettings
    properties:
      settings:
        properties:
          maximum_number_of_results: 8
          clear_input_on_launch: true
        name: PowerLauncher
        version: 1.0

```

--------------------------------

### C# example page with CommandResult examples

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/command-results

Replace GetItems in /Pages/<ExtensionName>Page.cs with this code. It creates a ListPage with commands that demonstrate CommandResult.KeepOpen, Hide, GoBack, GoHome, Dismiss, ShowToast, and Confirm. The Confirm command uses ConfirmationArgs with an AnonymousCommand that shows a ToastStatusMessage.

```csharp
using Microsoft.CommandPalette.Extensions;
using Microsoft.CommandPalette.Extensions.Toolkit;

internal sealed partial class <ExtensionName>Page : ListPage
{
    public <ExtensionName>Page()
    {
        Icon = IconHelpers.FromRelativePath("Assets\\StoreLogo.png");
        Title = "Example command results";
        Name = "Open";
    }

    public override IListItem[] GetItems()
    {
        ConfirmationArgs confirmArgs = new()
        {
            PrimaryCommand = new AnonymousCommand(
                () =>
                {
                    ToastStatusMessage t = new("The dialog was confirmed");
                    t.Show();
                })
            {
                Name = "Confirm",
                Result = CommandResult.KeepOpen(),
            },
            Title = "You can set a title for the dialog",
            Description = "Are you really sure you want to do the thing?",
        };

        return
        [
            new ListItem(new AnonymousCommand(null) { Result = CommandResult.KeepOpen() }) { Title = "Keep the palette open" },
            new ListItem(new AnonymousCommand(null) { Result = CommandResult.Hide() }) { Title = "Hide the palette" },
            new ListItem(new AnonymousCommand(null) { Result = CommandResult.GoBack() }) { Title = "Go back" },
            new ListItem(new AnonymousCommand(null) { Result = CommandResult.GoHome() }) { Title = "Go home" },
            new ListItem(new AnonymousCommand(null) { Result = CommandResult.Dismiss() }) { Title = "Dismiss the palette" },
            new ListItem(new AnonymousCommand(null) { Result = CommandResult.ShowToast("What's up") }) { Title = "Show a toast" },
            new ListItem(new AnonymousCommand(null) { Result = CommandResult.Confirm(confirmArgs) }) { Title = "Confirm something" },
        ];
    }
}

```

--------------------------------

### PowerShell build script template (build-exe.ps1)

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension-winget

Template for building Command Palette extensions. Update the $ExtensionName and $Version parameters. The script cleans bin/obj, restores packages, publishes for x64 and arm64, generates platform-specific Inno Setup scripts, and creates installers. Requires Inno Setup 6 installed.

```powershell
# TEMPLATE: PowerShell Build Script for Command Palette Extensions
#
# To use this template for a new extension:
# 1. Copy this file to your extension's project folder as "build-exe.ps1"
# 2. Update in param():
#   - EXTENSION_NAME with your extension name (e.g., CmdPalMyExtension) 
#   - VERSION with your extension version (e.g., 0.0.1.0)



param(
    [string]$ExtensionName = "UPDATE",  # Change to your extension name
    [string]$Configuration = "Release",
    [string]$Version = "UPDATE",  # Change to your version
    [string]$Platform = @("x64", "arm64")
)

$ErrorActionPreference = "Stop"

Write-Host "Building $ExtensionName EXE installer..." -ForegroundColor GreenWrite-Host "Version: $Version" -ForegroundColor Yellow
Write-Host "Platforms: $($Platforms -join ', ')" -ForegroundColor Yellow


$ProjectDir = Split-Path -Parent $MyInvocation.MyCommand.Path
$ProjectFile = "$ProjectDir\$ExtensionName.csproj"

# Clean previous builds
Write-Host "Cleaning previous builds..." -ForegroundColor Yellow
if (Test-Path "$ProjectDir\bin") { 
    Remove-Item -Path "$ProjectDir\bin" -Recurse -Force -ErrorAction SilentlyContinue 
}
if (Test-Path "$ProjectDir\obj") { 
    Remove-Item -Path "$ProjectDir\obj" -Recurse -Force -ErrorAction SilentlyContinue 
}

# Restore packages
Write-Host "Restoring NuGet packages..." -ForegroundColor Yellow
dotnet restore $ProjectFile

# Build for each platform
foreach ($Platform in $Platforms) {
    Write-Host "`n=== Building $Platform ===" -ForegroundColor Cyan
    
    # Build and publish
    Write-Host "Building and publishing $Platform application..." -ForegroundColor Yellow
    dotnet publish $ProjectFile `
        --configuration $Configuration `
        --runtime "win-$Platform" `
        --self-contained true `
        --output "$ProjectDir\bin\$Configuration\win-$Platform\publish"

    if ($LASTEXITCODE -ne 0) { 
        Write-Warning "Build failed for $Platform with exit code: $LASTEXITCODE"
        continue
    }
# Check if files were published
    $publishDir = "$ProjectDir\bin\$Configuration\win-$Platform\publish"
    $fileCount = (Get-ChildItem -Path $publishDir -Recurse -File).Count
    Write-Host "✅ Published $fileCount files to $publishDir" -ForegroundColor Green

    # Create platform-specific setup script
    Write-Host "Creating installer script for $Platform..." -ForegroundColor Yellow
    $setupTemplate = Get-Content "$ProjectDir\setup-template.iss" -Raw
    
    # Update version
    $setupScript = $setupTemplate -replace '#define AppVersion ".*"', "#define AppVersion `"$Version`""
    
    # Update output filename to include platform suffix
    $setupScript = $setupScript -replace 'OutputBaseFilename=(.*?)\{#AppVersion\}', "OutputBaseFilename=`$1{#AppVersion}-$Platform"
    
    # Update source path for the platform
    $setupScript = $setupScript -replace 'Source: "bin\\Release\\win-x64\\publish', "Source: `"bin\Release\win-$Platform\publish"
    
    # Add architecture settings after [Setup] section
    if ($Platform -eq "arm64") {
        $setupScript = $setupScript -replace '(\[Setup\][^\[]*)(MinVersion=)', "`$1ArchitecturesAllowed=arm64`r`nArchitecturesInstallIn64BitMode=arm64`r`n`$2"
    } else {
        $setupScript = $setupScript -replace '(\[Setup\][^\[]*)(MinVersion=)', "`$1ArchitecturesAllowed=x64compatible`r`nArchitecturesInstallIn64BitMode=x64compatible`r`n`$2"
    }
    
    $setupScript | Out-File -FilePath "$ProjectDir\setup-$Platform.iss" -Encoding UTF8

    # Create installer with Inno Setup
    Write-Host "Creating $Platform installer with Inno Setup..." -ForegroundColor Yellow
    $InnoSetupPath = "${env:ProgramFiles(x86)}\Inno Setup 6\iscc.exe"
    if (-not (Test-Path $InnoSetupPath)) { 
        $InnoSetupPath = "${env:ProgramFiles}\Inno Setup 6\iscc.exe" 
    }

    if (Test-Path $InnoSetupPath) {
        & $InnoSetupPath "$ProjectDir\setup-$Platform.iss"
        
        if ($LASTEXITCODE -eq 0) {
            $installer = Get-ChildItem "$ProjectDir\bin\$Configuration\installer\*-$Platform.exe" -ErrorAction SilentlyContinue | Select-Object -First 1
            if ($installer) {
                $sizeMB = [math]::Round($installer.Length / 1MB, 2)
                Write-Host "✅ Created $Platform installer: $($installer.Name) ($sizeMB MB)" -ForegroundColor Green
            } else {
                Write-Warning "Installer file not found for $Platform"
            }
        } else {
            Write-Warning "Inno Setup failed for $Platform with exit code: $LASTEXITCODE"
        }
    } else {
        Write-Warning "Inno Setup not found at expected locations"
    }
}

Write-Host "`n🎉 Build completed successfully!" -ForegroundColor Green

```

--------------------------------

### Create bundle_mapping.txt

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension-store

Creates a bundle mapping file that lists the paths to the x64 and ARM64 MSIX files. Update the paths to match your actual MSIX files.

```text
[Files]
"AppPackages\<ExtensionName>_<VersionNumber>_x64_Test\<ExtensionName>_<VersionNumber>_x64.msix" "<ExtensionName>_<VersionNumber>_x64.msix"
"AppPackages\t<ExtensionName>_<VersionNumber>_arm64_Test\<ExtensionName>_<VersionNumber>_arm64.msix" "<ExtensionName>_<VersionNumber>_arm64.msix"

```

--------------------------------

### Inno Setup template setup-template.iss

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension-winget

Template for creating a setup-template.iss file for a simple extension. Replace EXTENSION_NAME, DISPLAY_NAME, DEVELOPER_NAME, and CLSID-HERE as instructed.

```ini
; TEMPLATE: Inno Setup Script for Command Palette Extensions
;
; To use this template for a new extension:
; 1. Copy this file to your extension's project folder as "setup-template.iss"
; 2. Replace EXTENSION_NAME with your extension name (e.g., CmdPalMyExtension)
; 3. Replace DISPLAY_NAME with your extension's display name (e.g., My Extension)
; 4. Replace DEVELOPER_NAME with your name (e.g., Your Name Here)
; 5. Replace CLSID-HERE with extensions CLSID
; 6. Update the default version to match your project file

#define AppVersion "0.0.1.0"

[Setup]
AppId={{GUID-HERE}}
AppName=DISPLAY_NAME
AppVersion={#AppVersion}
AppPublisher=DEVELOPER_NAME
DefaultDirName={autopf}\EXTENSION_NAME
OutputDir=bin\Release\installer
OutputBaseFilename=EXTENSION_NAME-Setup-{#AppVersion}
Compression=lzma
SolidCompression=yes
MinVersion=10.0.19041

[Languages]
Name: "english"; MessagesFile: "compiler:Default.isl"

[Files]
Source: "bin\Release\win-x64\publish\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs

[Icons]
Name: "{group}\DISPLAY_NAME"; Filename: "{app}\EXTENSION_NAME.exe"

[Registry]
Root: HKCU; Subkey: "SOFTWARE\Classes\CLSID\{{CLSID-HERE}}"; ValueData: "EXTENSION_NAME"
Root: HKCU; Subkey: "SOFTWARE\Classes\CLSID\{{CLSID-HERE}}\LocalServer32"; ValueData: "{app}\EXTENSION_NAME.exe -RegisterProcessAsComServer"

```

--------------------------------

### Example CLSID attribute from <ExtensionName>.cs

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension-winget

Shows the [Guid("...")] attribute above the class declaration that provides the CLSID for the extension. This GUID is used in the next step.

```csharp
// Example from <ExtensionName>.cs
[Guid("0ab5d8ab-b206-4023-99f0-97dde26e14f2")]  // This is the CLSID
public sealed partial class <ExtensionName> : IExtension

```

--------------------------------

### Get OCR Language Capability for en-US

Source: https://learn.microsoft.com/en-us/windows/powertoys/text-extractor

Retrieves the Windows capability for the OCR language pack matching 'en-US'. This command is the first step before installing or removing the OCR pack.

```powershell
$Capability = Get-WindowsCapability -Online | Where-Object { $_.Name -Like 'Language.OCR*en-US*' }

```

--------------------------------

### CommandProvider.InitializeWithHost(IExtensionHost)

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/commandprovider

Initializes the command provider with the specified host.

```APIDOC
## InitializeWithHost(IExtensionHost)

### Description
Initializes the command provider with the specified host.

### Method
InitializeWithHost

### Signature
InitializeWithHost(IExtensionHost host)

### Parameters
- **host** (IExtensionHost) - Required - The host to initialize with.

### Return Value
None
```

--------------------------------

### TextSetting(String, String, String, String) Constructor

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/textsetting_constructor

Initializes a new instance of the TextSetting class with a key, label, description, and default value.

```APIDOC
## TextSetting(String, String, String, String) Constructor

### Description
Initializes a new instance of the TextSetting class with a key, label, description, and default value.

### Namespace
Microsoft.CommandPalette.Extensions.Toolkit

### Syntax
```csharp
public TextSetting(string key, string label, string description, string defaultValue)
    : base(key, label, description, defaultValue)
{
}
```

### Parameters
- **key** (String) - Required - The unique identifier for the setting.
- **label** (String) - Required - The display name of the setting.
- **description** (String) - Required - The description of the setting.
- **defaultValue** (String) - Required - The default value for the setting.
```

--------------------------------

### Extract MSI with dark.exe (PowerToys 0.93 and earlier)

Source: https://learn.microsoft.com/en-us/windows/powertoys/install

Uses WiX Toolset v3 'dark.exe' to extract the MSI from the PowerToys installer. Requires WiX Toolset v3 installed; does not work with v4+. Assumes default WiX install location and installer on desktop.

```powershell
cd $Env:WIX\"bin"

# dark.exe -x OUTPUT_FOLDER INSTALLER_PATH
.\dark.exe -x ${Env:\USERPROFILE}"\Desktop\extractedPath" ${Env:\USERPROFILE}"\Desktop\PowerToysSetup-0.53.0-x64.exe"
```

--------------------------------

### Create WinGet manifest with wingetcreate

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension-winget

Starts interactive wingetcreate to create a new package manifest. Replace the paths with your actual GitHub Release URLs for the x64 and arm64 .exe files. Press Enter to accept suggested values and answer No to optional modification questions, then Yes to submit.

```PowerShell
# Use your actual GitHub release URLs 
wingetcreate new "<PATH TO x64 .exe file>" "<PATH TO arm64 .exe file>"

```

--------------------------------

### Extract MSI with wix burn extract (PowerToys 0.94+)

Source: https://learn.microsoft.com/en-us/windows/powertoys/install

Uses WiX Toolset v4+ 'wix burn extract' to extract the MSI from the PowerToys installer. Requires .NET SDK and WiX Toolset installed via 'dotnet tool install wix --global'. Assumes the installer is on the desktop.

```powershell
wix burn extract ${Env:\USERPROFILE}"\Desktop\PowerToysSetup-0.94.0-x64.exe" -out ${Env:\USERPROFILE}"\Desktop\extractedPath" -oba ${Env:\USERPROFILE}"\Desktop\extractedPath"
```

--------------------------------

### Run makeappx with bundle mapping

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/publish-extension-store

Runs makeappx.exe with the bundle mapping file to create the bundle. Replace <PATH> with the actual path to makeappx.exe.

```powershell
& "<PATH>\makeappx.exe" bundle /f bundle_mapping.txt /p <ExtensionName>_<VersionNumber>_Bundle.msixbundle

```

--------------------------------

### Install specific PowerToys version and configure AlwaysOnTop

Source: https://learn.microsoft.com/en-us/windows/powertoys/dsc-configure/psdsc

YAML configuration that first installs PowerToys version 0.95.0 using Microsoft.WinGet.DSC/WinGetPackage, then configures AlwaysOnTop with the PowerToysConfigure resource, using dependsOn to ensure installation completes first.

```yaml
properties:
  resources:
    - resource: Microsoft.WinGet.DSC/WinGetPackage
      id: installPowerToys
      directives:
        description: Install PowerToys version 0.95.0
      settings:
        id: Microsoft.PowerToys
        source: winget
        version: "0.95.0"

    - resource: Microsoft.PowerToys.Configure/PowerToysConfigure
      dependsOn:
        - installPowerToys
      directives:
        description: Configure PowerToys utilities
      settings:
        AlwaysOnTop:
          Enabled: true
          Hotkey: "Win+Ctrl+T"
          FrameEnabled: true
          FrameThickness: 5
          FrameColor: "#FF0000FF"
  configurationVersion: 0.2.0
```

--------------------------------

### CommandProvider.InitializeWithHost(IExtensionHost) Method

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/commandprovider_initializewithhost

Initializes the command provider with the specified host instance. This method is typically called when the command provider is being registered with the command palette, allowing it to access the host's services and capabilities.

```APIDOC
## CommandProvider.InitializeWithHost(IExtensionHost) Method

### Description
Initializes the command provider with the specified host instance. This method is typically called when the command provider is being registered with the command palette, allowing it to access the host's services and capabilities.

### Namespace
Microsoft.CommandPalette.Extensions.Toolkit

### Method Signature
`InitializeWithHost(IExtensionHost _host)`

### Parameters
- **_host** (IExtensionHost) - Required - The host instance that provides access to the command palette's functionality. This parameter is used to initialize the command provider with the host's capabilities and services.

```

--------------------------------

### Apply WinGet Configuration

Source: https://learn.microsoft.com/en-us/windows/powertoys/dsc-configure/psdsc

Command to apply the configuration.dsc.yaml file, installing or ensuring PowerToys is installed and applying the specified settings.

```powershell
winget configure .\configuration.dsc.yaml

```

--------------------------------

### ICommandProvider.InitializeWithHost(IExtensionHost)

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions/icommandprovider_initializewithhost

Initializes the extension with the host application. This method is called when the extension is loaded and provides the extension with a reference to the IExtensionHost interface, allowing interaction with the host application.

```APIDOC
## ICommandProvider.InitializeWithHost(IExtensionHost)

### Description
Initializes the extension with the host application. This method is called when the extension is loaded and provides the extension with a reference to the IExtensionHost interface, allowing the extension to interact with the host application.

### Method
InitializeWithHost

### Signature
void InitializeWithHost(IExtensionHost host)

### Parameters
- **host** (IExtensionHost) - Required - The host application that is loading the extension. The host application provides the extension with a reference to the IExtensionHost interface, which allows the extension to interact with the host application.

### Return Value
None (void)

### Remarks
This method is part of the ICommandProvider interface in the Microsoft.CommandPalette.Extensions namespace.
```

--------------------------------

### Intune example value for NewPlusHideTemplateFilenameExtension

Source: https://learn.microsoft.com/en-us/windows/powertoys/grouppolicy

Example OMA-URI value for the Intune policy 'NewPlusHideTemplateFilenameExtension'. The value '<disabled/>' disables the policy, showing the extension.

```xml
<disabled/>
```

--------------------------------

### TextSetting(String, String)

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/textsetting

Initializes a new instance of the TextSetting class with a specified name and description.

```APIDOC
## TextSetting(String, String)

### Description
Initializes a new instance of the TextSetting class with a specified name and description.

### Constructor
TextSetting(String name, String description)

### Parameters
- **name** (String) - Required - The name of the setting.
- **description** (String) - Required - The description of the setting.

```

--------------------------------

### Intune example value for MwbPolicyDefinedIpMappingRules

Source: https://learn.microsoft.com/en-us/windows/powertoys/grouppolicy

Example OMA-URI value for the Intune policy 'MwbPolicyDefinedIpMappingRules'. The data element uses '&#xF000;' as a separator between mappings.

```xml
<enabled/>
<data id="MwbPolicyDefinedIpMappingsList" value="Host1 192.0.2.1&#xF000Host2 192.0.2.2&#xF000Host3 192.0.2.3"/>
```

--------------------------------

### ExtensionHost.Initialize(IExtensionHost)

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/extensionhost_initialize

The Initialize method is called when the extension host is initialized. It is used to set up necessary resources or configurations for the extension. The method takes an IExtensionHost instance that provides access to the extension host's functionality and services.

```APIDOC
## ExtensionHost.Initialize(IExtensionHost)

### Description
The Initialize method is called when the extension host is initialized. This method is typically used to set up any necessary resources or configurations for the extension.

### Method
Initialize

### Parameters
#### Parameters
- **host** (IExtensionHost) - Required - The extension host instance that is being initialized. This parameter provides access to the extension host's functionality and services, allowing the extension to interact with the command palette and other components of the system.

### Return Value
No return value is documented.
```

--------------------------------

### Registry example value for MwbPolicyDefinedIpMappingRules

Source: https://learn.microsoft.com/en-us/windows/powertoys/grouppolicy

Example MULTI_SZ value for the registry policy 'MwbPolicyDefinedIpMappingRules'. Each line defines a mapping in the format 'hostname IP'.

```plaintext
Host1 192.0.2.1
Host2 192.0.2.2
Host3 192.0.2.3
```

--------------------------------

### ShowFileInFolderCommand(String)

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/showfileinfoldercommand

Initializes a new instance of the ShowFileInFolderCommand class with the specified file path.

```APIDOC
## ShowFileInFolderCommand(String)

### Description
Initializes a new instance of the ShowFileInFolderCommand class with the specified file path.

### Constructor
ShowFileInFolderCommand(String filePath)

### Parameters
- **filePath** (String) - Required - The path to the file to be selected in File Explorer.

```

--------------------------------

### IconData Properties

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/icondata

Properties of the IconData class. Data gets or sets the icon data as a stream reference. Icon gets or sets the icon URI.

```APIDOC
## IconData Properties

### Description
Properties of the IconData class. Data gets or sets the icon data as a stream reference. Icon gets or sets the icon URI.

### Properties

#### Data
- **Type**: Windows.Storage.Streams.IRandomAccessStreamReference
- **Description**: Gets or sets the icon data as a stream reference. This property is used to load the icon data from a stream.

#### Icon
- **Type**: String
- **Description**: Gets or sets the icon URI. This property is used to load the icon from a URI.

```

--------------------------------

### Setting(String, String, String, T) Constructor

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/setting_constructor

Initializes a new instance of the Setting class with its Key, Value, Label, and Description properties set to the provided values.

```APIDOC
## Setting(String, String, String, T) Constructor

### Description
Initializes a new instance of the Setting class with its Key, Value, Label, and Description properties set to the provided values.

### Namespace
Microsoft.CommandPalette.Extensions.Toolkit

### Syntax
```csharp
public Setting(string key, string label, string description, T defaultValue)
{
    Key = key;
    Value = defaultValue;
    Label = label;
    Description = description;
}
```

### Parameters
- **key** (String) - Required - The key of the setting. This is a unique identifier for the setting.
- **label** (String) - Required - The label of the setting. This is a user-friendly name for the setting that will be displayed in the UI.
- **description** (String) - Required - The description of the setting. This is a brief explanation of what the setting does and how it should be used.
- **defaultValue** (T) - Required - The default value of the setting. This is the value that will be used if no value is provided for the setting.

```

--------------------------------

### Setting(String, String, String, T) Constructor

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/setting_constructor

Initializes a new Setting instance with Key, Value, Label, and Description set to the provided parameters.

```C#
public Setting(string key, string label, string description, T defaultValue)
    {
        Key = key;
        Value = defaultValue;
        Label = label;
        Description = description;
    }
```

--------------------------------

### WinGet configuration integration for PowerToys (powertoys.dsc.config.winget)

Source: https://learn.microsoft.com/en-us/windows/powertoys/dsc-configure/microsoft-dsc

Save this YAML configuration as powertoys.dsc.config.winget to integrate PowerToys installation and settings with WinGet. It installs PowerToys and configures FancyZones settings.

```yaml
# yaml-language-server: $schema=https://aka.ms/configuration-dsc-schema/0.2
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
metadata:
  winget:
    processor: dscv3
resources:
  - name: Install PowerToys
    type: Microsoft.WinGet.DSC/WinGetPackage
    properties:
      id: Microsoft.PowerToys
      source: winget
  
  - name: Configure FancyZones
    type: Microsoft.PowerToys/FancyZonesSettings
    properties:
      settings:
        properties:
          fancyzones_shiftDrag: true
          fancyzones_mouseSwitch: true
        name: FancyZones
        version: 1.0
```

--------------------------------

### OpenPropertiesCommand(String)

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/openpropertiescommand

Initializes the command with a file path.

```APIDOC
## Constructor: OpenPropertiesCommand(String)

### Description
Initializes the command with a file path.

### Parameters
- **filePath** (String) - Required - The path to the file whose properties dialog will be opened.

### Returns
No return value (constructor).
```

--------------------------------

### Install OCR Language Pack for en-US

Source: https://learn.microsoft.com/en-us/windows/powertoys/text-extractor

Installs the OCR language pack for 'en-US' using the capability retrieved by the previous command. Executing this command may take several minutes to complete.

```powershell
$Capability | Add-WindowsCapability -Online

```

--------------------------------

### Install PowerToys using winget

Source: https://learn.microsoft.com/en-us/windows/powertoys/install

Run this command in PowerShell or command line to install PowerToys via Windows Package Manager. The command uses the official Microsoft.PowerToys package from the winget source.

```powershell
winget install --id Microsoft.PowerToys --source winget

```

--------------------------------

### Query for OCR language packs using Get-WindowsCapability

Source: https://learn.microsoft.com/en-us/windows/powertoys/text-extractor

Run this command in PowerShell as Administrator to list all supported OCR language packs. The output shows the language code and installation state (e.g., Installed or NotPresent).

```PowerShell
Get-WindowsCapability -Online | Where-Object { $_.Name -Like 'Language.OCR*' }

```

--------------------------------

### TextSetting(String, String) Constructor

Source: https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/textsetting_constructor

Initializes a new instance of the TextSetting class with a key and a default value.

```APIDOC
## TextSetting(String, String) Constructor

### Description
Initializes a new instance of the TextSetting class with a key and a default value.

### Namespace
Microsoft.CommandPalette.Extensions.Toolkit

### Syntax
```csharp
public TextSetting(string key, string defaultValue)
    : base(key, defaultValue)
{
}
```

### Parameters
- **key** (String) - Required - The unique identifier for the setting.
- **defaultValue** (String) - Required - The default value for the setting.
```
Tokens:
Raw