Skip to content

Commit 13d18c7

Browse files
Merge pull request #6016 from MicrosoftDocs/niels9001/powertoys-ab-test
[PowerToys] Install docs improvements and 0.97 release
2 parents ad721bf + bff6698 commit 13d18c7

8 files changed

Lines changed: 179 additions & 86 deletions

File tree

1.11 MB
Loading

hub/powertoys/fancyzones.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,4 +177,36 @@ In the demo below, we start with a default template applied to the screen and tw
177177

178178
![FancyZones Settings bottom screenshot](../images/pt-fancyzones-settings2.png)
179179

180+
## Command-line reference
181+
182+
The FancyZones CLI lets you apply and manage window layouts directly from the command line.
183+
184+
| Command | Aliases | Description |
185+
| :-- | :-- | :-- |
186+
| `help` | | Displays general help information for all commands |
187+
| `open-editor` | `editor`, `e` | Launch FancyZones layout editor |
188+
| `get-monitors` | `monitors`, `m` | List all monitors and their properties |
189+
| `get-layouts` | `layouts`, `ls` | List all available layouts with ASCII art preview |
190+
| `get-active-layout` | `active`, `a` | Show currently active layout |
191+
| `set-layout <uuid>` | `set`, `s` | Apply layout by UUID or template name |
192+
| `open-settings` | `settings` | Open FancyZones settings page |
193+
| `get-hotkeys` | `hotkeys`, `hk` | List all layout hotkeys |
194+
| `set-hotkey <key> <uuid>` | `shk` | Assign hotkey (0-9) to custom layout |
195+
| `remove-hotkey <key>` | `rhk` | Remove hotkey assignment |
196+
197+
**Usage example**
198+
```powershell
199+
# List all layouts with visual previews
200+
FancyZonesCLI.exe ls
201+
202+
# Apply "columns" template to all monitors
203+
FancyZonesCLI.exe s columns --all
204+
205+
# Set custom layout on monitor 2
206+
FancyZonesCLI.exe s {uuid} --monitor 2
207+
208+
# Assign hotkey Win+Ctrl+Alt+3 to a layout
209+
FancyZonesCLI.exe shk 3 {uuid}
210+
```
211+
180212
[!INCLUDE [install-powertoys.md](../includes/install-powertoys.md)]

hub/powertoys/file-locksmith.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,31 @@ When File Locksmith is opened, it will scan all of the running processes that it
2525

2626
After scanning, a list of processes will be displayed. Select **End task** to terminate the process, or select the expander to show more information. File Locksmith will automatically remove terminated processes from the list, whether or not this action was done via File Locksmith. To manually refresh the list of processes, select **Reload**.
2727

28+
## Command-line reference
29+
30+
The File Locksmith CLI lets you identify and manage processes that are locking files from the command line.
31+
32+
| Command | Description |
33+
| :--- | :--- |
34+
| `<path>` | **Required**. One or more file or directory paths to check. You can specify multiple paths separated by spaces. |
35+
| `--kill` | Terminates (kills) all processes that are currently locking the specified files. |
36+
| `--json` | Outputs the results in structured **JSON** format instead of human-readable text. Useful for automation and scripts. |
37+
| `--wait` | **Blocks execution** and waits until the specified files are released. The command will not exit until the files are unlocked. |
38+
| `--help` | Displays the help message with usage instructions. |
39+
40+
**Usage example**
41+
```powershell
42+
# Check which processes are locking a specific file:
43+
FileLocksmithCLI.exe "C:\Users\Docs\report.docx"
44+
45+
# Check multiple files and get the output in JSON format for parsing:
46+
FileLocksmithCLI.exe --json "C:\File1.txt" "C:\Folder\File2.dll"
47+
48+
# Block script execution until a file is released (useful in build scripts):
49+
FileLocksmithCLI.exe --wait "C:\bin\output.exe"
50+
51+
# Kill all processes that are locking a specific file:
52+
FileLocksmithCLI.exe --kill "C:\LockedFile.dat"
53+
```
54+
2855
[!INCLUDE [install-powertoys.md](../includes/install-powertoys.md)]

