mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-03 09:46:54 +02:00
3b6453c932
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? --> ## Summary of the Pull Request This documentation enhances the DSC documentation by incorporating reference documents and providing examples. Closes #42552. <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist - [x] Closes: #xxx - [ ] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [ ] **Tests:** Added/updated and all pass - [ ] **Localization:** All end-user-facing strings can be localized - [ ] **Dev docs:** Added/updated - [ ] **New binaries:** Added on the required places - [ ] [JSON for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json) for new binaries - [ ] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries and localization folder - [ ] [YML for CI pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml) for new test projects - [ ] [YML for signed pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml) - [ ] **Documentation updated:** If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys) and link it here: #xxx <!-- Provide a more detailed description of the PR, other things fixed, or any additional comments/features here --> ## Detailed Description of the Pull Request / Additional comments <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed --------- Co-authored-by: Niels Laute <niels.laute@live.nl>
146 lines
3.5 KiB
Markdown
146 lines
3.5 KiB
Markdown
---
|
|
description: DSC configuration reference for PowerToys KeyboardManager module
|
|
ms.date: 10/18/2025
|
|
ms.topic: reference
|
|
title: KeyboardManager Module
|
|
---
|
|
|
|
# KeyboardManager Module
|
|
|
|
## Synopsis
|
|
|
|
Manages configuration for the Keyboard Manager utility, which allows key
|
|
remapping and custom keyboard shortcuts.
|
|
|
|
## Description
|
|
|
|
The `KeyboardManager` module configures PowerToys Keyboard Manager, a utility
|
|
that enables you to remap keys and create custom keyboard shortcuts. It
|
|
allows reassigning keys, creating application-specific remappings, and
|
|
defining shortcuts that run programs or commands.
|
|
|
|
## Properties
|
|
|
|
The KeyboardManager module supports the following configurable properties:
|
|
|
|
### Enabled
|
|
|
|
Controls whether Keyboard Manager is enabled.
|
|
|
|
**Type:** boolean
|
|
**Default:** `true`
|
|
|
|
## Examples
|
|
|
|
### Example 1 - Enable Keyboard Manager with direct execution
|
|
|
|
This example enables the Keyboard Manager utility.
|
|
|
|
```powershell
|
|
$config = @{
|
|
settings = @{
|
|
properties = @{
|
|
Enabled = $true
|
|
}
|
|
name = "KeyboardManager"
|
|
version = "1.0"
|
|
}
|
|
} | ConvertTo-Json -Depth 10 -Compress
|
|
|
|
PowerToys.DSC.exe set --resource 'settings' --module KeyboardManager --input $config
|
|
```
|
|
|
|
### Example 2 - Configure with DSC
|
|
|
|
This example enables Keyboard Manager through DSC configuration.
|
|
|
|
```bash
|
|
dsc config set --file keyboardmanager-config.dsc.yaml
|
|
```
|
|
|
|
```yaml
|
|
# keyboardmanager-config.dsc.yaml
|
|
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
|
|
resources:
|
|
- name: Enable Keyboard Manager
|
|
type: Microsoft.PowerToys/KeyboardManagerSettings
|
|
properties:
|
|
settings:
|
|
properties:
|
|
Enabled: true
|
|
name: KeyboardManager
|
|
version: 1.0
|
|
```
|
|
|
|
### Example 3 - Install and configure with WinGet
|
|
|
|
This example installs PowerToys and enables Keyboard Manager.
|
|
|
|
```bash
|
|
winget configure winget-keyboardmanager.yaml
|
|
```
|
|
|
|
```yaml
|
|
# winget-keyboardmanager.yaml
|
|
$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: Enable Keyboard Manager
|
|
type: Microsoft.PowerToys/KeyboardManagerSettings
|
|
properties:
|
|
settings:
|
|
properties:
|
|
Enabled: true
|
|
name: KeyboardManager
|
|
version: 1.0
|
|
```
|
|
|
|
## Important notes
|
|
|
|
> **Note:** The Keyboard Manager module DSC configuration controls the enabled state only. Key remappings and shortcut definitions are managed through the Keyboard Manager UI and stored separately. This design ensures that complex remapping configurations are not accidentally overwritten by DSC operations.
|
|
|
|
To configure key remappings:
|
|
1. Enable Keyboard Manager using DSC
|
|
2. Open PowerToys Settings
|
|
3. Navigate to Keyboard Manager
|
|
4. Use "Remap a key" or "Remap a shortcut" to configure specific mappings
|
|
|
|
## Use cases
|
|
|
|
### Enable for deployment
|
|
|
|
Enable Keyboard Manager on new workstations:
|
|
|
|
```yaml
|
|
resources:
|
|
- name: Enable Keyboard Manager
|
|
type: Microsoft.PowerToys/KeyboardManagerSettings
|
|
properties:
|
|
settings:
|
|
properties:
|
|
Enabled: true
|
|
name: KeyboardManager
|
|
version: 1.0
|
|
```
|
|
|
|
## See also
|
|
|
|
- [Settings Resource][01]
|
|
- [PowerToys DSC Overview][02]
|
|
- [PowerOCR][03]
|
|
- [PowerToys Keyboard Manager Documentation][04]
|
|
|
|
<!-- Link reference definitions -->
|
|
[01]: ../settings-resource.md
|
|
[02]: ../overview.md
|
|
[03]: ./PowerOCR.md
|
|
[04]: https://learn.microsoft.com/windows/powertoys/keyboard-manager
|