jlammi/winutil
1
0
Fork 0
mirror of https://github.com/ChrisTitusTech/winutil synced 2026-02-04 23:10:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Expand docs

Browse Source
This commit is contained in:
Chris Titus
2026-01-14 17:20:41 -06:00
parent a31c9cb235
commit 61a80e270d
5 changed files with 1355 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

169
docs/content/userguide/_index.md
View File

@@ -1,2 +1,167 @@
Welcome to the official User Guide for **Winutil**, your all-in-one Windows toolkit.
This document will walk you through installation, configuration, and usage of Winutil’s powerful features.
---
title: User Guide
weight: 2
---
Welcome to the official User Guide for **Winutil**, your all-in-one Windows toolkit!
## What is Winutil?
Winutil (Chris Titus Tech's Windows Utility) is a comprehensive PowerShell-based tool that helps you:
- **Install Applications**: Quickly install popular software without manual downloads
- **Apply Tweaks**: Optimize Windows for performance, privacy, and usability
- **Fix Issues**: Troubleshoot common Windows problems with one-click fixes
- **Manage Updates**: Control how and when Windows updates install
- **Create MicroWin**: Build custom, lightweight Windows installation ISOs
- **Access Tools**: Quick access to Windows panels and utilities
## Who Should Use Winutil?
Winutil is designed for:
- **Home Users**: Wanting to optimize their personal PCs
- **Power Users**: Needing fine-grained control over Windows
- **IT Professionals**: Managing multiple systems efficiently
- **Gamers**: Optimizing systems for gaming performance
- **Privacy-Conscious Users**: Reducing telemetry and data collection
- **Developers**: Setting up clean development environments
## Getting Started
New to Winutil? Start here:
1. **[Getting Started Guide](getting-started/)** - Installation and first steps
2. **[Application Store](store/)** - Learn to install software easily
3. **[Tweaks Guide](tweaks/)** - Optimize your system
4. **[Features & Fixes](features/)** - Troubleshoot common issues
## Main Features
### 🚀 Application Installation
Browse and install hundreds of popular applications with a single click. No more hunting for download links or dealing with installer bloat.
**[Read the Store Guide →](store/)**
### ⚙️ System Tweaks
Apply optimizations for performance, privacy, and usability. Choose from preset configurations or customize individual tweaks.
**[Read the Tweaks Guide →](tweaks/)**
### 🛠️ Config & Fixes
Quick fixes for common Windows problems:
- Reset network settings
- Fix Windows Update issues
- Repair system files
- Access legacy Windows panels
**[Read the Features Guide →](features/)**
### 🪟 MicroWin
Create custom Windows installation ISOs with bloatware removed, optimizations pre-applied, and unnecessary components stripped out.
**[Read the MicroWin Guide →](microwin/)**
### 🔄 Update Management
Take control of Windows Updates with options to:
- Enable/disable updates
- Security updates only
- Pause updates
- Manage driver updates
**[Read the Updates Guide →](updates/)**
### 🤖 Automation
Automate Winutil configurations for:
- Multiple PC setups
- Enterprise deployments
- Consistent configurations
- Scripted installations
**[Read the Automation Guide →](automation/)**
## Quick Links
| I want to... | Go to... |
|--------------|----------|
| Install Winutil for the first time | [Getting Started](getting-started/) |
| Install applications quickly | [Application Store](store/) |
| Speed up my computer | [Tweaks Guide](tweaks/) |
| Fix Windows Update problems | [Features - Fixes](features/) |
| Create a lightweight Windows ISO | [MicroWin](microwin/) |
| Automate setup for multiple PCs | [Automation](automation/) |
| Understand what tweaks do | [Tweaks Guide](tweaks/) |
## Safety and Best Practices
Before using Winutil:
✅ **Always**:
- Run PowerShell as Administrator
- Create a system restore point before major changes
- Understand what tweaks do before applying them
- Start with Essential Tweaks before Advanced ones
- Keep backups of important data
❌ **Never**:
- Apply all tweaks without understanding them
- Skip creating restore points
- Use on production systems without testing
- Disable security features unnecessarily
## System Requirements
- **Operating System**: Windows 10 (1809+) or Windows 11
- **PowerShell**: Version 5.1 or later (included in Windows)
- **Permissions**: Administrator access required
- **Internet**: Required for downloading apps and updates
- **.NET Framework**: 4.5+ (usually pre-installed)
## Getting Help
Need assistance?
- **📖 Documentation**: You're reading it! Use the navigation menu
- **❓ FAQ**: Check [Frequently Asked Questions](../faq/)
- **🐛 Known Issues**: Review [Known Issues](../knownissues/)
- **💬 Discord**: Join the [community Discord](https://discord.gg/RUbZUZyByQ)
- **🐙 GitHub**: Report bugs on [GitHub Issues](https://github.com/ChrisTitusTech/winutil/issues)
- **📺 YouTube**: Watch [video tutorials](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
## Contributing
Want to help improve Winutil?
- **Report Bugs**: Submit issues on GitHub
- **Suggest Features**: Open feature requests
- **Contribute Code**: Submit pull requests
- **Improve Docs**: Help expand this documentation
- **Share Knowledge**: Help others in Discord
**[Read Contributing Guide →](../contributing/)**
## What's in This Guide?
This User Guide covers everything you need to know:
1. **[Getting Started](getting-started/)** - Installation, first run, basic usage
2. **[Application Store](store/)** - Installing software, using presets
3. **[Tweaks](tweaks/)** - System optimizations and customizations
4. **[Features & Fixes](features/)** - Troubleshooting tools and utilities
5. **[MicroWin](microwin/)** - Creating custom Windows ISOs
6. **[Updates](updates/)** - Managing Windows Update behavior
7. **[Automation](automation/)** - Scripting and batch deployments
## Video Tutorial
Watch the complete Winutil overview:
{{< youtube id=6UQZ5oQg8XA loading=lazy >}}
Ready to get started? Head to the **[Getting Started Guide](getting-started/)** now!

273
docs/content/userguide/getting-started.md Normal file
View File

@@ -0,0 +1,273 @@
---
title: Getting Started with Winutil
weight: 1
---
## Welcome to Winutil!
Winutil is a powerful Windows utility that helps you optimize, customize, and maintain your Windows system. This guide will walk you through everything you need to get started.
## System Requirements
Before running Winutil, ensure your system meets these requirements:
- **Operating System**: Windows 10 (version 1809 or later) or Windows 11
- **PowerShell**: Version 5.1 or later (included by default in Windows 10/11)
- **Administrator Access**: Required for system-level changes
- **Internet Connection**: Required for downloading applications and updates
- **.NET Framework**: Version 4.5 or later (usually pre-installed)
## Installation
Winutil doesn't require traditional installation. It runs directly from PowerShell as a script.
### Step 1: Open PowerShell as Administrator
There are several ways to open PowerShell with admin rights:
**Method 1: Start Menu (Recommended)**
1. Right-click on the Windows Start button
2. Select "Windows PowerShell (Admin)" on Windows 10
3. Or select "Terminal (Admin)" on Windows 11
**Method 2: Search Method**
1. Press the `Windows` key
2. Type "PowerShell" or "Terminal"
3. Press `Ctrl + Shift + Enter` to launch as administrator
4. Or right-click and select "Run as administrator"
**Method 3: Run Dialog**
1. Press `Windows + R`
2. Type `powershell`
3. Press `Ctrl + Shift + Enter`
### Step 2: Run the Launch Command
Once PowerShell is open with administrator privileges, run one of these commands:
**Stable Release (Recommended for most users)**
```powershell
irm "https://christitus.com/win" | iex
```
**Development Branch (For testing latest features)**
```powershell
irm "https://christitus.com/windev" | iex
```
> [!NOTE]
> The `irm` command downloads the script, and `iex` executes it. This is safe when downloading from the official source.
### Step 3: Wait for Winutil to Load
The first time you run Winutil, it may take a few moments to:
- Download the latest version
- Initialize the interface
- Load all features and settings
## First Time Setup
### Configure WinGet (If Prompted)
On your first run, you may be prompted to configure WinGet (Windows Package Manager). This is normal.
1. When prompted, type `Y` and press Enter
2. Accept the terms and conditions
3. This only needs to be done once
### Understanding the Interface
Winutil opens with a clean, tabbed interface:
**Main Tabs**:
- **Install**: Browse and install applications
- **Tweaks**: Apply system optimizations and customizations
- **Config**: Access system tools and utilities
- **Updates**: Manage Windows updates
- **MicroWin**: Create custom, lightweight Windows ISOs
## Your First Actions
Here are some recommended first steps for new users:
### 1. Create a Restore Point
Before making any changes, create a system restore point:
1. Go to the **Tweaks** tab
2. Find "Create Restore Point" under Essential Tweaks
3. Check the box and click "Run Tweaks"
This allows you to undo changes if needed.
### 2. Install Essential Applications
1. Navigate to the **Install** tab
2. Browse categories or use the search bar
3. Check applications you want to install
4. Click "Install Selected" at the bottom
### 3. Apply Basic Tweaks
For a better Windows experience without risks:
1. Go to the **Tweaks** tab
2. Select the **"Desktop" preset** for a balanced configuration
3. Review the selected tweaks
4. Click "Run Tweaks"
## Common Tasks
### Installing Applications
**Single Application**:
1. Open **Install** tab
2. Search for the application name
3. Check the box next to it
4. Click "Install Selected"
**Multiple Applications**:
1. Check multiple application boxes
2. All checked apps will install in sequence
3. Progress is shown in the bottom panel
### Applying Tweaks
**Essential Tweaks** (Safe for all users):
1. Go to **Tweaks** tab
2. Select from Essential Tweaks section
3. Click "Run Tweaks"
**Advanced Tweaks** (Use with caution):
1. Only modify if you understand the implications
2. Always create a restore point first
3. Review documentation for each tweak
**Undoing Tweaks**:
1. Select the same tweaks you applied
2. Click "Undo Selected Tweaks"
3. System will revert to previous state
### Using Quick Fixes
For common Windows issues:
1. Go to **Config** tab
2. Navigate to **Fixes** section
3. Select the appropriate fix:
- **Reset Network**: Fixes network connectivity issues
- **Reset Windows Update**: Resolves update problems
- **System Corruption Scan**: Repairs corrupted system files
- **WinGet Reinstall**: Fixes package manager issues
### Changing DNS Servers
For improved privacy and speed:
1. Go to **Config** or **Tweaks** tab
2. Find the DNS section
3. Select a provider:
- **Cloudflare**: Fast and privacy-focused
- **Google**: Reliable and widely used
- **Quad9**: Security-focused with malware blocking
- **AdGuard**: Blocks ads and trackers
4. Click Apply
## Understanding Presets
Winutil offers several preset configurations:
- **Minimal**: Minimal changes, keeps most Windows features
- **Standard**: Good middle-ground for most users
## Safety Tips
✅ **DO**:
- Create restore points before major changes
- Read tweak descriptions before applying
- Start with Essential Tweaks
- Keep Windows up to date
- Back up important data
❌ **DON'T**:
- Apply all tweaks at once without understanding them
- Skip creating restore points
- Use Advanced Tweaks without research
- Disable security features unless necessary
- Run on production systems without testing
## Troubleshooting First Run
### Script Won't Download
**If the download fails**:
1. Try the direct GitHub link:
```powershell
irm https://github.com/ChrisTitusTech/Winutil/releases/latest/download/Winutil.ps1 | iex
```
2. Force TLS 1.2 (for older Windows versions):
```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
irm "https://christitus.com/win" | iex
```
### Execution Policy Error
If you get an execution policy error:
```powershell
Set-ExecutionPolicy Unrestricted -Scope Process -Force
irm "https://christitus.com/win" | iex
```
### Download Blocked (India/Certain Regions)
If GitHub is blocked in your region:
1. Use a VPN service
2. Change DNS to Cloudflare (1.1.1.1) or Google (8.8.8.8)
3. Try again
### Interface Doesn't Appear
If Winutil downloads but doesn't open:
1. Check if antivirus is blocking it
2. Ensure you ran PowerShell as administrator
3. Try closing and reopening PowerShell
4. Check Windows Defender exclusions
## Next Steps
Now that you're set up, explore these guides:
- [Application Installation Guide](../store/) - Learn about installing software
- [Tweaks Guide](../tweaks/) - Understand system optimizations
- [MicroWin Guide](../microwin/) - Create custom Windows ISOs
- [FAQ](../../faq/) - Common questions and answers
## Getting Help
If you need assistance:
- **Documentation**: Browse this documentation site
- **Known Issues**: Check the [Known Issues](../../knownissues/) page
- **Discord**: Join the [community Discord server](https://discord.gg/RUbZUZyByQ)
- **GitHub Issues**: Report bugs on [GitHub](https://github.com/ChrisTitusTech/winutil/issues)
- **YouTube**: Watch [video tutorials](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
## Quick Reference Card
| Task | Location | Action |
|------|----------|--------|
| Install Apps | Install Tab | Check boxes → Install Selected |
| Apply Tweaks | Tweaks Tab | Select tweaks → Run Tweaks |
| Undo Tweaks | Tweaks Tab | Select tweaks → Undo Selected Tweaks |
| Create Restore Point | Tweaks Tab | Essential Tweaks section |
| Fix Network | Config Tab | Fixes → Reset Network |
| Change DNS | Tweaks Tab | DNS section |
| Open Control Panel | Config Tab | Legacy Windows Panels |
Happy optimizing! 🚀