PowerToys/README.md
2020-08-05 12:23:12 -07:00

12 KiB

Overview

Microsoft PowerToys is a set of utilities for power users to tune and streamline their Windows experience for greater productivity. Inspired by the Windows 95 era PowerToys project, this reboot provides power users with ways to squeeze more efficiency out of the Windows 10 shell and customize it for individual workflows. A great overview of the Windows 95 PowerToys can be found here.

What's Happening | Downloading & Release notes | Contributing to PowerToys | Known issues

Build status

Branch Status x64
Master Build Status for Master
Stable Build Status for Stable
Installer Build Status for Installer

Current PowerToy Utilities

Color Picker

ColorPicker is a simple and quick system-wide color picker with Win+Shift+C. Color Picker allows to pick colors from any currently running application and automatically copies the HEX or RGB values to your clipboard. This code is based on Martin Chrzan's Color Picker.



FancyZones

FancyZones is a window manager that makes it easy to create complex window layouts and quickly position windows into those layouts.




File Explorer Add-ons

File Explorer add-ons will enable SVG icon rendering and Preview Pane additions for File Explorer.

Preview Pane is an existing feature in the File Explorer. To enable it, you just click the View tab in the ribbon and then click "Preview Pane". PowerToys will now enable two types of files to be previewed: Markdown (.md) & SVG (.svg)

Image Resizer

Image Resizer is a Windows Shell Extension for quickly resizing images. With a simple right click from File Explorer, resize one or many images instantly. This code is based on Brice Lambson's Image Resizer.



Keyboard Manager

Keyboard Manager allows you to customize the keyboard to be more productive by remapping keys and creating your own keyboard shortcuts. This PowerToy requires Windows 10 1903 (build 18362) or later.



PowerRename

PowerRename is a Windows Shell Extension for advanced bulk renaming using search and replace or regular expressions. PowerRename allows simple search and replace or more advanced regular expression matching. While you type in the search and replace input fields, the preview area will show what the items will be renamed to. PowerRename then calls into the Windows Explorer file operations engine to perform the rename. This has the benefit of allowing the rename operation to be undone after PowerRename exits. This code is based on Chris Davis's SmartRename.

PowerToys Run

PowerToys Run is a new toy in PowerToys that can help you search and launch your app instantly with a simple Alt+Space and start typing! It is open source and modular for additional plugins. Window Walker is now inside too! This PowerToy requires Windows 10 1903 (build 18362) or later.



Shortcut Guide

Windows key shortcut guide appears when a user holds the Windows key down for more than one second and shows the available shortcuts for the current state of the desktop.




Installing and running Microsoft PowerToys

Requirements

  • Windows 10 1803 (build 17134) or later.
  • Have .NET Core 3.1 Desktop Runtime. The installer should handle this but we want to directly make people aware.

0.18 users for updating via notifications

  • We adjusted how upgrading works in 0.20. In 0.19 we accounted for this upcoming change but if you are going from 0.18 to 0.20, please directly use the installer file.

Install from the Microsoft PowerToys GitHub releases page. Click on Assets to show the files available in the release and then click on PowerToysSetup-0.20.1-x64.exe to download the PowerToys installer.

This is our preferred method.

Via WinGet (Preview)

Download PowerToys from WinGet. To install PowerToys, run the following command from the command line / PowerShell:

WinGet install powertoys

Other install methods

Via Chocolatey (Unofficial)

Download and upgrade PowerToys from Chocolatey. If you have any issues when installing/upgrading the package please go to the package page and follow the Chocolatey triage process

To install PowerToys, run the following command from the command line / PowerShell:

choco install powertoys

To upgrade PowerToys, run the following command from the command line / PowerShell:

choco upgrade powertoys

Known issues

  • Color Picker at times won't work when PT is running elevated - #5348. We are currently working on a fix now for this.

Processor support

We currently support the matrix below.

x64 x86 ARM
Supported Issue #602 Issue #490

What's Happening

July 2020 Update

Our goals for 0.20 release cycle were to focus on adding in a few new features along with a heavy focus on stability / quality fixes. Martin Chrzan helped contribute a new utility that was in our 2021 plans, a screen wide color picker! Chris Davis also helped contribute a SVG icon support for File Explorer!

Between 0.19 and 0.20 releases, we tracked down a lot of performance and memory issues with PowerToys Run as well. The most important ones got added to 0.19.1 and 0.19.2 releases. If you find something not working correctly, please make us aware.

In addition, we'd like to thank everyone who filed a bug, gave feedback or made a pull-request. The PowerToys team is extremely grateful to have the support of an amazing active community.

Here are a few highlights from July

  • We shipped v0.20!
  • Martin Chrzan's Color Picker was added in! With a quick Win+Shift+C, get the color from your screen
  • File Explorer - Can now render SVG icons thanks to Chris Davis
  • FancyZones - you can now snap to any number of zones in FancyZones holding Shift+Ctrl while dragging a window
  • PT Run - keyboard interaction improvements
  • PT Run - freshly installed apps are now being detected
  • PT Run - Lots of perf and bug fixes
  • Keyboard manager - app level shortcuts
    • Example: For Outlook, Remap Ctrl+F to F4 and now Ctrl+F will put up the find window :)
  • Keyboard manager - Now can remap key to shortcut and shortcut to key.
  • Settings - Now has improved OOBE based on the work the Microsoft Garage Interns did during their hackathon
  • PowerRename improvements

For 0.21, we are proactively working on:

  • Stability
  • Quality
  • Localization
  • FancyZones improvements

PowerToys 2020 roadmap

Our roadmap for all the goals and utilities for 2020 detailed over here in the wiki.

Developer Guidance

Please read the developer docs for a detailed breakdown.

Contributing

This project welcomes contributions of all types. Help spec'ing, design, documentation, finding bugs are ways everyone can help on top of coding features / bug fixes. We are excited to work with the power user community to build a set of tools for helping you get the most out of Windows.

We ask that before you start work on a feature that you would like to contribute, please read our Contributor's Guide. We will be happy to work with you to figure out the best approach, provide guidance and mentorship throughout feature development, and help avoid any wasted or duplicate effort.

⚠ State of code ⚠

PowerToys is still a very fluidic project and the team is actively working out of this repository. We will be periodically re-structuring/refactoring the code to make it easier to comprehend, navigate, build, test, and contribute to, so DO expect significant changes to code layout on a regular basis.

License Info

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct.

Privacy Statement

The application logs basic telemetry. Our Telemetry Data page (Coming Soon) has the trends from the telemetry. Please read the Microsoft privacy statement for more information.