irm https://christitus.com/windev | iex
+ Contributing Guide - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. How to Contribute?¶
Testing¶
- Test the latest changes to WinUtil by running the pre-release and reporting issues you are encountering to help us continually improve WinUtil!
Run the latest pre-release¶
Keep in mind
This is a pre-release and should be treated as such. It exists for developers to test the utility and report or fix bugs before they get added to the stable release. Don't use it in production!
Issues¶
- If you encounter any challenges or problems with the script, I kindly request that you submit them via the "Issues" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me (and others in the community) to promptly address any bugs or consider feature requests.
Contribute Code¶
-
Pull requests are now handled directly on the MAIN branch. This was done since we can now select specific releases to launch via releases in GitHub.
-
If you're doing code changes, then you can submit a PR to main branch, but I am very selective about these.
Important
Do not use a code formatter, make massive amounts of line changes, or make multiple feature changes. EACH FEATURE CHANGE SHOULD BE IT'S OWN PULL REQUEST!
-
When creating pull requests, it is essential to thoroughly document all changes made. This includes, but is not limited to, documenting any additions made to the tweaks section and corresponding undo tweak, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes. Document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in the denial of the pull request. Additionally, any code lacking sufficient documentation may also be denied.
-
By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.
Note
When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
Walk through¶
- This is a guide for beginners. If you are still having issues, look at the following official GitHub documentation:
Overview¶
%%{init: {"flowchart": {"curve": "cardinal"}} }%%
graph TD
A[Fork Project] --> B[Clone Repository];
diff --git a/KnownIssues/index.html b/KnownIssues/index.html
index e7e23387..559d7af9 100644
--- a/KnownIssues/index.html
+++ b/KnownIssues/index.html
@@ -1,4 +1,4 @@
- Known Issues - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Known Issues
Launch Issues¶
Blocked by anti-virus¶
Windows Security (formerly Defender) and other anti-virus software are known to block the script. The script gets flagged due to the fact that it requires administrator privileges & makes drastic system changes.
To resolve this, allow/whitelist the script in your anti-virus software settings, or temporarily disable real-time protection. Since the project is open source, you may audit the code if security is a concern.
Download not working¶
If https://christitus.com/win is not working, or you want to download the code from GitHub directly, you can use the direct download link:
irm https://github.com/ChrisTitusTech/winutil/releases/latest/download/winutil.ps1 | iex
+ Known Issues - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Known Issues
Launch Issues¶
Blocked by anti-virus¶
Windows Security (formerly Defender) and other anti-virus software are known to block the script. The script gets flagged due to the fact that it requires administrator privileges & makes drastic system changes.
To resolve this, allow/whitelist the script in your anti-virus software settings, or temporarily disable real-time protection. Since the project is open source, you may audit the code if security is a concern.
Download not working¶
If https://christitus.com/win is not working, or you want to download the code from GitHub directly, you can use the direct download link:
If you are seeing errors referencing TLS or security, you may be running an older version of Windows where TLS 1.2 is not the default security protocol used for network connections. The following commands will force .NET to use TLS 1.2, and download the script directly using .NET instead of PowerShell:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
iex (New-Object Net.WebClient).DownloadString('https://github.com/ChrisTitusTech/winutil/releases/latest/download/winutil.ps1')
If it still isn't working and you live in India, it might be due to India blocking GitHub's content domain and preventing downloads. See more on Times of India.
If you are still having issues, try using a VPN, or changing your DNS provider to one of following two providers:
Provider Primary DNS Secondary DNS Cloudflare 1.1.1.11.0.0.1 Google 8.8.8.88.8.4.4
Script blocked by Execution Policy¶
- Ensure you are running PowerShell as admin: Press
Windows Key+X and select PowerShell (Admin) in Windows 10, or Windows Terminal (Admin) in Windows 11. - In the PowerShell window, type this to allow unsigned code to execute and run the installation script:
Set-ExecutionPolicy Unrestricted -Scope Process -Force
diff --git a/dev/features/Features/DisableLegacyRecovery/index.html b/dev/features/Features/DisableLegacyRecovery/index.html
index 4bb9b1af..14e59f44 100644
--- a/dev/features/Features/DisableLegacyRecovery/index.html
+++ b/dev/features/Features/DisableLegacyRecovery/index.html
@@ -1,4 +1,4 @@
- Disable Legacy F8 Boot Recovery - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Disable Legacy F8 Boot Recovery¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.
Preview Code
{
+ Disable Legacy F8 Boot Recovery - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Disable Legacy F8 Boot Recovery¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.
Preview Code
{
"Content": "Disable Legacy F8 Boot Recovery",
"Description": "Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.",
"category": "Features",
diff --git a/dev/features/Features/DisableSearchSuggestions/index.html b/dev/features/Features/DisableSearchSuggestions/index.html
index 3bbde042..bb5239a8 100644
--- a/dev/features/Features/DisableSearchSuggestions/index.html
+++ b/dev/features/Features/DisableSearchSuggestions/index.html
@@ -1,4 +1,4 @@
- Disable Search Box Web Suggestions in Registry(explorer restart) - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Disable Search Box Web Suggestions in Registry(explorer restart)¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Disables web suggestions when searching using Windows Search.
Preview Code
{
+ Disable Search Box Web Suggestions in Registry(explorer restart) - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Disable Search Box Web Suggestions in Registry(explorer restart)¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Disables web suggestions when searching using Windows Search.
Preview Code
{
"Content": "Disable Search Box Web Suggestions in Registry(explorer restart)",
"Description": "Disables web suggestions when searching using Windows Search.",
"category": "Features",
diff --git a/dev/features/Features/EnableLegacyRecovery/index.html b/dev/features/Features/EnableLegacyRecovery/index.html
index 15baf3ea..1e7f1bf0 100644
--- a/dev/features/Features/EnableLegacyRecovery/index.html
+++ b/dev/features/Features/EnableLegacyRecovery/index.html
@@ -1,4 +1,4 @@
- Enable Legacy F8 Boot Recovery - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Enable Legacy F8 Boot Recovery¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.
Preview Code
{
+ Enable Legacy F8 Boot Recovery - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Enable Legacy F8 Boot Recovery¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.
Preview Code
{
"Content": "Enable Legacy F8 Boot Recovery",
"Description": "Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.",
"category": "Features",
diff --git a/dev/features/Features/EnableSearchSuggestions/index.html b/dev/features/Features/EnableSearchSuggestions/index.html
index 267aa22a..9631bdc5 100644
--- a/dev/features/Features/EnableSearchSuggestions/index.html
+++ b/dev/features/Features/EnableSearchSuggestions/index.html
@@ -1,4 +1,4 @@
- Enable Search Box Web Suggestions in Registry(explorer restart) - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Enable Search Box Web Suggestions in Registry(explorer restart)¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Enables web suggestions when searching using Windows Search.
Preview Code
{
+ Enable Search Box Web Suggestions in Registry(explorer restart) - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Enable Search Box Web Suggestions in Registry(explorer restart)¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Enables web suggestions when searching using Windows Search.
Preview Code
{
"Content": "Enable Search Box Web Suggestions in Registry(explorer restart)",
"Description": "Enables web suggestions when searching using Windows Search.",
"category": "Features",
diff --git a/dev/features/Features/Install/index.html b/dev/features/Features/Install/index.html
index 1c706af9..cce85fc4 100644
--- a/dev/features/Features/Install/index.html
+++ b/dev/features/Features/Install/index.html
@@ -1,4 +1,4 @@
- Install Features - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Install Features¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Preview Code
{
+ Install Features - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Install Features¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Preview Code
{
"Content": "Install Features",
"category": "Features",
"panel": "1",
diff --git a/dev/features/Features/RegBackup/index.html b/dev/features/Features/RegBackup/index.html
index 6715ecc8..94c46307 100644
--- a/dev/features/Features/RegBackup/index.html
+++ b/dev/features/Features/RegBackup/index.html
@@ -1,4 +1,4 @@
- Enable Daily Registry Backup Task 12.30am - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Enable Daily Registry Backup Task 12.30am¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803.
Preview Code
{
+ Enable Daily Registry Backup Task 12.30am - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Enable Daily Registry Backup Task 12.30am¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803.
Preview Code
{
"Content": "Enable Daily Registry Backup Task 12.30am",
"Description": "Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803.",
"category": "Features",
diff --git a/dev/features/Features/Sandbox/index.html b/dev/features/Features/Sandbox/index.html
index f0e137a2..6aae3724 100644
--- a/dev/features/Features/Sandbox/index.html
+++ b/dev/features/Features/Sandbox/index.html
@@ -1,4 +1,4 @@
- Windows Sandbox - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Windows Sandbox¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Windows Sandbox is a lightweight virtual machine that provides a temporary desktop environment to safely run applications and programs in isolation.
Preview Code
{
+ Windows Sandbox - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Windows Sandbox¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Windows Sandbox is a lightweight virtual machine that provides a temporary desktop environment to safely run applications and programs in isolation.
Preview Code
{
"Content": "Windows Sandbox",
"category": "Features",
"panel": "1",
diff --git a/dev/features/Features/dotnet/index.html b/dev/features/Features/dotnet/index.html
index eb9ebc75..50f82a9a 100644
--- a/dev/features/Features/dotnet/index.html
+++ b/dev/features/Features/dotnet/index.html
@@ -1,4 +1,4 @@
- All .Net Framework (2,3,4) - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. All .Net Framework (2,3,4)¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
.NET and .NET Framework is a developer platform made up of tools, programming languages, and libraries for building many different types of applications.
Preview Code
{
+ All .Net Framework (2,3,4) - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. All .Net Framework (2,3,4)¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
.NET and .NET Framework is a developer platform made up of tools, programming languages, and libraries for building many different types of applications.
Preview Code
{
"Content": "All .Net Framework (2,3,4)",
"Description": ".NET and .NET Framework is a developer platform made up of tools, programming languages, and libraries for building many different types of applications.",
"category": "Features",
diff --git a/dev/features/Features/hyperv/index.html b/dev/features/Features/hyperv/index.html
index 945f9b00..21ba0853 100644
--- a/dev/features/Features/hyperv/index.html
+++ b/dev/features/Features/hyperv/index.html
@@ -1,4 +1,4 @@
- HyperV Virtualization - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. HyperV Virtualization¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Hyper-V is a hardware virtualization product developed by Microsoft that allows users to create and manage virtual machines.
Preview Code
{
+ HyperV Virtualization - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. HyperV Virtualization¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Hyper-V is a hardware virtualization product developed by Microsoft that allows users to create and manage virtual machines.
Preview Code
{
"Content": "HyperV Virtualization",
"Description": "Hyper-V is a hardware virtualization product developed by Microsoft that allows users to create and manage virtual machines.",
"category": "Features",
diff --git a/dev/features/Features/legacymedia/index.html b/dev/features/Features/legacymedia/index.html
index b5dafb9e..c86ee782 100644
--- a/dev/features/Features/legacymedia/index.html
+++ b/dev/features/Features/legacymedia/index.html
@@ -1,4 +1,4 @@
- Legacy Media (WMP, DirectPlay) - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Legacy Media (WMP, DirectPlay)¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Enables legacy programs from previous versions of windows
Preview Code
{
+ Legacy Media (WMP, DirectPlay) - WinUtil Documentation Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. Legacy Media (WMP, DirectPlay)¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Enables legacy programs from previous versions of windows
Preview Code
{
"Content": "Legacy Media (WMP, DirectPlay)",
"Description": "Enables legacy programs from previous versions of windows",
"category": "Features",
diff --git a/dev/features/Features/nfs/index.html b/dev/features/Features/nfs/index.html
index 3fe188f9..8fb044a3 100644
--- a/dev/features/Features/nfs/index.html
+++ b/dev/features/Features/nfs/index.html
@@ -1,4 +1,4 @@
- NFS - Network File System - WinUtil Documentation Announcement: We are currently not adding any applications to WinUtil and any apps that will be added through a PR will be declined by the maintainer. Announcement: We are currently reworking the docs to use Hugo rather then mkdocs. NFS - Network File System¶
Last Updated: 2024-08-07
Info
The Development Documentation is auto generated for every compilation of WinUtil, meaning a part of it will always stay up-to-date. Developers do have the ability to add custom content, which won't be updated automatically.
Description¶
Network File System (NFS) is a mechanism for storing files on a network.