mirror of
https://github.com/ChrisTitusTech/winutil.git
synced 2026-08-09 17:41:14 +10:00
correct "WinUtil" in docs (#4676)
* Update _index.md * Update architecture.md * Update faq.md * Update KnownIssues.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update hugo.toml
This commit is contained in:
@@ -21,12 +21,12 @@ this means that your PowerShell session is in **Constrained Language Mode**, whi
|
||||
|
||||
### Ultimate Performance Plan Not Working
|
||||
|
||||
The Ultimate Performance power plan may not work on some laptops who do not fully support this power plan.
|
||||
The Ultimate Performance power plan may not work on some laptops that do not fully support this power plan.
|
||||
|
||||
In these cases, the power plan may fail to apply, This is expected behavior on unsupported hardware.
|
||||
|
||||
### Revet start menu tweak not working
|
||||
### Revert start menu tweak not working
|
||||
|
||||
Revet start menu tweak stops working starting with **Windows 11 update KB5089573** (released in May 2026).
|
||||
Revert start menu tweak stops working starting with **Windows 11 update KB5089573** (released in May 2026).
|
||||
|
||||
In this update, Microsoft completely removed the old Start Menu code from Windows so we aren't able to bring it back
|
||||
In this update, Microsoft completely removed the old Start Menu code from Windows, so we aren't able to bring it back.
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
---
|
||||
title: Welcome to Winutil Documentation!
|
||||
title: Welcome to WinUtil Documentation!
|
||||
toc: false
|
||||
width: full
|
||||
---
|
||||
|
||||
<div style="display: flex; justify-content: center; align-items: center; width: 100%; flex-wrap: wrap; gap: 5px;margin-top:30px;" >
|
||||
<a href="https://github.com/ChrisTitusTech/Winutil/releases/latest"><img src="https://img.shields.io/github/v/release/ChrisTitusTech/Winutil?color=%230567ff&label=Latest%20Release&style=for-the-badge" alt="Version" style="height: 28px; width: auto; min-width: 10px; object-fit: contain; margin: 0;"></a>
|
||||
<img src="https://img.shields.io/github/downloads/ChrisTitusTech/Winutil/Winutil.ps1?label=Total%20Downloads&style=for-the-badge" alt="GitHub Downloads" style="height: 28px; width: auto; min-width: 10px; object-fit: contain; margin: 0;">
|
||||
<a href="https://github.com/ChrisTitusTech/winutil/releases/latest"><img src="https://img.shields.io/github/v/release/ChrisTitusTech/winutil?color=%230567ff&label=Latest%20Release&style=for-the-badge" alt="Version" style="height: 28px; width: auto; min-width: 10px; object-fit: contain; margin: 0;"></a>
|
||||
<img src="https://img.shields.io/github/downloads/ChrisTitusTech/winutil/winutil.ps1?label=Total%20Downloads&style=for-the-badge" alt="GitHub Downloads" style="height: 28px; width: auto; min-width: 10px; object-fit: contain; margin: 0;">
|
||||
<a href="https://discord.gg/RUbZUZyByQ"><img src="https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ" alt="Discord Community Server" style="height: 28px; width: auto; min-width: 10px; object-fit: contain; margin: 0;"></a>
|
||||
</div>
|
||||
|
||||
Welcome to the official documentation for Winutil, your go-to utility for optimizing and managing your Windows environment. Whether you’re an IT professional, power user, or regular user, Winutil provides a comprehensive set of tools to enhance your Windows experience.
|
||||
Welcome to the official documentation for WinUtil, your go-to utility for optimizing and managing your Windows environment. Whether you’re an IT professional, power user, or regular user, WinUtil provides a comprehensive set of tools to enhance your Windows experience.
|
||||
|
||||
{{< image src="images/Title-Screen" alt="Winutil title screen" >}}
|
||||
{{< image src="images/Title-Screen" alt="WinUtil title screen" >}}
|
||||
|
||||
## Running the latest release of Winutil
|
||||
## Running the latest release of WinUtil
|
||||
|
||||
* You will first need to start a PowerShell terminal **as Admin**.
|
||||
* Now you can run the following command:
|
||||
@@ -25,4 +25,4 @@ irm "https://christitus.com/win" | iex
|
||||
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Winutil is updated frequently as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.
|
||||
> WinUtil is updated frequently as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.
|
||||
|
||||
@@ -6,7 +6,7 @@ toc: true
|
||||
|
||||
## Overview
|
||||
|
||||
Winutil is a PowerShell-based Windows utility with a WPF (Windows Presentation Foundation) GUI. This document explains the architecture, code structure, and how different components work together.
|
||||
WinUtil is a PowerShell-based Windows utility with a WPF (Windows Presentation Foundation) GUI. This document explains the architecture, code structure, and how different components work together.
|
||||
|
||||
## High-Level Architecture
|
||||
|
||||
@@ -74,7 +74,7 @@ winutil/
|
||||
1. Reads all function files from `/functions/`
|
||||
2. Includes configuration JSON files
|
||||
3. Embeds XAML GUI definition
|
||||
4. Combines into single script
|
||||
4. Combines into a single script
|
||||
5. Outputs `winutil.ps1`
|
||||
|
||||
**Why**: Makes distribution easier (single file) and improves load time.
|
||||
|
||||
+14
-14
@@ -6,46 +6,46 @@ toc: true
|
||||
## General Questions
|
||||
|
||||
### Is Windows 10 still supported?
|
||||
No. Windows 10 is no longer supported by Winutil because it reached the end of support on **October 14, 2025**.
|
||||
Winutil is focused on Windows 11.
|
||||
No. Windows 10 is no longer supported by WinUtil because it reached the end of support on **October 14, 2025**.
|
||||
WinUtil is focused on Windows 11.
|
||||
|
||||
### How do I uninstall Winutil?
|
||||
You do not need to uninstall Winutil. Because it runs as a PowerShell script, it is loaded into memory only while it is open. Once you close it, it is removed from memory and does not remain installed on your system.
|
||||
### How do I uninstall WinUtil?
|
||||
You do not need to uninstall WinUtil. Because it runs as a PowerShell script, it is loaded into memory only while it is open. Once you close it, it is removed from memory and does not remain installed on your system.
|
||||
|
||||
### Is Winutil safe to use?
|
||||
Yes, Winutil is open source, and the code is publicly available on GitHub. Thousands of users run it daily. However, like any system modification tool, you should:
|
||||
### Is WinUtil safe to use?
|
||||
Yes, WinUtil is open source, and the code is publicly available on GitHub. Thousands of users run it daily. However, like any system modification tool, you should:
|
||||
- Run it as Administrator (required)
|
||||
- Create a restore point before major changes
|
||||
- Understand what tweaks you're applying
|
||||
- Run only from [official source](https://github.com/ChrisTitusTech/winutil/)
|
||||
|
||||
### Do I need to keep running Winutil?
|
||||
No. Once you've applied tweaks or installed applications, you can close Winutil. Changes persist after closing. You only need to run Winutil again when you want to make additional changes or undo tweaks.
|
||||
### Do I need to keep running WinUtil?
|
||||
No. Once you've applied tweaks or installed applications, you can close WinUtil. Changes persist after closing. You only need to run WinUtil again when you want to make additional changes or undo tweaks.
|
||||
|
||||
### Does Winutil require internet access?
|
||||
- **For downloading**: Yes, installing applications requires the internet
|
||||
- **For downloading**: Yes, installing applications requires the Internet
|
||||
- **For tweaks**: No, most tweaks work offline
|
||||
- **Initial run**: Yes, to run the latest script
|
||||
|
||||
### How often is Winutil updated?
|
||||
Winutil is actively maintained with frequent updates. New features, bug fixes, and application additions are released regularly. The script auto-downloads the latest version each time you run it.
|
||||
### How often is WinUtil updated?
|
||||
WinUtil is actively maintained with frequent updates. New features, bug fixes, and application additions are released regularly. The script auto-downloads the latest version each time you run it.
|
||||
|
||||
## Installation & Running
|
||||
|
||||
### How do I run Winutil?
|
||||
### How do I run WinUtil?
|
||||
1. Open PowerShell as Administrator
|
||||
2. Run: `irm "https://christitus.com/win" | iex`
|
||||
3. Wait for the GUI to appear
|
||||
|
||||
### Why do I need Administrator rights?
|
||||
Winutil makes system-level changes (registry edits, service modifications, software installation) that require elevated permissions. Without admin rights, most features won't work.
|
||||
WinUtil makes system-level changes (registry edits, service modifications, software installation) that require elevated permissions. Without admin rights, most features won't work.
|
||||
|
||||
### The script won't download. What do I do?
|
||||
Try these solutions in order:
|
||||
|
||||
1. **Use the direct GitHub link**:
|
||||
```powershell
|
||||
irm https://github.com/ChrisTitusTech/Winutil/releases/latest/download/Winutil.ps1 | iex
|
||||
irm https://github.com/ChrisTitusTech/winutil/releases/latest/download/Winutil.ps1 | iex
|
||||
```
|
||||
|
||||
2. **Force TLS 1.2**:
|
||||
|
||||
@@ -147,7 +147,7 @@ Want to help improve Winutil?
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
Watch the complete Winutil overview:
|
||||
Watch the complete WinUtil overview:
|
||||
|
||||
{{< youtube id=6UQZ5oQg8XA loading=lazy >}}
|
||||
|
||||
@@ -158,5 +158,5 @@ Ready to get started? Head to the **[Getting Started Guide](getting-started/)**.
|
||||
Dive right into the following section to get started:
|
||||
|
||||
{{< cards >}}
|
||||
{{< card link="getting-started" title="Getting Started" icon="document-text" subtitle="Learn how to use winutil." >}}
|
||||
{{< card link="getting-started" title="Getting Started" icon="document-text" subtitle="Learn how to use WinUtil." >}}
|
||||
{{< /cards >}}
|
||||
|
||||
@@ -5,7 +5,7 @@ prev: /userguide/getting-started/
|
||||
next: /userguide/tweaks/
|
||||
---
|
||||
|
||||
Use the Applications tab to install, upgrade, uninstall, and review supported apps from one place. Winutil relies on package manager support for these actions, so the available results depend on what WinGet can detect and manage on your system.
|
||||
Use the Applications tab to install, upgrade, uninstall, and review supported apps from one place. WinUtil relies on package manager support for these actions, so the available results depend on what WinGet can detect and manage on your system.
|
||||
|
||||
{{< tabs >}}
|
||||
|
||||
|
||||
@@ -5,9 +5,9 @@ prev: /userguide/updates/
|
||||
next: /userguide/win11creator/
|
||||
---
|
||||
|
||||
Use Automation to run Winutil from an exported configuration file.
|
||||
Use Automation to run WinUtil from an exported configuration file.
|
||||
|
||||
Winutil supports predefined presets that apply common configurations automatically:
|
||||
WinUtil supports predefined presets that apply common configurations automatically:
|
||||
|
||||
- `Standard`
|
||||
- `Minimal`
|
||||
@@ -22,23 +22,23 @@ Example:
|
||||
To view exactly what each preset does, see:
|
||||
https://github.com/ChrisTitusTech/winutil/blob/main/config/preset.json
|
||||
|
||||
To create you're own config file:
|
||||
To create your own config file:
|
||||
|
||||
1. Open Winutil.
|
||||
1. Open WinUtil.
|
||||
2. Click the gear icon in the top-right corner.
|
||||
3. Choose **Export**.
|
||||
4. Save the exported JSON file.
|
||||
|
||||
Once you have exported a config, launch Winutil with it using this command:
|
||||
Once you have exported a config, launch WinUtil with it using this command:
|
||||
```powershell
|
||||
& ([ScriptBlock]::Create((irm "https://christitus.com/win"))) -Config "C:\Path\To\Config.json"
|
||||
```
|
||||
|
||||
This is useful for:
|
||||
|
||||
- Applying the same Winutil configuration across multiple Windows 11 PCs
|
||||
- Applying the same WinUtil configuration across multiple Windows 11 PCs
|
||||
- Reusing a known-good baseline after reinstalling Windows
|
||||
- Standardizing deployments for labs, workstations, or personal setups
|
||||
|
||||
> [!NOTE]
|
||||
> Run the command in an elevated PowerShell session so Winutil can apply system-level changes.
|
||||
> Run the command in an elevated PowerShell session so WinUtil can apply system-level changes.
|
||||
|
||||
@@ -7,7 +7,7 @@ next: /userguide/updates/
|
||||
|
||||
Use the **Features** and **Fixes** sections to install optional Windows components and run common repair tasks.
|
||||
|
||||
This page maps to the **Config** tab in Winutil. Some actions complete immediately, while others may prompt, download files from Microsoft, or require a restart before the change is fully available.
|
||||
This page maps to the **Config** tab in WinUtil. Some actions complete immediately, while others may prompt, download files from Microsoft, or require a restart before the change is fully available.
|
||||
|
||||
{{< image src="images/config-tab-new" alt="Config tab with features and fixes" >}}
|
||||
|
||||
@@ -41,7 +41,7 @@ Use these when you have a specific issue to correct, not as a routine cleanup st
|
||||
|
||||
## Legacy Windows Panels
|
||||
|
||||
Open old-school Windows panels directly from Winutil. Available panels include:
|
||||
Open old-school Windows panels directly from WinUtil. Available panels include:
|
||||
|
||||
* Control Panel
|
||||
* Network Connections
|
||||
|
||||
@@ -14,9 +14,9 @@ Use the quick-selection buttons at the top of the Tweaks tab to speed up setup:
|
||||
|
||||
* **Standard**: Selects the recommended baseline set of tweaks for most users.
|
||||
* **Minimal**: Selects a smaller, lower-impact set of common tweaks.
|
||||
* **Advanced**: Selects a focused set of safer advanced tweaks. This preset intentionally skips restore point creation and cleanup tasks to avoid long runtime.
|
||||
* **Advanced**: Selects a focused set of safer advanced tweaks. This preset intentionally skips restore point creation and cleanup tasks to avoid a long runtime.
|
||||
* **Clear**: Clears all currently selected tweaks.
|
||||
* **Get Installed Tweaks**: Best-effort detection for tweaks already applied on your system.
|
||||
* **Get Installed Tweaks**: Best-effort detection for tweaks already applied to your system.
|
||||
|
||||
### Run Tweaks
|
||||
* **Open the Tweaks tab**: Navigate to the **Tweaks** tab in the application.
|
||||
@@ -41,7 +41,7 @@ Essential Tweaks are the safest starting point for most systems. They focus on l
|
||||
Advanced Tweaks are for users who understand the side effects of deeper Windows changes. Create a restore point first, review each item, and avoid treating the full advanced list as a one-click baseline.
|
||||
|
||||
### O&O ShutUp10++
|
||||
[O&O ShutUp10++](https://www.oo-software.com/en/shutup10) can be launched from Winutil with one click. It is a free privacy tool for Windows that helps users manage telemetry, update behavior, and app permission settings.
|
||||
[O&O ShutUp10++](https://www.oo-software.com/en/shutup10) can be launched from WinUtil with one click. It is a free privacy tool for Windows that helps users manage telemetry, update behavior, and app permission settings.
|
||||
|
||||
{{< youtube id=3HvNr8eMcv0 loading=lazy >}}
|
||||
|
||||
|
||||
@@ -5,11 +5,11 @@ prev: /userguide/features/
|
||||
next: /userguide/automation/
|
||||
---
|
||||
|
||||
Winutil provides three update modes so you can choose how aggressively Windows Update is managed on your system:
|
||||
WinUtil provides three update modes so you can choose how aggressively Windows Update is managed on your system:
|
||||
|
||||
Changing modes adjusts system-wide Windows Update behavior. After switching modes, give Windows a moment to apply the policy and plan for a restart if the new state does not appear immediately.
|
||||
|
||||
{{< image src="images/updates-tab-new" alt="Updates tab in Winutil" >}}
|
||||
{{< image src="images/updates-tab-new" alt="Updates tab in WinUtil" >}}
|
||||
|
||||
- **Default (Out of the Box) Settings**: Restores standard Windows Update behavior
|
||||
- **Security (Recommended) Settings**: Prioritizes stability while still receiving security updates
|
||||
@@ -19,7 +19,7 @@ Changing modes adjusts system-wide Windows Update behavior. After switching mode
|
||||
|
||||
- **What it does**: Restores the default Windows Update configuration.
|
||||
- **Best for**: Systems where you want Windows to manage updates normally.
|
||||
- **Notes**: This removes custom update settings previously applied by Winutil. If update errors continue, use the reset option in the **Config** tab to restore Microsoft Update services to their default state.
|
||||
- **Notes**: This removes custom update settings previously applied by WinUtil. If update errors continue, use the reset option in the **Config** tab to restore Microsoft Update services to their default state.
|
||||
|
||||
### Security (Recommended) Settings
|
||||
|
||||
|
||||
@@ -4,11 +4,11 @@ weight: 8
|
||||
prev: /userguide/automation/
|
||||
---
|
||||
|
||||
## Using Winutil's Win11 Creator
|
||||
## Using WinUtil's Win11 Creator
|
||||
|
||||
Winutil includes a built-in **Win11 Creator** tool that lets you take an official Windows 11 ISO and produce a customized, debloated version. The resulting image can remove telemetry, bypass hardware requirement checks, and enable local account setup out of the box. You can export the result as a new ISO file or write it directly to a USB drive.
|
||||
WinUtil includes a built-in **Win11 Creator** tool that lets you take an official Windows 11 ISO and produce a customized, debloated version. The resulting image can remove telemetry, bypass hardware requirement checks, and enable local account setup out of the box. You can export the result as a new ISO file or write it directly to a USB drive.
|
||||
|
||||
{{< image src="images/win11creator-tab-new" alt="Win11 Creator tab in Winutil" >}}
|
||||
{{< image src="images/win11creator-tab-new" alt="Win11 Creator tab in WinUtil" >}}
|
||||
|
||||
> [!IMPORTANT]
|
||||
> You need an **official Windows 11 ISO** from [Microsoft's website](https://www.microsoft.com/en-us/software-download/windows11) before starting. Custom, modified, or non-official ISOs are not supported. The process uses ~10–15 GB of temporary disk space, so make sure you have room.
|
||||
@@ -20,7 +20,7 @@ Winutil includes a built-in **Win11 Creator** tool that lets you take an officia
|
||||
|
||||
### Step 1 — Select Your Official Windows 11 ISO
|
||||
|
||||
1. Open Winutil and go to the **Win11 Creator** tab.
|
||||
1. Open WinUtil and go to the **Win11 Creator** tab.
|
||||
2. Click **Browse** and select your **official Windows 11 ISO file** from Microsoft (must be 4 GB or larger). Custom or modified ISOs are not supported.
|
||||
3. The file path and size will appear on screen once selected.
|
||||
|
||||
@@ -29,17 +29,17 @@ Winutil includes a built-in **Win11 Creator** tool that lets you take an officia
|
||||
### Step 2 — Mount & Verify
|
||||
|
||||
1. Click **Mount & Verify ISO**.
|
||||
2. Winutil mounts the ISO, checks for a valid `install.wim` or `install.esd`, and reads the available editions (Home, Pro, Enterprise, etc.).
|
||||
2. WinUtil mounts the ISO, checks for a valid `install.wim` or `install.esd`, and reads the available editions (Home, Pro, Enterprise, etc.).
|
||||
3. Once verified, select your desired **edition** from the dropdown — Pro is selected by default if available.
|
||||
|
||||
> [!NOTE]
|
||||
> This step takes around 10–30 seconds depending on your drive speed.
|
||||
> This step takes around 10–30 seconds, depending on your drive speed.
|
||||
|
||||
---
|
||||
|
||||
### Step 3 — Run the Modification
|
||||
|
||||
Click **Run Windows ISO Modification and Creator** to start the customization process. Winutil will:
|
||||
Click **Run Windows ISO Modification and Creator** to start the customization process. WinUtil will:
|
||||
|
||||
**App & Component Removal:**
|
||||
- **Remove 40+ bloat apps** — Clipchamp, Teams, Copilot, Dev Home, new Outlook, Bing apps, Solitaire, and more
|
||||
@@ -67,7 +67,7 @@ Click **Run Windows ISO Modification and Creator** to start the customization pr
|
||||
**Optional: Driver Injection**
|
||||
- If enabled, it injects all drivers from your current system into the install.wim and boot.wim — useful for offline installations on machines with missing drivers. This is an optional checkbox in Step 3.
|
||||
|
||||
A live log shows progress as each step completes. This stage usually takes **10–30 minutes** depending on disk speed. The WIM dismount near the end is the slowest part, so do not close Winutil while it is running.
|
||||
A live log shows progress as each step completes. This stage usually takes **10–30 minutes** depending on disk speed. The WIM dismount near the end is the slowest part, so do not close WinUtil while it is running.
|
||||
|
||||
---
|
||||
|
||||
@@ -80,10 +80,10 @@ Once the modification is complete, choose how to save your image:
|
||||
{{< tab name="Save as ISO" selected=true >}}
|
||||
1. Click **Save as an ISO File**.
|
||||
2. Choose a save location (defaults to your Desktop as `Win11_Modified_yyyyMMdd.iso`).
|
||||
3. Winutil builds a dual BIOS/UEFI bootable ISO using `oscdimg.exe`.
|
||||
3. WinUtil builds a dual BIOS/UEFI bootable ISO using `oscdimg.exe`.
|
||||
|
||||
> [!NOTE]
|
||||
> `oscdimg.exe` (part of the Windows ADK) is required. If it's not found, Winutil will attempt to install it automatically via winget. If that fails, install it manually: `winget install -e --id Microsoft.OSCDIMG`
|
||||
> `oscdimg.exe` (part of the Windows ADK) is required. If it's not found, WinUtil will attempt to install it automatically via WinGet. If that fails, install it manually: `winget install -e --id Microsoft.OSCDIMG`
|
||||
|
||||
|
||||
{{< /tab >}}
|
||||
@@ -92,7 +92,7 @@ Once the modification is complete, choose how to save your image:
|
||||
1. Click **Write Directly to a USB Drive**.
|
||||
2. Select your USB drive from the dropdown (click **Refresh** if it doesn't appear).
|
||||
3. Click **Erase & Write to USB** and confirm the warning — **all data on the drive will be permanently erased**.
|
||||
4. Winutil formats the drive as GPT with a 512 MB EFI partition and copies the modified Windows files.
|
||||
4. WinUtil formats the drive as GPT with a 512 MB EFI partition and copies the modified Windows files.
|
||||
|
||||
> [!WARNING]
|
||||
> Double-check you have selected the correct drive before confirming. This operation cannot be undone.
|
||||
@@ -131,7 +131,7 @@ When you install Windows 11 from your modified ISO:
|
||||
| "oscdimg.exe not found" | Run `winget install -e --id Microsoft.OSCDIMG` then retry |
|
||||
| USB drive not showing up | Plug it in, wait a few seconds, then click **Refresh** |
|
||||
| Modification seems stuck | The WIM dismount step is slow — wait at least 10 minutes before assuming it's frozen |
|
||||
| "Access Denied" error | Make sure Winutil is running as Administrator |
|
||||
| "Access Denied" error | Make sure WinUtil is running as Administrator |
|
||||
|
||||
---
|
||||
|
||||
@@ -144,4 +144,4 @@ When you install Windows 11 from your modified ISO:
|
||||
> Always download Windows ISOs from official Microsoft sources or trusted tools like Rufus/UUP Dump to avoid tampered images.
|
||||
|
||||
> [!NOTE]
|
||||
> Newer Windows 11 ISOs may not boot correctly on older versions of Ventoy — make sure Ventoy is up to date before use. If issues persist after updating, this is a Ventoy compatibility limitation outside of Winutil's control.
|
||||
> Newer Windows 11 ISOs may not boot correctly on older versions of Ventoy — make sure Ventoy is up to date before use. If issues persist after updating, this is a Ventoy compatibility limitation outside of WinUtil's control.
|
||||
|
||||
Reference in New Issue
Block a user