ChrisTitusTech / winutil

Chris Titus Tech's Windows Utility - Install Programs, Tweaks, Fixes, and Updates
MIT License
16.1k stars 1.04k forks source link

Chris Titus Tech's Windows Utility

Version

This utility is a compilation of Windows tasks I perform on each Windows system I use. It is meant to streamline installs, debloat with tweaks, troubleshoot with config, and fix Windows updates. I am extremely picky about any contributions to keep this project clean and efficient.

screen-install

Usage

Winutil must be run in Admin mode because it performs system-wide tweaks. To achieve this, open PowerShell or Windows Terminal as an administrator. Here are a few ways to do it:

  1. Right-Click Method:

    • Right-click on the start menu.
    • Choose "Windows PowerShell (Admin)" (for Windows 10) or "Terminal (Admin)" (for Windows 11).
  2. Search and Launch Method:

    • Press the Windows key.
    • Type "PowerShell" or "Terminal" (for Windows 11).
    • Press Ctrl + Shift + Enter to launch it with administrator privileges.

Launch Command

Simple way

irm "https://christitus.com/win" | iex

Courtesy of the issue: #144

If this site is not reachable from your country, please try running it directly from GitHub.

irm "https://github.com/ChrisTitusTech/winutil/releases/latest/download/winutil.ps1" | iex

If you still have Issues, refer to Known Issues.

Automation

Some features are available through automation. This allows you to save your config file pass it to Winutil walk away and come back to a finished system. Here is how you can set it up currently with Winutil >24.01.15

  1. On the Install Tab, click "Get Installed", this will get all installed apps supported by Winutil on the system GetInstalled
  2. Click on the Settings cog in the upper right corner and chose Export, chose file file and location, this will export the setting file. SettingsExport
  3. Copy this file to a USB or somewhere you can use after Windows installation.
  4. Use Microwin tab to create a custom Windows image.
  5. Install the Windows image.
  6. In the new Windows, Open PowerShell in the admin mode and run command to automatically apply tweaks and install apps from the config file.
    iex "& { $(irm christitus.com/win) } -Config [path-to-your-config] -Run"
  7. Have a cup of coffee! Come back when it's done.

Support

Tutorial

Watch the video

Overview

Video and Written Article walkthrough @ https://christitus.com/windows-tool/

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 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 doing a code change and you can submit a PR to main branch, but I am very selective about these. Do not use a code formatter, massive amounts of line changes, and 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 documenting any additions made to the tweaks section and ensuring that corresponding undo measures are in place to remove the newly added tweaks if necessary. Failure to adhere to this format may result in denial of the pull request. Additionally, comprehensive documentation is required for all code changes. 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 name so that it can be loaded into the runspace.

Thanks to all Contributors

Thanks a lot for spending your time helping Winutil grow. Thanks a lot! Keep rocking 🍻.

Contributors

GitHub Stats

Alt