hub/powertoys/general.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ If activated, PowerToys will start automatically when you log in to Windows.
5555

5656
When activated, PowerToys shows an icon in the system tray area of the taskbar. You can use this icon to open the PowerToys settings app or the PowerToys flyout.
5757

58+
In addition, you can control whether the Quick Access flyout is enabled, assign a hotkey, and choose a theme-aware monochrome system tray icon.
59+
5860
## Back up & restore
5961

6062
Set a location where you want to save your PowerToys settings. You can also restore your settings from an existing backup.

hub/powertoys/image-resizer.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,45 @@ You can specify a directory in the filename format to group resized images into
6565

6666
You can choose to retain the original *last modified* date on the resized image or reset it at the time of the resizing action.
6767

68+
## Command-line reference
69+
70+
The Image Resizer CLI lets you resize one or more images from the command line.
71+
72+
| Command | Aliases | Description |
73+
| :--- | :--- | :--- |
74+
| `--help` | | Show help |
75+
| `--show-config` | | Print current effective configuration |
76+
| `--destination` | `-d` | Output directory (optional) |
77+
| `--width` | `-w` | Width |
78+
| `--height` | `-h` | Height |
79+
| `--unit` | `-u` | Unit (Pixel / Percent / Inch / Centimeter) |
80+
| `--fit` | `-f` | Fit mode (Fill / Fit / Stretch) |
81+
| `--size` | `-s` | Preset size index (supports `0` for Custom) |
82+
| `--shrink-only` | | Only shrink (do not enlarge) |
83+
| `--replace` | | Replace original |
84+
| `--ignore-orientation` | | Ignore EXIF orientation |
85+
| `--remove-metadata` | | Strip metadata |
86+
| `--quality` | `-q` | JPEG quality (1–100) |
87+
| `--keep-date-modified` | | Preserve source last-write time |
88+
| `--file-name` | | Output filename format |
89+
90+
91+
**Usage example**
92+
```powershell
93+
# Show help
94+
PowerToys.ImageResizerCLI.exe --help
95+
96+
# Show current config
97+
PowerToys.ImageResizerCLI.exe --show-config
98+
99+
# Resize with explicit dimensions
100+
PowerToys.ImageResizerCLI.exe --width 800 --height 600 .\image.png
101+
102+
# Use preset size 0 (Custom) and output to a folder
103+
PowerToys.ImageResizerCLI.exe --size 0 -d "C:\Output" .\photo.png
104+
105+
# Preserve source LastWriteTime
106+
PowerToys.ImageResizerCLI.exe --width 800 --height 600 --keep-date-modified -d "C:\Output" .\image.png
107+
```
108+
68109
[!INCLUDE [install-powertoys.md](../includes/install-powertoys.md)]

hub/powertoys/index.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,16 @@ adobe-target: true
1111

1212
# Microsoft PowerToys: Utilities to customize Windows
1313

14-
Microsoft PowerToys is a set of free Microsoft Windows utilities for power users to tune and streamline their Windows experience for greater productivity. These utilities and shell enhancement tools are designed to help you customize Windows 10 and Windows 11 to suit your needs.
14+
:::image type="content" border="false" source="../images/pt-header.png" alt-text="Hero image of PowerToys with app icons of all its utilities":::
15+
16+
Microsoft PowerToys is a set of utilities to tune and streamline your Windows experience for greater productivity. These utilities and shell enhancement tools are designed to help you customize Windows to suit your needs.
1517

