mirror of
https://github.com/ChrisTitusTech/winutil.git
synced 2026-08-09 17:41:14 +10:00
Sean (ANGRYxScotsman)andGitHub
6f0629207a
* Scaffold Astro + Starlight docs site
Bootstraps a new docs-astro project to replace the Hugo-based docs,
using Astro's Starlight framework with the content collection schema
and sidebar navigation configured for WinUtil's docs structure.
* Add WinUtil-branded Starlight theme
Restyles Starlight's default look with a dark-by-default grayscale
palette and WinUtil's brand blue (#0567ff, from the app logo) as the
single accent, Geist for UI text, and JetBrains Mono for code. Also
overrides the default theme provider so first-time visitors land on
dark mode instead of following OS preference.
* Add custom Hero and CornerCard components
Hero overrides Starlight's default hero with a full-bleed grid/glow
background, a browser-chrome-framed screenshot, and a badge row driven
by frontmatter data. CornerCard is a bordered feature card with corner
brackets, used for the landing page's feature grid.
* Migrate docs content from Hugo to Astro/Starlight
Ports the landing page, user guide sections, FAQ, known issues,
contributing guide, and a sample generated tweak reference page from
the Hugo site, converting Hugo shortcodes and GFM alert syntax to
their Starlight/MDX equivalents.
* Use Windows-style caption buttons in hero window chrome
Swap the macOS traffic-light dots for a minimize/maximize/close
button group, since WinUtil is a Windows tool.
* Use Windows-style caption glyph for terminal code blocks
Replace Expressive Code's default macOS dots on terminal-framed code
blocks with a right-aligned Windows minimize/maximize/close icon,
matching the hero window chrome.
* Archive the Hugo docs site as docs-old
* Promote Astro/Starlight docs from docs-astro to docs
* Show the launch command as a copyable code block on the docs homepage
* Add docs codeowner for seanh1995
* Register custom Header component for Starlight docs site
* Add custom navbar links to Astro docs, matching the old Hugo site's top nav
* Point dev docs generator at the Astro/Starlight docs site
Output moves from docs/content/dev (Hugo) to
docs/src/content/docs/code-reference (Astro/Starlight): .mdx instead
of .md, Starlight-style title="..." code fence labels instead of
Hugo's filename/linenos shortcode, and a ":::note" aside linking back
to each entry's source file. Frontmatter description is now pulled
from the JSON Description field. Also fixes a pre-existing bug where
the embedded JSON snippets were always missing their own closing
brace.
* Add seanh1995 as codeowner for the dev docs generator
* Wire up Code Reference section in docs sidebar
Adds an Architecture & Design page plus autogenerated Tweaks/Features
Reference groups pointing at docs/src/content/docs/code-reference, and
fixes the editLink base URL to the promoted docs/ path.
* Port architecture doc to code-reference and drop stale hyperv sample
Moves the Hugo-era architecture doc into
docs/src/content/docs/code-reference/architecture.mdx: drops the
Hugo-only weight/toc frontmatter, converts the embedded code fences to
Starlight's title="..." syntax, and repoints the "Related
Documentation" links at this site's actual slugs. Also removes the
hand-written reference/tweaks/hyperv.mdx placeholder now that the
generator produces the real page under code-reference/features.
* Keep pre-conversion backup of devdocs-generator.ps1
Snapshot of the script before it was pointed at the Astro/Starlight
docs site, for reference.
* updated workflow
* Update CODEOWNERS
* Hide edit-page link on the docs landing page
The splash-template landing page isn't a source doc meant to be edited
via GitHub like the rest of the guides, so skip showing the link.
* Add site footer with copyright line, matching the old Hugo docs
The Hugo site rendered "© {year} Chris Titus Tech. All rights
reserved." in its footer; Starlight's default footer had no
equivalent. Override it to append the same copyright line below the
existing edit-link/pagination row, and collapse that row entirely
when it has nothing in it (e.g. pages with editUrl disabled and no
prev/next) instead of leaving an empty gap.
* Fix vertical alignment and size of the arrow icon in hero/CTA buttons
The right-arrow icon read as floating above the button label's
baseline. Root cause was partly a genuine optical mismatch (fixed with
a small position nudge scoped to just the arrow icon, so it doesn't
also shift the unaffected GitHub icon) and partly the final CTA's copy
getting wrapped in a <p> by MDX's markdown parser, which behaved
slightly differently under the flex layout than the Hero component's
plain text node. Switching the CTA button's label to a JS string
expression avoids the wrapper and keeps both buttons' markup, and
rendering, identical.
* Use the dark fork-button screenshot in the contributing guide
Drop the unused light-mode variant and point the guide at
Fork-Button-Dark.png instead.
* Remove old Hugo docs site and pre-conversion backup files
The docs have moved to the Astro/Starlight site; the Hugo site
(docs-old/), its workflow backup, and the devdocs-generator.ps1
pre-conversion snapshot are no longer needed.
* keeping ai happy
* Bump sharp to 0.35.3 in docs site
260 lines
7.7 KiB
Plaintext
260 lines
7.7 KiB
Plaintext
---
|
|
title: Getting Started
|
|
description: The safest way to get started with WinUtil and the first actions most users take.
|
|
sidebar:
|
|
order: 1
|
|
---
|
|
|
|
## Welcome to WinUtil!
|
|
|
|
WinUtil helps you install apps, apply system tweaks, run common fixes, and manage Windows settings from one place. This guide covers the safest way to get started and the first actions most users take.
|
|
|
|
## System requirements
|
|
|
|
Before running WinUtil, ensure your system meets these requirements:
|
|
|
|
:::caution
|
|
Windows 10 is not supported by WinUtil. Windows 10 reached the end of support on **October 14, 2025**.
|
|
:::
|
|
|
|
- **Operating system**: Windows 11
|
|
- **PowerShell**: Version 5.1 or later (included by default in Windows 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 the Windows Start button.
|
|
2. Select "Terminal (Admin)".
|
|
|
|
**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
|
|
|
|
With PowerShell running as Administrator, run one of the following commands depending on the release channel you want.
|
|
|
|
**Stable release (recommended)**
|
|
|
|
```powershell
|
|
irm "https://christitus.com/win" | iex
|
|
```
|
|
|
|
**Development branch (bleeding edge — for testing only)**
|
|
|
|
```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.
|
|
- The development branch may contain experimental changes and should only be used for testing on non-production systems.
|
|
:::
|
|
|
|
### 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
|
|
|
|
### 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
|
|
- **Win11 Creator**: Build a customized Windows 11 ISO from an official Microsoft image
|
|
|
|
## 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 gives you a rollback point if needed.
|
|
|
|
### 2. Install essential applications
|
|
|
|
1. Navigate to the **Install** tab.
|
|
2. Browse categories or use the search bar.
|
|
3. Check the applications you want to install.
|
|
4. Click "Install/Upgrade Selected" at the bottom.
|
|
|
|
### 3. Apply basic tweaks
|
|
|
|
For a better Windows experience with minimal risk:
|
|
|
|
1. Go to the **Tweaks** tab.
|
|
2. Select the **Standard** preset for a balanced configuration.
|
|
3. Review the selected tweaks.
|
|
4. Click **Run Tweaks**.
|
|
|
|
:::note
|
|
Some tweaks, fixes, and update changes may require a restart or sign-out before the full effect is visible.
|
|
:::
|
|
|
|
## Common tasks
|
|
|
|
### Installing applications
|
|
|
|
**Single application**:
|
|
|
|
1. Open the **Install** tab.
|
|
2. Search for the application name.
|
|
3. Check the box next to it.
|
|
4. Click "Install/Upgrade Selected".
|
|
|
|
**Multiple applications**:
|
|
|
|
1. Check multiple application boxes.
|
|
2. All checked apps will install in sequence.
|
|
3. Install and uninstall progress is shown in the window-level bottom panel, including the current package or package-manager batch and overall completion.
|
|
|
|
### Applying tweaks
|
|
|
|
**Essential tweaks** (safe for all users):
|
|
|
|
1. Go to the **Tweaks** tab.
|
|
2. Select from the 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. The system reverts to the previous state.
|
|
|
|
### Using quick fixes
|
|
|
|
For common Windows issues:
|
|
|
|
1. Go to the **Config** tab.
|
|
2. Navigate to the **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 the **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 that keep most Windows features
|
|
- **Standard**: A good middle ground for most users
|
|
- **Advanced**: Selects a focused set of safer advanced tweaks
|
|
|
|
## 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 launch command fails:
|
|
|
|
- Make sure PowerShell or Terminal is running as Administrator.
|
|
- Confirm the PC has internet access and can reach `christitus.com`.
|
|
- Retry from a normal PowerShell session rather than a restricted enterprise shell profile.
|
|
- If the command starts and then closes immediately, reopen Terminal as Administrator and run it again so you can read the error output.
|
|
|
|
If it still fails, check the [Known Issues](/known-issues/) page.
|
|
|
|
## Next steps
|
|
|
|
Now that you're set up, explore these guides:
|
|
|
|
- [Applications Guide](/guides/application/) — Learn about installing, upgrading, and uninstalling software
|
|
- [Tweaks Guide](/guides/tweaks/) — Understand system optimizations
|
|
- [FAQ](/faq/) — Common questions and answers
|
|
|
|
## Getting help
|
|
|
|
If you need assistance:
|
|
|
|
- **Documentation**: Browse this documentation site
|
|
- **Known Issues**: Check the [Known Issues](/known-issues/) 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 or upgrade apps | Install tab | Check boxes → Install/Upgrade Selected |
|
|
| Uninstall apps | Install tab | Check boxes → Uninstall 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 |
|