1618
> [!div class="nextstepaction"]
1719
> [Install PowerToys](install.md)
1820
19-
## System requirements
20-
21-
PowerToys requires Windows 10 version 2004 (build 19041) or later, or any version of Windows 11. It isn't supported on earlier versions of Windows. For a complete list of system requirements, see [Installing PowerToys \| Requirements](/windows/powertoys/install#system-requirements).
22-
23-
### Processor architecture support
24-
25-
- **x64**: Supported
26-
- **ARM64**: Supported
21+
PowerToys is an open-source project, to learn more check out the [repository on GitHub](https://aka.ms/powertoys)
2722

28-
## PowerToys Utilities for Windows 10 and 11
23+
## Utilities
2924

3025
The currently available utilities include:
3126

hub/powertoys/install.md

Lines changed: 62 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,23 @@ no-loc: [PowerToys, Windows, Chocolatey, Scoop]
99
# Customer intent: As a Windows power user, I want to learn how to install PowerToys on Windows using an executable file or package manager.
1010
---
1111

12-
# Install PowerToys on Windows
12+
# Install PowerToys
1313

1414
PowerToys is a set of utilities for customizing Windows that you can install using multiple methods. This article explains how to install PowerToys on Windows 11 and Windows 10 using an executable file, Microsoft Store, or package managers like WinGet, Chocolatey, and Scoop.
1515

1616
We recommend installing PowerToys via [GitHub](https://aka.ms/installpowertoys) or [Microsoft Store](https://aka.ms/getPowertoys), but alternative install methods are also listed if you prefer using a package manager.
1717

18-
## System requirements
18+
### System requirements
1919

2020
The following are the minimum requirements to install and run PowerToys:
2121

22-
- Supported Operating Systems:
23-
- Windows 11 (all versions)
24-
- Windows 10 v2004 (19041) or newer
25-
- System architecture
26-
- x64 and Arm64 architectures are currently supported.
27-
- The PowerToys installer will install the following runtimes:
28-
- [Microsoft Edge WebView2 Runtime](https://go.microsoft.com/fwlink/p/?LinkId=2124703) bootstrapper (this will always install the latest version available)
22+
- Windows 11 or Windows 10 version 2004 (20H1 / build 19041) or newer
23+
- 64-bit processor: x64 or ARM64
24+
- Latest stable version of Microsoft Edge WebView2 Runtime is installed via the bootstrapper during setup
2925

30-
To see if your machine meets these requirements, check your Windows version and build number by opening a Run dialog (Win+R), then type `winver` and select <kbd>OK</kbd> or <kbd>Enter</kbd>. Alternatively, enter the `ver` command in Windows Command Prompt or [Windows Terminal](/windows/terminal/). You may be able to [update to the latest Windows version](ms-settings:windowsupdate) in **Windows Update**.
26+
### Installation methods
3127

32-
> [!TIP]
33-
> You can use AI assistance to [create Windows Package Manager install commands for PowerToys with Copilot](#ask-copilot-for-help-with-command-line-arguments).
34-
35-
## Install with Windows executable file from GitHub
36-
37-
> [!div class="nextstepaction"]
38-
> [Install PowerToys](https://aka.ms/installpowertoys)
28+
#### [GitHub](#tab/gh)
3929

4030
To install PowerToys using a Windows executable file:
4131

@@ -44,21 +34,19 @@ To install PowerToys using a Windows executable file:
4434
1. Select the `PowerToysSetup-0.##.#-x64.exe` or `PowerToysSetup-0.##.#-arm64.exe` file to download the PowerToys executable installer.
4535
1. Once downloaded, open the executable file and follow the installation prompts.
4636

47-
## Install with Microsoft Store
37+
#### [Microsoft Store](#tab/store)
4838

4939
You can install PowerToys from the [Microsoft Store's PowerToys page](https://aka.ms/getPowertoys).
5040

51-
## Install with Windows Package Manager
41+
#### [WinGet](#tab/winget)
5242

5343
To install PowerToys using the [Windows Package Manager](../package-manager/winget/index.md), it's as simple as running the following command from the command line / PowerShell:
5444

5545
```powershell
5646
winget install --id Microsoft.PowerToys --source winget
5747
```
5848

59-
PowerToys supports configuring through `winget configure` using [Desired State Configuration](dsc-configure/overview.md).
60-
61-
## Command-line installer arguments
49+
PowerToys supports configuring through `winget configure` using [Desired State Configuration](dsc-configure.md).
6250

6351
The installer executable accepts the [Microsoft Standard Installer command-line options](/windows/win32/msi/standard-installer-command-line-options).
6452

@@ -72,7 +60,7 @@ Here are some common commands you may want to use:
7260
| /layout | | create a local image of the bootstrapper |
7361
| /log | /l | log to a specific file |
7462

75-
### Ask Copilot for help with command-line arguments
63+
#### Ask Copilot for help with command-line arguments
7664

7765
You can get AI assistance from [Copilot](https://copilot.microsoft.com/) to generate a `winget` command with the arguments you need. You can customize the prompt to generate a string per your requirements.
7866

@@ -84,50 +72,11 @@ Generate a `winget` command to install Microsoft PowerToys with arguments to ins
8472

8573
Copilot is powered by AI, so surprises and mistakes are possible. For more information, see [Copilot FAQs](https://www.microsoft.com/microsoft-copilot/learn/).
8674

87-
### Extracting the MSI from the bundle for 0.94 and later
88-
89-
Make sure to have the [.NET SDK](https://dotnet.microsoft.com/download/) installed.
90-
91-
In PowerShell, run `dotnet tool install wix --global` to install the latest version of WiX Toolset.
92-
93-
This PowerShell example assumes that the PowerToys installer has been downloaded to the Windows desktop.
94-
95-
```powershell
96-
wix burn extract ${Env:\USERPROFILE}"\Desktop\PowerToysSetup-0.94.0-x64.exe" -out ${Env:\USERPROFILE}"\Desktop\extractedPath" -oba ${Env:\USERPROFILE}"\Desktop\extractedPath"
97-
```
98-
99-
### Extracting the MSI from the bundle for 0.93 and earlier
100-
101-
Make sure to have [WiX Toolset v3](https://docs.firegiant.com/wix/wix3/) installed. The command doesn't work with WiX Toolset v4 and later versions.
102-
103-
This PowerShell example assumes the default install location for WiX Toolset and that the PowerToys installer has been downloaded to the Windows desktop.
104-
105-
```powershell
106-
cd $Env:WIX\"bin"
107-
108-
# dark.exe -x OUTPUT_FOLDER INSTALLER_PATH
109-
.\dark.exe -x ${Env:\USERPROFILE}"\Desktop\extractedPath" ${Env:\USERPROFILE}"\Desktop\PowerToysSetup-0.53.0-x64.exe"
110-
```
111-
112-
### Fixes for uninstalling 0.51 and earlier builds issues
113-
114-
If you have an issue with the MSI being inaccessible, you can download the installer that corresponds with the installed version via the [PowerToys releases page](https://github.com/microsoft/PowerToys/releases) and run the following command. You'll need to change EXECUTABLE_INSTALLER_NAME to the actual file name.
115-
116-
In PowerShell, run `.\EXECUTABLE_INSTALLER_NAME.exe --extract_msi` and this will extract the MSI to your desktop.
117-
118-
### Clean-up scripts
119-
120-
If there are problems while uninstalling a version, there are cleanup scripts available:
121-
122-
- <github.com/microsoft/PowerToys/tree/main/tools/CleanUp_tool>
123-
- <github.com/microsoft/PowerToys/tree/main/tools/CleanUp_tool_powershell_script>
124-
125-
## Community-driven install tools
126-
127-
These community-driven alternative install methods aren't officially supported, and the PowerToys team doesn't update or manage these packages.
75+
#### [Other methods](#tab/other)
12876

129-
### Install with Chocolatey
77+
There are community driven install methods such as Chocolatey and Scoop to install PowerToys.
13078

79+
##### Chocolatey
13180
To install [PowerToys](https://community.chocolatey.org/packages/powertoys) using [Chocolatey](https://chocolatey.org/), run the following command from your command line / PowerShell:
13281

13382
```powershell
@@ -142,7 +91,7 @@ choco upgrade powertoys
14291

14392
If you have issues when installing/upgrading, create an issue at the [maintainers GitHub repository](https://github.com/mkevenaar/chocolatey-packages/issues) or follow the [Chocolatey triage process](https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process).
14493

145-
### Install with Scoop
94+
##### Scoop
14695

14796
To install PowerToys using [Scoop](https://scoop.sh/), run the following command from the command line / PowerShell:
14897

@@ -159,24 +108,67 @@ scoop update powertoys
159108

160109
If you have issues when installing/updating, file an issue in the [Scoop repo on GitHub](https://github.com/lukesampson/scoop/issues).
161110

162-
## After installation
111+
---
112+
113+
### After installation
163114

164115
After successfully installing PowerToys, an overview window will display with introductory guidance for each of the available utilities.
165116

166117
If you view the Home view of the PowerToys settings, you can get quick access to some of the utilities, see an overview of the available shortcuts, and enable or disable individual utilities.
167118

168119
:::image type="content" source="../images/powertoys-settings-home.png" alt-text="A screenshot of the Home page of the PowerToys settings.":::
169120

170-
## Updates
121+
### Updates
171122

172123
PowerToys uses an automatic update checker that checks for new versions when the app is running. If enabled, a toast notification will appear when an update is available. You can also check for updates manually from the PowerToys Settings.
173124

174125
![PowerToys Update](../images/powertoys-updates.png)
175126

176-
## Related content
127+
### Extracting the MSI from the bundle
128+
#### [0.94 and later](#tab/extract-094)
129+
130+
Make sure to have the [.NET SDK](https://dotnet.microsoft.com/download/) installed.
131+
132+
In PowerShell, run `dotnet tool install wix --global` to install the latest version of WiX Toolset.
133+
134+
This PowerShell example assumes that the PowerToys installer has been downloaded to the Windows desktop.
135+
136+
```powershell
137+
wix burn extract ${Env:\USERPROFILE}"\Desktop\PowerToysSetup-0.94.0-x64.exe" -out ${Env:\USERPROFILE}"\Desktop\extractedPath" -oba ${Env:\USERPROFILE}"\Desktop\extractedPath"
138+
```
139+
140+
#### [0.93 and earlier](#tab/extract-093)
141+
142+
Make sure to have [WiX Toolset v3](https://docs.firegiant.com/wix/wix3/) installed. The command doesn't work with WiX Toolset v4 and later versions.
143+
144+
This PowerShell example assumes the default install location for WiX Toolset and that the PowerToys installer has been downloaded to the Windows desktop.
145+
146+
```powershell
147+
cd $Env:WIX\"bin"
148+
149+
# dark.exe -x OUTPUT_FOLDER INSTALLER_PATH
150+
.\dark.exe -x ${Env:\USERPROFILE}"\Desktop\extractedPath" ${Env:\USERPROFILE}"\Desktop\PowerToysSetup-0.53.0-x64.exe"
151+
```
152+
---
153+
154+
### Troubeshooting
155+
#### Fixes for uninstalling 0.51 and earlier builds issues
156+
157+
If you have an issue with the MSI being inaccessible, you can download the installer that corresponds with the installed version via the [PowerToys releases page](https://github.com/microsoft/PowerToys/releases) and run the following command. You'll need to change EXECUTABLE_INSTALLER_NAME to the actual file name.
158+
159+
In PowerShell, run `.\EXECUTABLE_INSTALLER_NAME.exe --extract_msi` and this will extract the MSI to your desktop.
160+
161+
#### Clean-up scripts
162+
163+
If there are problems while uninstalling a version, there are cleanup scripts available:
164+
165+
- <github.com/microsoft/PowerToys/tree/main/tools/CleanUp_tool>
166+
- <github.com/microsoft/PowerToys/tree/main/tools/CleanUp_tool_powershell_script>
167+
168+
### Related content
177169

178170
[Microsoft PowerToys: Utilities to customize Windows](index.md)
179171

180172
[General settings for PowerToys](general.md)
181173

182-
[PowerToys on GitHub](https://github.com/microsoft/PowerToys)
174+
[PowerToys on GitHub](https://github.com/microsoft/PowerToys)

0 commit comments

Comments
 (0)