Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1fc2aa3743 |
@@ -1,6 +1,2 @@
|
||||
# Chris rules EVERYTHING (including paths listed below)
|
||||
* @ChrisTitusTech
|
||||
|
||||
# Seanh1917 (ANGRYxScotsmans) is the docs guy
|
||||
docs/ @ChrisTitusTech @seanh1995
|
||||
tools/devdocs-generator.* @ChrisTitusTech @seanh1995
|
||||
* @ChrisTitusTech
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We, as members, contributors, and leaders, pledge to make participation in our
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
|
||||
@@ -1,118 +1,149 @@
|
||||
# How to Contribute?
|
||||
## Contributing Code
|
||||
|
||||
## Testing
|
||||
### Before You Start
|
||||
|
||||
* Test the latest changes to WinUtil by running the pre-release and reporting issues you are encountering to help us continually improve WinUtil!
|
||||
- Keep each pull request focused on a single feature or fix.
|
||||
- Avoid unnecessary formatting changes or large unrelated edits.
|
||||
- Document what changed and why in your PR description.
|
||||
|
||||
#### **Run the latest pre-release**
|
||||
---
|
||||
|
||||
```ps1
|
||||
irm https://christitus.com/windev | iex
|
||||
## Basic Git Workflow
|
||||
|
||||
### 1. Fork the Repository
|
||||
|
||||
Go to the ChrisTitusTech/winutil repository on GitHub and click the Fork button in the top right corner.
|
||||
|
||||
<img width="171" height="50" alt="{650A4723-F38A-44A4-9820-D232BC87C8A0}" src="https://github.com/user-attachments/assets/a214f27c-2fee-444a-920f-d87b14f5896f" />
|
||||
|
||||
---
|
||||
|
||||
### 2. Clone Your Fork
|
||||
|
||||
```powershell
|
||||
git clone https://github.com/YOUR_USERNAME/winutil.git
|
||||
cd winutil
|
||||
```
|
||||
|
||||
> [!CAUTION]
|
||||
> **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
|
||||
### 3. Create a Branch
|
||||
|
||||
* 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.
|
||||
Never work directly on `main`.
|
||||
|
||||
## Contribute Code
|
||||
Create a branch related to your change:
|
||||
|
||||
* 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 the `main` branch.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Do not use a code formatter, make massive amounts of line changes, or make multiple feature changes. EACH FEATURE CHANGE SHOULD BE ITS OWN PULL REQUEST!
|
||||
>
|
||||
> Do not open a pull request that adds support for other languages to WinUtil for now, until we decide how we want to move forward with language support.
|
||||
|
||||
* 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:
|
||||
* [Commit through WEB](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)
|
||||
* [Commit through GitHub Desktop](https://docs.github.com/en/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits)
|
||||
* [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
|
||||
|
||||
|
||||
### Overview
|
||||
|
||||
```mermaid
|
||||
%%{init: {"flowchart": {"curve": "cardinal"}} }%%
|
||||
graph TD
|
||||
A[Fork Project] --> B[Clone Repository];
|
||||
B --> C[Create New Branch];
|
||||
C --> D[Make Changes];
|
||||
D --> G[Test Changes];
|
||||
G --> H{Tests Passed?};
|
||||
H -->|Yes| E[Commit Changes];
|
||||
H -->|No| J[Fix Issues];
|
||||
J --> G;
|
||||
E --> F[Push Branch];
|
||||
F --> K[Create Pull Request];
|
||||
K --> L[Fill out PR template];
|
||||
classDef default stroke:#333,stroke-width:4px,font-size:12pt;
|
||||
```powershell
|
||||
git checkout -b feature-name
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> This is a diagram to guide you through the process. It may vary depending on the type of change you're making.
|
||||
Example:
|
||||
|
||||
### Fork the Repo
|
||||
* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list.
|
||||
```powershell
|
||||
git checkout -b add-firefox-tweak
|
||||
```
|
||||
|
||||

|
||||
---
|
||||
|
||||
### Clone the Fork
|
||||
> [!TIP]
|
||||
> While you can make your changes directly through the Web, we recommend cloning the repo to your device using the application GitHub Desktop (available in WinUtil) to test your fork easily.
|
||||
### 4. Edit the Code
|
||||
|
||||
* Install GitHub Desktop if it is not already installed.
|
||||
* Log in using the same GitHub account you used to fork WinUtil.
|
||||
* Choose the fork under "Your Repositories" and press "clone {repo name}"
|
||||
* Create a new branch and name it something relatable to your changes.
|
||||
Open the project in your preferred text editor and make your changes.
|
||||
|
||||
* Now you can modify WinUtil to your liking using your preferred text editor.
|
||||
Keep changes small and focused.
|
||||
|
||||
---
|
||||
|
||||
### Testing your changes
|
||||
### 5. Test Your Changes
|
||||
|
||||
* To test to see if your changes work as intended, run the following commands in a PowerShell terminal as admin:
|
||||
Open Pwsh (Not Powershell) as Administrator.
|
||||
|
||||
* Change the directory where you are running the commands to the forked project.
|
||||
* `cd {path to the folder with the compile.ps1}`
|
||||
* Run the following command to compile and run WinUtil:
|
||||
* `.\Compile.ps1 -run`
|
||||
Go to the project folder:
|
||||
|
||||

|
||||
```powershell
|
||||
cd path\to\winutil
|
||||
```
|
||||
|
||||
Run:
|
||||
|
||||
Open PowerShell as Administrator.
|
||||
```powershell
|
||||
.\Compile.ps1 -Run
|
||||
```
|
||||
|
||||
* After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.
|
||||
Verify:
|
||||
|
||||
- WinUtil launches correctly
|
||||
- Your feature works
|
||||
- Nothing else breaks
|
||||
|
||||
### Committing the changes
|
||||
* Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
|
||||
If something fails, fix it before committing.
|
||||
|
||||

|
||||
---
|
||||
|
||||
* Now, commit your changes once you are happy with the result.
|
||||
### 6. Review Your Changes
|
||||
|
||||

|
||||
Check what changed:
|
||||
|
||||
* Push the changes to upload them to your fork on GitHub.
|
||||
```powershell
|
||||
git status
|
||||
```
|
||||
|
||||

|
||||
Review the diff:
|
||||
|
||||
### Making a PR
|
||||
* To make a PR on your repo under a new branch linking to the main branch, a button will show and say Preview and Create pull request. Click that button and fill in all the information that is provided on the template. Once all the information is filled in correctly, check your PR to make sure there is no WinUtil.ps1 file attached to the PR. Once everything is good, make the PR and wait for Chris (the maintainer) to accept or deny your PR. Once it is accepted by Chris, you will be able to see your changes in the "/windev" build.
|
||||
* If you do not see your feature in the main "/win" build, that is fine. All new changes go into the /windev build to make sure everything is working OK before going fully public.
|
||||
* Congratulations! You just submitted your first PR. Thank you so much for contributing to WinUtil.
|
||||
```powershell
|
||||
git diff
|
||||
```
|
||||
|
||||
Make sure you did not accidentally modify unrelated files.
|
||||
|
||||
---
|
||||
|
||||
### 7. Commit Your Changes
|
||||
|
||||
Stage files:
|
||||
|
||||
```powershell
|
||||
git add .
|
||||
```
|
||||
|
||||
Commit them:
|
||||
|
||||
```powershell
|
||||
git commit -m "Add feature description"
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```powershell
|
||||
git commit -m "Add Firefox package tweak"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 8. Push Your Branch
|
||||
|
||||
```powershell
|
||||
git push origin branch-name
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```powershell
|
||||
git push origin add-firefox-tweak
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 9. Open a Pull Request
|
||||
|
||||
Go to your fork on GitHub.
|
||||
|
||||
GitHub will show a button to create a pull request.
|
||||
<img width="1009" height="71" alt="{C8C6A3CC-79D4-44FD-A54C-4C5717F12730}" src="https://github.com/user-attachments/assets/0419d193-d4e7-47c0-87cf-b986742201a0" />
|
||||
|
||||
Before submitting:
|
||||
|
||||
- Explain what changed
|
||||
- Explain why you changed it
|
||||
- Make sure unrelated files are not included
|
||||
|
||||
Once submitted, maintainers will review your PR.
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
title: "[App Suggestion] "
|
||||
body:
|
||||
- type: input
|
||||
attributes:
|
||||
label: "Application Link"
|
||||
description: "Provide a link where this application can downloaded officially"
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: "Rules Checklist"
|
||||
description: "You should agree with next rules"
|
||||
options:
|
||||
- label: "This application is popular enough, so is not considered as niche"
|
||||
required: true
|
||||
- label: "This application is not considered bloatware"
|
||||
required: true
|
||||
- label: "This application is free to access"
|
||||
required: true
|
||||
- label: "This application should be included on majority of fresh installed systems"
|
||||
required: true
|
||||
- label: "This application is present on WinGet (check winstall.app or do 'winget search your-app' in terminal)"
|
||||
required: true
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: "Check for denied applications"
|
||||
options:
|
||||
- label: "Yes, I checked PRs, issues and discussions for existing suggestions and their result"
|
||||
required: true
|
||||
|
||||
@@ -18,18 +18,10 @@ body:
|
||||
- label: Yes, I did
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: winutil_version
|
||||
attributes:
|
||||
label: "Version of WinUtil"
|
||||
description: "Provide a version that you are using when issue submitted (it can be found in right corner of app)"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: affected_part
|
||||
attributes:
|
||||
label: What part of WinUtil are you having issues with?
|
||||
label: What part of Winutil are you having issues with?
|
||||
options:
|
||||
- Program Install Tab
|
||||
- Tweaks Tab
|
||||
|
||||
@@ -2,7 +2,4 @@ blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 💻 Community Discord
|
||||
url: https://discord.gg/RUbZUZyByQ
|
||||
about: Join our Community Discord server to chat with other users in the WinUtil community.
|
||||
- name: Suggest an application
|
||||
url: https://github.com/ChrisTitusTech/winutil/discussions/new?category=app-suggestion
|
||||
about: If you want to suggest an application to be added, create a discussion with given template
|
||||
about: Join our Community Discord server to chat with other users in the Winutil community.
|
||||
|
||||
@@ -11,7 +11,7 @@ body:
|
||||
|
||||
## ⚠️ **IMPORTANT**
|
||||
- 🛠️ **Supported environments only:** We only support Windows 11.
|
||||
- 💡 For general questions, use the [Discussions section](https://github.com/ChrisTitusTech/winutil/discussions) or join our Community-driven [Discord Server](https://discord.gg/RUbZUZyByQ).
|
||||
- 💡 For general questions, use the [Discussions section](https://github.com/Christitustech/winutil/discussions) or join our Community-driven [Discord Server](https://discord.gg/RUbZUZyByQ).
|
||||
|
||||
- type: textarea
|
||||
id: proposed_solution
|
||||
|
||||
@@ -5,7 +5,6 @@
|
||||
- [ ] New feature
|
||||
- [ ] Bug fix
|
||||
- [ ] Documentation update
|
||||
- [ ] Refactor
|
||||
- [ ] UI/UX improvement
|
||||
|
||||
<!-- This automatically adds labels to your PR based on the selections above. -->
|
||||
|
||||
@@ -1,105 +0,0 @@
|
||||
# Chris Titus Tech's Windows Utility
|
||||
|
||||
[](https://github.com/ChrisTitusTech/winutil/releases/latest)
|
||||

|
||||
[](https://discord.gg/RUbZUZyByQ)
|
||||
[](https://winutil.christitus.com/)
|
||||
|
||||
Questa utility è una raccolta di attività Windows che eseguo personalmente su ogni sistema che utilizzo. È progettata per snellire le *installazioni*, rimuovere i componenti superflui tramite *ottimizzazioni*, risolvere problemi tramite la *configurazione*, e riparare *aggiornamenti* di Windows. Sono estremamente selettivo riguardo ai contributi per mantenere questo progetto pulito ed efficiente.
|
||||
|
||||

|
||||
|
||||
## 💡 Come usarlo
|
||||
|
||||
Winutil deve essere eseguito con privilegi di amministratore, poiché apporta modifiche all'intero sistema. Per farlo, avvia PowerShell come amministratore. Ecco alcuni modi per procedere:
|
||||
|
||||
1. **Metodo del menu di Start:**
|
||||
- Fai clic con il tasto destro sul menu Start.
|
||||
- Scegli "Windows PowerShell (esegui come Amministratore)" (per Windows 10) o "Terminale (esegui come Amministratore)" (per Windows 11).
|
||||
|
||||
2. **Metodo tramite ricerca:**
|
||||
- Premi il tasto Windows.
|
||||
- Digita "PowerShell" o "Terminal" (per Windows 11).
|
||||
- Premi `Ctrl + Shift + Invio` oppure fai clic con il tasto destro e seleziona "Esegui come amministratore" per avviarlo con privilegi elevati.
|
||||
|
||||
### Comando di avvio
|
||||
|
||||
#### Branch stabile (Consigliato)
|
||||
|
||||
```ps1
|
||||
irm "https://christitus.com/win" | iex
|
||||
```
|
||||
#### Branch Sviluppatore
|
||||
|
||||
```ps1
|
||||
irm "https://christitus.com/windev" | iex
|
||||
```
|
||||
|
||||
### Automazione
|
||||
|
||||
Winutil supporta anche preset predefiniti che applicano automaticamente configurazioni comuni:
|
||||
|
||||
- `Standard`
|
||||
- `Minimal`
|
||||
- `Advanced`
|
||||
|
||||
Esempio:
|
||||
|
||||
```powershell
|
||||
& ([ScriptBlock]::Create((irm "https://christitus.com/win"))) -Preset Standard
|
||||
```
|
||||
|
||||
Per vedere esattamente cosa fa ogni preset, consulta:
|
||||
https://github.com/ChrisTitusTech/winutil/blob/main/config/preset.json
|
||||
|
||||
In caso di problemi, consulta i [Problemi noti](https://winutil.christitus.com/knownissues/) o [Apri una segnalazione](https://github.com/ChrisTitusTech/winutil/issues)
|
||||
|
||||
## 🎓 Documentazione
|
||||
|
||||
### [Documentazione ufficiale di WinUtil](https://winutil.christitus.com/)
|
||||
|
||||
### [Tutorial su YouTube](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
||||
|
||||
### [Articolo su ChrisTitus.com](https://christitus.com/windows-tool/)
|
||||
|
||||
## 🛠️ Build & Sviluppo
|
||||
|
||||
> [!NOTE]
|
||||
> Winutil è uno script piuttosto esteso, per questo è suddiviso in più file che vengono combinati in un unico file `.ps1` tramite un compilatore personalizzato. Questo rende la manutenzione del progetto molto più semplice.
|
||||
|
||||
Ottieni una copia del codice sorgente. Puoi farlo tramite l'interfaccia di GitHub (**Code** > **Download ZIP**), oppure clonando (scaricando) la repo tramite git.
|
||||
|
||||
Se git è installato, esegui i seguenti comandi in una finestra PowerShell per clonare e accedere alla directory del progetto:
|
||||
```ps1
|
||||
git clone --depth 1 "https://github.com/ChrisTitusTech/winutil.git"
|
||||
cd winutil
|
||||
```
|
||||
|
||||
Per compilare il progetto, esegui lo script di compilazione in una finestra PowerShell (i permessi di amministratore NON sono richiesti):
|
||||
```ps1
|
||||
.\Compile.ps1
|
||||
```
|
||||
|
||||
Troverai un nuovo file chiamato `winutil.ps1`, creato dallo script `Compile.ps1`. Ora puoi eseguirlo come amministratore e apparirà una nuova finestra. Goditi la tua versione compilata di WinUtil :)
|
||||
|
||||
> [!TIP]
|
||||
> Per ulteriori informazioni sull'utilizzo di WinUtil e su come contribuire allo sviluppo, ti invitiamo a leggere le [Linee guida per i contributi](https://winutil.christitus.com/contributing/). Se non sai da dove iniziare o hai domande, puoi chiedere sul nostro [Server Discord della community](https://discord.gg/RUbZUZyByQ); i membri attivi del progetto risponderanno appena possibile.
|
||||
|
||||
## 💖 Supporto
|
||||
- Per sostenere il progetto moralmente e mentalmente, non dimenticare di lasciare una ⭐️!
|
||||
- Wrapper EXE a 10$ su https://www.cttstore.com/windows-toolbox
|
||||
|
||||
## 💖 Sponsor
|
||||
|
||||
Questi sono gli sponsor che aiutano a mantenere vivo il progetto con contributi mensili.
|
||||
|
||||
<!-- sponsors --><a href="https://github.com/dwelfusius"><img src="https://github.com/dwelfusius.png" width="60px" alt="Avatar utente: " /></a><a href="https://github.com/mews-se"><img src="https://github.com/mews-se.png" width="60px" alt="Avatar utente: Martin Stockzell" /></a><a href="https://github.com/jdiegmueller"><img src="https://github.com/jdiegmueller.png" width="60px" alt="Avatar utente: Jason A. Diegmueller" /></a><a href="https://github.com/robertsandrock"><img src="https://github.com/robertsandrock.png" width="60px" alt="Avatar utente: RMS" /></a><a href="https://github.com/paulsheets"><img src="https://github.com/paulsheets.png" width="60px" alt="Avatar utente: Paul" /></a><a href="https://github.com/djones369"><img src="https://github.com/djones369.png" width="60px" alt="Avatar utente: Dave J (WhamGeek)" /></a><a href="https://github.com/anthonymendez"><img src="https://github.com/anthonymendez.png" width="60px" alt="Avatar utente: Anthony Mendez" /></a><a href="https://github.com/FatBastard0"><img src="https://github.com/FatBastard0.png" width="60px" alt="Avatar utente: " /></a><a href="https://github.com/DursleyGuy"><img src="https://github.com/DursleyGuy.png" width="60px" alt="Avatar utente: DursleyGuy" /></a><a href="https://github.com/DwayneTheRockLobster1"><img src="https://github.com/DwayneTheRockLobster1.png" width="60px" alt="Avatar utente: " /></a><a href="https://github.com/KieraKujisawa"><img src="https://github.com/KieraKujisawa.png" width="60px" alt="Avatar utente: Kiera Meredith" /></a><a href="https://github.com/andrewpayne68"><img src="https://github.com/andrewpayne68.png" width="60px" alt="Avatar utente: Andrew P" /></a><!-- sponsors -->
|
||||
|
||||
## 🏅 Grazie a tutti i collaboratori
|
||||
Un ringraziamento speciale per aver dedicato il vostro tempo ad aiutare Winutil a crescere. Grazie mille! Continuate così 🍻.
|
||||
|
||||
[](https://github.com/ChrisTitusTech/winutil/graphs/contributors)
|
||||
|
||||
## 📊 Statistiche GitHub
|
||||
|
||||

|
||||
@@ -1,7 +1,5 @@
|
||||
# Security Policy
|
||||
|
||||
If you find a security issue, please post it in the Issues tab. If you think it should be private, you can email me at contact@christitus.com.
|
||||
If you find a security issue please make post it in the issues tab. If you think it should be private you can email me at contact@christitus.com.
|
||||
|
||||
For immediate response check out our Discord server:
|
||||
|
||||
[](https://discord.gg/RUbZUZyByQ)
|
||||
For immediate response check out our discord server @ [](https://discord.gg/RUbZUZyByQ)
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
# Copilot Instructions
|
||||
|
||||
Read `AGENTS.md` in the repository root for operating instructions before doing anything else.
|
||||
@@ -1,18 +1,18 @@
|
||||
tag-prefix: ''
|
||||
categories:
|
||||
- title: 'Features'
|
||||
- title: '🚀 Features'
|
||||
labels:
|
||||
- 'feature'
|
||||
- 'enhancement'
|
||||
- 'new feature'
|
||||
- title: 'Bug Fixes'
|
||||
- title: '🐛 Bug Fixes'
|
||||
labels:
|
||||
- 'hotfix'
|
||||
- 'bugfix'
|
||||
- 'bug'
|
||||
- title: 'Documentation'
|
||||
- title: '📚 Documentation'
|
||||
label: 'documentation'
|
||||
- title: 'UI/UX Improvements'
|
||||
- title: '🎨 UI/UX Improvements'
|
||||
label: 'ui update'
|
||||
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
|
||||
template: |
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Auto-merge Automated Update PRs
|
||||
name: Auto-merge Docs PRs
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
@@ -8,14 +8,14 @@ on:
|
||||
|
||||
jobs:
|
||||
auto-merge:
|
||||
if: (github.event.pull_request.head.ref == 'docs-update' || github.event.pull_request.head.ref == 'sponsors-update') && (github.event.pull_request.user.login == 'ChrisTitusTech' || github.event.pull_request.user.login == 'github-actions[bot]')
|
||||
if: github.event.pull_request.head.ref == 'docs-update' && (github.event.pull_request.user.login == 'ChrisTitusTech' || github.event.pull_request.user.login == 'github-actions[bot]')
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
pull-requests: write
|
||||
contents: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v7
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Auto-approve PR
|
||||
if: github.event.pull_request.user.login == 'github-actions[bot]'
|
||||
|
||||
@@ -9,7 +9,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v7
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Check if PR was merged
|
||||
if: github.event.pull_request.merged == true
|
||||
@@ -18,11 +18,10 @@ jobs:
|
||||
- name: Extract Discussion Number & Close If any Were Found
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
PR_BODY: ${{ github.event.pull_request.body }}
|
||||
if: github.event.pull_request.merged == true
|
||||
id: extract-discussion
|
||||
run: |
|
||||
pr_body="$PR_BODY"
|
||||
pr_body="${{ github.event.pull_request.body }}"
|
||||
discussion_ids=$(echo "$pr_body" | grep -oP '(?i)(resolve|fix|close)[s|d]? #\K[0-9]+')
|
||||
|
||||
if [ -z "$discussion_ids" ]; then
|
||||
|
||||
@@ -17,11 +17,11 @@ jobs:
|
||||
uses: actions/stale@v10
|
||||
with:
|
||||
# A list of labels to reference when looking through issues,
|
||||
# and only when one (or even more) of these labels is found.
|
||||
# and only when one (or even more) of these labels are found..
|
||||
# then skip this issue, and never try to stale and/or close it.
|
||||
exempt-issue-labels: "Keep Issue Open"
|
||||
# Split it into two weeks, after one week, the issue will be marked as stale,
|
||||
# after another week have passed without any update, the issue will then be closed.
|
||||
# Split it into two weeks, after one week the issue will be marked as stale,
|
||||
# after another week have pasted without any update.. the issue will then be closed.
|
||||
days-before-issue-stale: 90
|
||||
days-before-issue-close: 365
|
||||
# NEVER mark PRs as Stale or Close + this workflow should never have write permissions on PRs, EVER!
|
||||
|
||||
@@ -13,9 +13,9 @@ jobs:
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- name: Checkout Sources
|
||||
uses: actions/checkout@v7
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Compile and Syntax check winutil.ps1
|
||||
- name: Compile and Syntaxcheck winutil.ps1
|
||||
shell: pwsh
|
||||
run: |
|
||||
Set-ExecutionPolicy Bypass -Scope Process -Force; ./Compile.ps1
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Deploy Astro site to Pages
|
||||
name: Deploy Hugo site to Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
@@ -6,34 +6,106 @@ on:
|
||||
- main
|
||||
paths:
|
||||
- "docs/**"
|
||||
- "config/tweaks.json"
|
||||
- "config/feature.json"
|
||||
- "functions/**"
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
pull-requests: write
|
||||
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: false
|
||||
|
||||
defaults:
|
||||
run:
|
||||
shell: bash
|
||||
|
||||
jobs:
|
||||
build:
|
||||
if: github.repository == 'ChrisTitusTech/winutil'
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
HUGO_VERSION: 0.156.0
|
||||
HUGO_ENVIRONMENT: production
|
||||
TZ: America/Chicago
|
||||
steps:
|
||||
- name: Install Hugo CLI
|
||||
run: |
|
||||
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
|
||||
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v7
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
submodules: recursive
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
- name: Setup Pages
|
||||
id: pages
|
||||
uses: actions/configure-pages@v6
|
||||
|
||||
- name: Install, build, and upload your site
|
||||
uses: withastro/action@v6
|
||||
- name: Generate Dev Docs from JSON
|
||||
shell: pwsh
|
||||
run: |
|
||||
Set-Location tools
|
||||
./devdocs-generator.ps1
|
||||
|
||||
- name: Create Pull Request
|
||||
id: cpr
|
||||
uses: peter-evans/create-pull-request@v8
|
||||
with:
|
||||
path: docs
|
||||
token: ${{ secrets.AUTO_MERGE }}
|
||||
commit-message: 'chore: Update generated dev docs'
|
||||
title: 'chore: Update Generated Dev Docs'
|
||||
body: 'Automated update of generated documentation from JSON sources'
|
||||
branch: docs-update
|
||||
delete-branch: true
|
||||
add-paths: |
|
||||
docs/content/dev/
|
||||
config/tweaks.json
|
||||
config/feature.json
|
||||
labels: |
|
||||
automated
|
||||
documentation
|
||||
|
||||
- name: Check outputs
|
||||
run: |
|
||||
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
|
||||
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
|
||||
|
||||
- name: Install Node.js dependencies
|
||||
run: "cd docs && [[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
|
||||
- name: Cache Restore
|
||||
id: cache-restore
|
||||
uses: actions/cache/restore@v5
|
||||
with:
|
||||
path: |
|
||||
${{ runner.temp }}/hugo_cache
|
||||
key: hugo-${{ github.run_id }}
|
||||
restore-keys: hugo-
|
||||
- name: Build with Hugo
|
||||
run: |
|
||||
hugo \
|
||||
--gc \
|
||||
--minify \
|
||||
--cleanDestinationDir \
|
||||
--source docs \
|
||||
--cacheDir "${{ runner.temp }}/hugo_cache"
|
||||
- name: Cache Save
|
||||
id: cache-save
|
||||
uses: actions/cache/save@v5
|
||||
with:
|
||||
path: |
|
||||
${{ runner.temp }}/hugo_cache
|
||||
key: ${{ steps.cache-restore.outputs.cache-primary-key }}
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v5
|
||||
with:
|
||||
path: ./docs/public
|
||||
|
||||
deploy:
|
||||
if: github.repository == 'ChrisTitusTech/winutil'
|
||||
|
||||
@@ -0,0 +1,77 @@
|
||||
name: Issue slash commands
|
||||
|
||||
on:
|
||||
issue_comment:
|
||||
types: [created, edited]
|
||||
|
||||
jobs:
|
||||
issueCommands:
|
||||
# Skip this job if the comment was created/edited on a PR
|
||||
if: ${{ !github.event.issue.pull_request }}
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
issues: write
|
||||
pull-requests: none
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- name: Process slash command
|
||||
uses: actions/github-script@v9
|
||||
with:
|
||||
script: |
|
||||
const allowedUsers = ["ChrisTitusTech", "og-mrk", "Marterich", "MyDrift-user", "Real-MullaC", "CodingWonders", "GabiNun2", "FluffyPunk"];
|
||||
const commenter = context.payload.comment.user.login;
|
||||
|
||||
// Authorization check first — before any parsing of comment content
|
||||
if (!allowedUsers.includes(commenter)) {
|
||||
console.log(`User ${commenter} is not in the allowlist. Skipping.`);
|
||||
return;
|
||||
}
|
||||
|
||||
// Read comment body as data, never interpolated into shell
|
||||
const body = context.payload.comment.body;
|
||||
const issueNumber = context.issue.number;
|
||||
const owner = context.repo.owner;
|
||||
const repo = context.repo.repo;
|
||||
|
||||
// /label 'name' or /label name
|
||||
const labelMatch = body.match(/\/label\s+'([^']+)'|\/label\s+(\S+?)(?:\s|$)/);
|
||||
if (labelMatch) {
|
||||
const labelName = (labelMatch[1] || labelMatch[2]).trim();
|
||||
console.log(`Adding label: ${labelName}`);
|
||||
await github.rest.issues.addLabels({
|
||||
owner, repo, issue_number: issueNumber,
|
||||
labels: [labelName],
|
||||
});
|
||||
}
|
||||
|
||||
// /unlabel 'name' or /unlabel name
|
||||
const unlabelMatch = body.match(/\/unlabel\s+'([^']+)'|\/unlabel\s+(\S+?)(?:\s|$)/);
|
||||
if (unlabelMatch) {
|
||||
const labelName = (unlabelMatch[1] || unlabelMatch[2]).trim();
|
||||
console.log(`Removing label: ${labelName}`);
|
||||
await github.rest.issues.removeLabel({
|
||||
owner, repo, issue_number: issueNumber,
|
||||
name: labelName,
|
||||
});
|
||||
}
|
||||
|
||||
// /close (optionally with 'not planned')
|
||||
if (body.includes('/close')) {
|
||||
const stateReason = body.includes('not planned') ? 'not_planned' : 'completed';
|
||||
console.log(`Closing issue (reason: ${stateReason})`);
|
||||
await github.rest.issues.update({
|
||||
owner, repo, issue_number: issueNumber,
|
||||
state: 'closed',
|
||||
state_reason: stateReason,
|
||||
});
|
||||
}
|
||||
|
||||
// /open or /reopen
|
||||
if (body.includes('/open') || body.includes('/reopen')) {
|
||||
console.log('Reopening issue');
|
||||
await github.rest.issues.update({
|
||||
owner, repo, issue_number: issueNumber,
|
||||
state: 'open',
|
||||
});
|
||||
}
|
||||
@@ -17,7 +17,7 @@ jobs:
|
||||
CERTIFICATE_BASE64: ${{ secrets.CERTIFICATE_BASE64 }}
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v7
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Generate Dev Docs and Update JSON Links
|
||||
shell: pwsh
|
||||
@@ -31,23 +31,21 @@ jobs:
|
||||
Set-ExecutionPolicy Bypass -Scope Process -Force; ./Compile.ps1
|
||||
continue-on-error: false # Directly fail the job on error, removing the need for a separate check
|
||||
|
||||
- name: Create Pull Request for Updated Docs and JSON Links
|
||||
- name: Create Pull Request for Updated JSON Links
|
||||
id: cpr
|
||||
uses: peter-evans/create-pull-request@v8
|
||||
with:
|
||||
token: ${{ secrets.AUTO_MERGE }}
|
||||
commit-message: 'chore: Update generated dev docs and JSON links'
|
||||
title: 'chore: Update generated dev docs and JSON links'
|
||||
body: 'Automated update of generated documentation and JSON config links from pre-release build'
|
||||
commit-message: 'chore: Update documentation links in JSON configs'
|
||||
title: 'chore: Update Generated Dev Docs'
|
||||
body: 'Automated update of documentation links in JSON configs from pre-release build'
|
||||
branch: docs-update
|
||||
delete-branch: true
|
||||
add-paths: |
|
||||
docs/src/content/docs/code-reference/
|
||||
config/tweaks.json
|
||||
config/feature.json
|
||||
labels: |
|
||||
automated
|
||||
documentation
|
||||
skip-changelog
|
||||
|
||||
- name: Check outputs
|
||||
@@ -111,21 +109,6 @@ jobs:
|
||||
config-name: release-drafter.yml
|
||||
version: ${{ env.VERSION }}
|
||||
|
||||
- name: Remove Automated Updates from Release Notes
|
||||
id: filter_notes
|
||||
shell: pwsh
|
||||
env:
|
||||
RELEASE_NOTES: ${{ steps.generate_notes.outputs.body }}
|
||||
run: |
|
||||
$filteredNotes = ($env:RELEASE_NOTES -split '\r?\n' | Where-Object {
|
||||
$_ -notmatch '(?i)Update (Generated Dev Docs|Sponsors)'
|
||||
}) -join "`n"
|
||||
|
||||
$delimiter = [guid]::NewGuid().ToString()
|
||||
"body<<$delimiter" >> $env:GITHUB_OUTPUT
|
||||
$filteredNotes >> $env:GITHUB_OUTPUT
|
||||
$delimiter >> $env:GITHUB_OUTPUT
|
||||
|
||||
- name: Create and Upload Release
|
||||
id: create_release
|
||||
uses: softprops/action-gh-release@v3
|
||||
@@ -133,7 +116,7 @@ jobs:
|
||||
tag_name: ${{ env.VERSION }}
|
||||
name: Pre-Release ${{ env.VERSION }}
|
||||
body: |
|
||||
${{ steps.filter_notes.outputs.body }}
|
||||
${{ steps.generate_notes.outputs.body }}
|
||||
|
||||

|
||||
append_body: false
|
||||
|
||||
@@ -11,7 +11,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v7
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Check if winutil.ps1 exists
|
||||
id: check_existence
|
||||
|
||||
@@ -12,7 +12,7 @@ jobs:
|
||||
if: (github.event_name == 'schedule' && github.repository == 'ChrisTitusTech/winutil') || (github.event_name != 'schedule')
|
||||
steps:
|
||||
- name: Checkout 🛎️
|
||||
uses: actions/checkout@v7
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
@@ -26,15 +26,13 @@ jobs:
|
||||
id: cpr
|
||||
uses: peter-evans/create-pull-request@v8
|
||||
with:
|
||||
token: ${{ secrets.AUTO_MERGE }}
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
commit-message: 'Update sponsors in README'
|
||||
title: 'chore: Update Sponsors README'
|
||||
body: 'Automated update of sponsors section'
|
||||
branch: sponsors-update
|
||||
delete-branch: true
|
||||
labels: |
|
||||
automated
|
||||
skip-changelog
|
||||
labels: automated
|
||||
|
||||
- name: Check outputs
|
||||
run: |
|
||||
|
||||
@@ -8,43 +8,32 @@ jobs:
|
||||
name: PS Script Analyzer
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
- name: Install PSScriptAnalyzer
|
||||
run: |
|
||||
Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
|
||||
Install-Module -Name PSScriptAnalyzer -RequiredVersion 1.20.0 -Scope CurrentUser -Force
|
||||
Import-Module PSScriptAnalyzer -RequiredVersion 1.20.0 -Force
|
||||
Get-Module PSScriptAnalyzer | Select-Object Name, Version, Path
|
||||
shell: pwsh
|
||||
- name: Run PSScriptAnalyzer
|
||||
run: |
|
||||
$results = Invoke-ScriptAnalyzer -Path . -Settings ./lint/PSScriptAnalyser.ps1 -Recurse
|
||||
if ($results) {
|
||||
$results | Format-Table -AutoSize | Out-String -Width 4096 | Write-Host
|
||||
} else {
|
||||
Write-Host "PSScriptAnalyzer found no diagnostics."
|
||||
}
|
||||
shell: pwsh
|
||||
- uses: actions/checkout@v6
|
||||
- name: lint
|
||||
uses: devblackops/github-action-psscriptanalyzer@master
|
||||
with:
|
||||
sendComment: false
|
||||
settingsPath: lint/PSScriptAnalyser.ps1
|
||||
failOnErrors: false
|
||||
failOnWarnings: false
|
||||
failOnInfos: false
|
||||
test:
|
||||
runs-on: windows-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v7
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Install Pester
|
||||
run: |
|
||||
Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process
|
||||
Install-Module -Name Pester -RequiredVersion 5.8.0 -Force -SkipPublisherCheck -AllowClobber
|
||||
Import-Module Pester -RequiredVersion 5.8.0 -Force
|
||||
Get-Module Pester | Select-Object Name, Version, Path
|
||||
Install-Module -Name Pester -Force -SkipPublisherCheck -AllowClobber
|
||||
shell: pwsh
|
||||
|
||||
- name: Run Pester tests
|
||||
run: |
|
||||
Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process
|
||||
Import-Module Pester -RequiredVersion 5.8.0 -Force
|
||||
Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed -CI
|
||||
Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed
|
||||
|
||||
shell: pwsh
|
||||
env:
|
||||
|
||||
@@ -1,15 +1,32 @@
|
||||
# winutil
|
||||
# Libraries
|
||||
System.Management.Automation.dll
|
||||
Microsoft.PowerShell.ConsoleHost.dll
|
||||
|
||||
winutil.exe.config
|
||||
winutil.ps1
|
||||
binary/
|
||||
testResults.xml
|
||||
# Configuration folder
|
||||
.vscode/
|
||||
.idea/
|
||||
.vs/
|
||||
|
||||
# general software/os specific
|
||||
# OS Specific
|
||||
desktop.ini
|
||||
.DS_Store
|
||||
|
||||
.vscode/
|
||||
.idea/
|
||||
# Ignore Generated XAML Files
|
||||
xaml/inputApp.xaml
|
||||
xaml/inputFeatures.xaml
|
||||
xaml/inputTweaks.xaml
|
||||
|
||||
# Executables and Configs
|
||||
pester.ps1
|
||||
Microsoft.UI.Xaml*
|
||||
winutil.ps1
|
||||
*.psd*
|
||||
|
||||
# winutil-bin
|
||||
winutil.exe.config
|
||||
binary/
|
||||
|
||||
# Hugo Files
|
||||
docs/public/
|
||||
docs/.hugo_build.lock
|
||||
docs/resources/
|
||||
|
||||
@@ -1,182 +0,0 @@
|
||||
# AGENTS.md
|
||||
|
||||
Drop-in operating instructions for coding agents. Read this file before every task.
|
||||
|
||||
**Working code only. Finish the job. Plausibility is not correctness.**
|
||||
|
||||
`SPEC.md` in the repository root is the project contract — read it for what WinUtil is and how it's architected. This file covers how to work on it.
|
||||
|
||||
## 0. Non-Negotiables
|
||||
|
||||
These rules override everything else in this file when in conflict:
|
||||
|
||||
1. **Do not edit `winutil.ps1` directly.** It is generated build output (see SPEC.md's Build Model). Change source files and compile.
|
||||
2. **Do not commit `winutil.ps1`.** It is ignored locally and generated by GitHub Actions for releases.
|
||||
3. **Never touch `docs/src/content/docs/code-reference/tweaks/` or `docs/src/content/docs/code-reference/features/`.** Both are auto-generated (see SPEC.md's Docs Site). Edit the source JSON (`config/tweaks.json`, `config/feature.json`) or the relevant PowerShell function file instead. Other hand-written pages under `code-reference/` (e.g. `architecture.mdx`) are not touched by the generator and may be edited directly.
|
||||
4. **Never fabricate.** Do not invent file paths, function names, command output, test results, commit hashes, or API behavior. Read the file or run the command.
|
||||
5. **Disagree when the premise is wrong.** Say what is wrong before acting on it.
|
||||
6. **Stop when genuinely ambiguous.** If two interpretations would produce materially different diffs, ask before editing.
|
||||
7. **Touch only what the task requires.** No drive-by refactors, formatting sweeps, or unrelated cleanup.
|
||||
8. **Verify before saying done.** A plausible-looking diff is not proof.
|
||||
|
||||
## 1. Key Commands
|
||||
|
||||
- Compile:
|
||||
```powershell
|
||||
.\Compile.ps1
|
||||
```
|
||||
- Compile and run GUI:
|
||||
```powershell
|
||||
.\Compile.ps1 -Run
|
||||
```
|
||||
- Install the supported Pester version (one-time). `-SkipPublisherCheck` is required because Windows ships an inbox Pester 3.4.0 that is catalog-signed, and PowerShell Gallery's Pester 5.8.0 is Authenticode-signed — `Install-Module` refuses the upgrade without it. This does not skip download integrity (still HTTPS + NuGet package hash verification); `-Repository PSGallery` pins the trusted source explicitly rather than relying on whatever repositories happen to be registered:
|
||||
```powershell
|
||||
Install-Module -Name Pester -RequiredVersion 5.8.0 -Repository PSGallery -Scope CurrentUser -Force -SkipPublisherCheck
|
||||
```
|
||||
- Run tests:
|
||||
```powershell
|
||||
Import-Module Pester -RequiredVersion 5.8.0 -Force
|
||||
Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed -CI
|
||||
```
|
||||
- Run Script Analyzer with project settings when available. If a locally compiled `winutil.ps1` exists, delete it first — `lint/PSScriptAnalyser.ps1` only excludes rules, not files, so `-Recurse` would also lint the generated script and produce noise against line numbers that don't map to any source file:
|
||||
```powershell
|
||||
Invoke-ScriptAnalyzer -Path . -Settings .\lint\PSScriptAnalyser.ps1 -Recurse
|
||||
```
|
||||
- Docs site dev server (run from `docs/`; see Section 2 for why this goes through Docker):
|
||||
```powershell
|
||||
docker compose up winutil-astro
|
||||
```
|
||||
- Docs site production build (run from `docs/`):
|
||||
```powershell
|
||||
docker compose run --rm winutil-astro npm run build
|
||||
```
|
||||
|
||||
Prefer the narrowest useful verification while iterating. Use the full relevant check before finishing.
|
||||
|
||||
## 2. Dependency Installs, Builds, And Dev Servers
|
||||
|
||||
Given the current wave of npm/pnpm/yarn supply-chain worms (malicious postinstall/preinstall scripts, credential-stealing packages): **never run npm/pnpm/yarn/npx directly on the host, full stop.** The docs site (`docs/`) is the only npm-based project in this repo; always run its tooling inside Docker via `docs/Dockerfile` and `docs/docker-compose.yml` (service `winutil-astro`).
|
||||
|
||||
- Never run `npm install`, `npm run <script>`, `npx <pkg>`, `pnpm`, or `yarn` directly on the host shell in `docs/`. Use `docker compose run --rm winutil-astro <command>` / `docker compose up winutil-astro` instead (see Section 1 for the exact commands).
|
||||
- If a task needs a new docs dependency, add it to `docs/package.json` yourself, then rebuild the image and drop the `node_modules` volume so it repopulates from the new image (run from `docs/`): `docker compose build winutil-astro`, then `docker compose down -v`. Docker only seeds a named volume from the image the first time it's created, so a plain rebuild silently leaves the old `node_modules` in place. Don't install packages on the host, even temporarily, "just to check something."
|
||||
- If Docker isn't available on the host, propose the install command for the current OS and wait for confirmation before running it — don't fall back to running npm on the host instead. If the daemon just isn't running (Docker is installed but not started), tell the user rather than trying to start it yourself.
|
||||
- Treat any `postinstall`/`preinstall` lifecycle script in a new dependency as worth flagging to the user before installing — summarize what it does.
|
||||
- Don't put real secrets anywhere under `docs/`. `docs/.dockerignore` only trims what `docker build` copies into the image — it does not affect the `docker compose` bind mount, which exposes the entire `docs/` directory (including any `.env` file) inside the container for every dev/build/preview command (see the next bullet). There is no "keep it out unless mounted" middle ground here.
|
||||
- The container mounts `docs/` as a volume, so file edits on the host are reflected inside the container immediately — no rebuild needed for normal code changes, only when `docs/package.json`/`docs/package-lock.json` change (see the rebuild-and-drop-volume steps above).
|
||||
- This Docker requirement is specific to `docs/`. The rest of the repo is PowerShell (`Compile.ps1`, Pester, Script Analyzer) and runs directly on the host per Section 1.
|
||||
|
||||
## 3. Source Of Truth
|
||||
|
||||
For changes that affect the compiled WinUtil script, make them only in the source files described in SPEC.md's Repository Layout — never in `winutil.ps1` itself. If behavior changes require the compiled script to change, update the source files and run `.\Compile.ps1` only to verify generation.
|
||||
|
||||
This scoping applies to compiled-script behavior only. Repository metadata — `AGENTS.md`, `SPEC.md`, `CLAUDE.md`/`GEMINI.md`/`.github/copilot-instructions.md`, `.github/workflows/`, and the root `.gitignore` — is edited directly when a task requires it, per the other sections of this file.
|
||||
|
||||
## 4. Before Editing
|
||||
|
||||
- State the plan in one or two sentences before editing. For non-trivial work, include the verification you intend to run.
|
||||
- Read the files you will touch and the files that call them.
|
||||
- Match existing patterns even when a different greenfield design would be cleaner.
|
||||
- Surface assumptions when they affect behavior, compatibility, or user data.
|
||||
- If two approaches have meaningful tradeoffs, name them before choosing. Trivial tasks can proceed directly.
|
||||
|
||||
## 5. Coding Guidelines
|
||||
|
||||
- Prefer the minimum code that solves the stated problem.
|
||||
- Keep PowerShell functions in one function file when practical, with the file name matching the primary function name.
|
||||
- Use approved PowerShell verb-noun names and follow the existing `WPF` / `WinUtil` naming conventions; keep UI event handler names aligned with XAML element names per SPEC.md's UI And Event Contract.
|
||||
- Use `$sync` for shared state and UI references, consistent with SPEC.md's Runtime Model.
|
||||
- Update WPF controls through the UI dispatcher when running work in a background runspace.
|
||||
- Keep config-driven features in JSON when they fit the existing schema instead of hard-coding lists in PowerShell; follow SPEC.md's Configuration Contract for required fields and key-renaming rules.
|
||||
- Preserve undo/original-state data for tweaks so users can reverse changes.
|
||||
- Do not add abstractions, configurability, hooks, or "future extensibility" unless the task needs them now.
|
||||
- Clean up orphans created by your own changes, such as unused variables or functions made obsolete by the edit.
|
||||
- Avoid broad formatting-only edits, especially in JSON config files, XAML, docs, and generated output.
|
||||
|
||||
## 6. Runtime And Safety Rules
|
||||
|
||||
- WinUtil performs system-level Windows changes; treat registry, services, AppX removal, package manager, Windows Update, ISO, and unattended setup changes as high-risk (see SPEC.md's Safety Requirements).
|
||||
- Prefer existing helper functions for WinGet, Chocolatey, registry, services, progress, and UI updates.
|
||||
- Keep tweaks reversible where the schema supports it by including original values or original states.
|
||||
- Never modify a user's original ISO in-place; follow existing copy/mount/export patterns.
|
||||
- Avoid storing credentials, secrets, or machine-specific paths in repo files.
|
||||
- Preserve logging and user feedback patterns for long-running or destructive operations.
|
||||
|
||||
## 7. Surgical Changes
|
||||
|
||||
- Do not improve adjacent code, comments, formatting, imports, or docs unless required.
|
||||
- Do not refactor working code because you are already in the file.
|
||||
- Do not delete pre-existing dead code unless asked; mention it in the summary if relevant.
|
||||
- Keep diffs reviewable. Every changed line should trace to the user's request.
|
||||
- If a change starts spreading across unrelated areas, pause and reassess the plan.
|
||||
|
||||
## 8. Verification
|
||||
|
||||
Define success in terms that can be checked, then check it.
|
||||
|
||||
- For compile/build changes, run `.\Compile.ps1`.
|
||||
- For GUI behavior changes, run `.\Compile.ps1 -Run` when practical and verify the affected path manually.
|
||||
- For config changes, run the compile check and relevant Pester tests.
|
||||
- For function changes, run the relevant Pester tests or add/update focused tests when practical.
|
||||
- For docs-only changes, proofread the changed files and skip runtime tests unless docs generation is affected.
|
||||
- Read command output. Do not report tests as passing unless they actually passed.
|
||||
- If verification fails, fix the cause rather than weakening the test.
|
||||
|
||||
If a check cannot be run, say exactly why and what residual risk remains. See SPEC.md's Testing And CI for what GitHub Actions runs on every push.
|
||||
|
||||
## 9. Generated Files And Git Hygiene
|
||||
|
||||
- Treat local `winutil.ps1` changes as disposable compile output.
|
||||
- Never stage or commit `winutil.ps1`, `binary/`, or anything else ignored by the root `.gitignore` or `docs/.gitignore` — read those files rather than assuming. `docs/public/` is tracked source for static assets, not generated output.
|
||||
- Do not remove `.gitignore` rules that keep generated artifacts out of Git.
|
||||
- Before finishing, check `git status --short` and separate your changes from pre-existing user changes.
|
||||
- Do not revert user changes unless explicitly asked.
|
||||
- Commit messages, when requested, should be descriptive: short subject under 72 characters, body explaining why when needed.
|
||||
- When committing, split changes into small, logical commits rather than one large commit, so each commit's diff is reviewable as a single group of related changes.
|
||||
|
||||
## 10. Documentation Expectations
|
||||
|
||||
- Update `docs/src/content/docs/guides/` when user-facing behavior changes.
|
||||
- Update `docs/src/content/docs/code-reference/architecture.mdx` and other hand-written developer docs when architecture, build flow, config schema, or contribution workflow changes — but never hand-edit the auto-generated `code-reference/tweaks/` or `code-reference/features/` subfolders (see Non-Negotiables).
|
||||
- Keep sidebar entries in `docs/astro.config.mjs` in sync with page slugs (see SPEC.md's Docs Site).
|
||||
- Keep README changes brief and high-level.
|
||||
- Put detailed user and developer documentation under `docs/`.
|
||||
- Keep SPEC.md aligned with project/architecture changes, and this file aligned with process changes.
|
||||
|
||||
## 11. Communication Style
|
||||
|
||||
- Be direct and concise. Start with the answer or action.
|
||||
- No flattery, filler, ceremonial closings, or fake certainty.
|
||||
- Use bullets only when they improve scanning.
|
||||
- Report what changed, how it was verified, and anything not done.
|
||||
- If the user asks for a review, lead with findings and file/line references.
|
||||
|
||||
## 12. When To Ask
|
||||
|
||||
Ask before proceeding when:
|
||||
|
||||
- The request has two plausible interpretations and the choice materially changes behavior or files touched.
|
||||
- The change affects release generation, generated artifacts, migrations, or high-risk Windows behavior in a way the user did not specify.
|
||||
- You need credentials, secrets, production resources, or access you do not have.
|
||||
- The user's stated goal conflicts with the literal request.
|
||||
|
||||
Proceed without asking when:
|
||||
|
||||
- The task is trivial and reversible.
|
||||
- Ambiguity can be resolved by reading the code or running a local command.
|
||||
- The user already answered the question in this session.
|
||||
|
||||
## 13. Project Learnings
|
||||
|
||||
When the user corrects an agent approach, add or tighten one concrete rule here before ending the session. Keep this section short and prune rules that no longer matter.
|
||||
|
||||
- Keep `winutil.ps1` generated-only: change source files, compile to verify, and never stage the generated script.
|
||||
- Keep WinUtil runtime logging in the existing timestamped `%LocalAppData%\winutil\logs\winutil_*.log` session file; do not create a separate root `winutil.log`.
|
||||
- Import Pester 5.8.0 before running tests so `Invoke-Pester -Output Detailed -CI` does not resolve to Windows' inbox Pester 3.4.0.
|
||||
- Keep package install/uninstall process launches simple unless explicitly requested; do not add a separate stdout/stderr process logging helper for winget or Chocolatey.
|
||||
- When the active log file is owned by `Start-Transcript`, do not call `Add-Content` against that file; write to host output so the transcript captures the line in the same log file without recording a terminating-error diagnostic.
|
||||
- Keep UI helpers such as `Invoke-WPFUIThread` and `Set-WinUtilTweaksProgressIndicator` safe to call without a window; the `-Preset` and `-Config` paths run the workflows before the form is created and before PresentationCore is loaded.
|
||||
- Log install/uninstall package names and package-manager IDs before queuing background runspace work; do not rely on runspace host output for the package identity.
|
||||
- For Win11 Creator, start each new ISO modification in a fresh `WinUtil_Win11ISO_*` temp directory; existing-work detection is only for resuming/exporting already modified media.
|
||||
- For Win11 Creator driver injection, keep offline WIM servicing to one mount, one `/Add-Driver`, and one commit; do not export editions or run unrelated WIM cleanup, and reject damaged metadata before ISO export.
|
||||
- For Script Analyzer cleanup, fix actionable source warnings first and do not globally suppress accepted convention warnings such as plural names, `ShouldProcess` on UI helpers, `$global:sync`, or compile-time cross-file false positives.
|
||||
- For DNS DHCP reset, keep the cmdlet reset and explicitly set IPv4 and IPv6 DNS source to DHCP.
|
||||
@@ -2,20 +2,23 @@ param (
|
||||
[switch]$Run
|
||||
)
|
||||
|
||||
$OFS = "`r`n"
|
||||
$OFS = "`r`n" # Makes it so we dont need to add -Raw to every Get-Content command
|
||||
|
||||
# Variable to sync between runspaces
|
||||
$sync = [Hashtable]::Synchronized(@{})
|
||||
$sync.configs = @{}
|
||||
|
||||
$script = (Get-Content -Path scripts\start.ps1) -replace '#{replaceme}', (Get-Date -Format 'yy.MM.dd')
|
||||
# Create the script in memory.
|
||||
$script = [System.Collections.Generic.List[string]]::new()
|
||||
|
||||
$script += Get-ChildItem -Path functions -Recurse -File | ForEach-Object {
|
||||
Get-Content -Path $_.FullName -Raw
|
||||
}
|
||||
$script.Add(
|
||||
((Get-Content -Path scripts\start.ps1) -replace '#{replaceme}', (Get-Date -Format 'yy.MM.dd'))
|
||||
)
|
||||
|
||||
$script.Add((Get-ChildItem -Path functions -Recurse -File | Get-Content))
|
||||
|
||||
Get-ChildItem config | ForEach-Object {
|
||||
$obj = Get-Content -Path $_.FullName -Raw | ConvertFrom-Json
|
||||
$obj = Get-Content -Path $_.FullName | ConvertFrom-Json
|
||||
|
||||
if ($_.Name -eq "applications.json") {
|
||||
$fixed = [ordered]@{}
|
||||
@@ -28,16 +31,17 @@ Get-ChildItem config | ForEach-Object {
|
||||
$json = $obj | ConvertTo-Json -Depth 10
|
||||
|
||||
$sync.configs[$_.BaseName] = $obj
|
||||
$script += "`$sync.configs.$($_.BaseName) = @'`r`n$json`r`n'@ | ConvertFrom-Json"
|
||||
$script.Add("`$sync.configs.$($_.BaseName) = @'`r`n$json`r`n'@ | ConvertFrom-Json")
|
||||
}
|
||||
|
||||
$xaml = Get-Content -Path xaml\inputXML.xaml -Raw
|
||||
$script += "`$inputXML = @'`r`n$xaml`r`n'@"
|
||||
# Read the entire XAML file as a single string, preserving line breaks
|
||||
$xaml = Get-Content -Path xaml\inputXML.xaml
|
||||
$script.Add('$inputXML = @''' + "`n" + $xaml + "`n" + '''@')
|
||||
|
||||
$autounattendXml = Get-Content -Path tools\autounattend.xml -Raw
|
||||
$script += "`$WinUtilAutounattendXml = @'`r`n$autounattendXml`r`n'@"
|
||||
$autounattendXml = Get-Content -Path tools\autounattend.xml
|
||||
$script.Add("`$WinUtilAutounattendXml = @'`r`n$autounattendXml`r`n'@")
|
||||
|
||||
$script += Get-Content -Path scripts\main.ps1 -Raw
|
||||
$script.Add((Get-Content -Path scripts\main.ps1))
|
||||
|
||||
Set-Content -Path winutil.ps1 -Value $script
|
||||
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
# GEMINI.md
|
||||
|
||||
Read `AGENTS.md` in the repository root for operating instructions before doing anything else.
|
||||
@@ -1,89 +1,105 @@
|
||||
# Chris Titus Tech's Windows Utility
|
||||
|
||||
[](https://github.com/ChrisTitusTech/winutil/releases/latest)
|
||||

|
||||
[](https://discord.gg/RUbZUZyByQ)
|
||||

|
||||
[](https://discord.gg/RUbZUZyByQ)
|
||||
[](https://winutil.christitus.com/)
|
||||
|
||||
A curated compilation of Windows system tasks streamline **installs**, debloat with **tweaks**, troubleshoot with **config**, and configure **Windows updates**. Run it fresh on every new Windows install.
|
||||
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.
|
||||
|
||||

|
||||

|
||||
|
||||
## 💡 Usage
|
||||
|
||||
---
|
||||
Winutil must be run in Admin mode because it performs system-wide tweaks. To achieve this, run PowerShell as an administrator. Here are a few ways to do it:
|
||||
|
||||
## Quick Start
|
||||
1. **Start menu Method:**
|
||||
- Right-click on the start menu.
|
||||
- Choose "Windows PowerShell (Admin)" (for Windows 10) or "Terminal (Admin)" (for Windows 11).
|
||||
|
||||
> **WinUtil must be run as Administrator** Because it performs system-wide changes.
|
||||
2. **Search and Launch Method:**
|
||||
- Press the Windows key.
|
||||
- Type "PowerShell" or "Terminal" (for Windows 11).
|
||||
- Press `Ctrl + Shift + Enter` or Right-click and choose "Run as administrator" to launch it with administrator privileges.
|
||||
|
||||
Open PowerShell or Terminal as admin, then run:
|
||||
### Launch Command
|
||||
|
||||
#### Stable Branch (Recommended)
|
||||
|
||||
**Stable Branch (recommended)**
|
||||
```ps1
|
||||
irm https://christitus.com/win | iex
|
||||
irm "https://christitus.com/win" | iex
|
||||
```
|
||||
#### Dev Branch
|
||||
|
||||
```ps1
|
||||
irm "https://christitus.com/windev" | iex
|
||||
```
|
||||
|
||||
**Development Branch**
|
||||
```ps1
|
||||
irm https://christitus.com/windev | iex
|
||||
```
|
||||
### Automation
|
||||
|
||||
### How to open an admin terminal
|
||||
Winutil also supports predefined presets that apply common configurations automatically:
|
||||
|
||||
- **Start menu:** Right-click Start → *Windows PowerShell (Admin)* or *Terminal (Admin)*
|
||||
- **Search:** Press the `Windows key`, and type `PowerShell` or `Terminal`, then `Ctrl + Shift + Enter`
|
||||
- `Standard`
|
||||
- `Minimal`
|
||||
- `Advanced`
|
||||
|
||||
---
|
||||
|
||||
## Automation / Presets
|
||||
|
||||
Apply a predefined configuration without manual selection:
|
||||
Example:
|
||||
|
||||
```powershell
|
||||
& ([ScriptBlock]::Create((irm https://christitus.com/win))) -Preset Standard
|
||||
& ([ScriptBlock]::Create((irm "https://christitus.com/win"))) -Preset Standard
|
||||
```
|
||||
|
||||
| Preset | Description |
|
||||
|--------|-------------|
|
||||
| `Standard` | Balanced defaults for most users |
|
||||
| `Minimal` | Minimal changes to suit every user |
|
||||
| `Advanced` | Deep tweaks for power users |
|
||||
|
||||
To view exactly what each preset does, see:
|
||||
https://github.com/ChrisTitusTech/winutil/blob/main/config/preset.json
|
||||
|
||||
---
|
||||
If you have Issues, refer to [Known Issues](https://winutil.christitus.com/knownissues/) or [Create Issue](https://github.com/ChrisTitusTech/winutil/issues)
|
||||
|
||||
## Build & Develop
|
||||
## 🎓 Documentation
|
||||
|
||||
See https://github.com/ChrisTitusTech/winutil/blob/main/.github/CONTRIBUTING.md
|
||||
### [WinUtil Official Documentation](https://winutil.christitus.com/)
|
||||
|
||||
---
|
||||
### [YouTube Tutorial](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
||||
|
||||
## Resources
|
||||
### [ChrisTitus.com Article](https://christitus.com/windows-tool/)
|
||||
|
||||
- [Official Documentation](https://winutil.christitus.com/)
|
||||
- [YouTube Tutorial](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
||||
- [ChrisTitus.com Article](https://christitus.com/windows-tool/)
|
||||
- [Known Issues](https://winutil.christitus.com/knownissues/)
|
||||
- [Report an Issue](https://github.com/ChrisTitusTech/winutil/issues)
|
||||
## 🛠️ Build & Develop
|
||||
|
||||
---
|
||||
> [!NOTE]
|
||||
> Winutil is a relatively large script, so it's split into multiple files which're combined into a single `.ps1` file using a custom compiler. This makes maintaining the project a lot easier.
|
||||
|
||||
## Support
|
||||
Get a copy of the source code. This can be done using GitHub UI (**Code** > **Download ZIP**), or by cloning (downloading) the repo using git.
|
||||
|
||||
- Leave a ⭐ to show support!
|
||||
If git is installed, run the following commands under a PowerShell window to clone and move into the project's directory:
|
||||
```ps1
|
||||
git clone --depth 1 "https://github.com/ChrisTitusTech/winutil.git"
|
||||
cd winutil
|
||||
```
|
||||
|
||||
To build the project, run the Compile Script under a PowerShell window (admin permissions IS NOT required):
|
||||
```ps1
|
||||
.\Compile.ps1
|
||||
```
|
||||
|
||||
You'll see a new file named `winutil.ps1`, which was created by `Compile.ps1` script. Now you can run it as admin, and a new window will pop up. Enjoy your own compiled version of WinUtil :)
|
||||
|
||||
> [!TIP]
|
||||
> For more info on using WinUtil and how to develop for it, please consider reading [the Contribution Guidelines](https://winutil.christitus.com/contributing/). If you don't know where to start, or have questions, you can ask over on our [Discord Community Server](https://discord.gg/RUbZUZyByQ), and active project members will answer when they can.
|
||||
|
||||
## 💖 Support
|
||||
- To morally and mentally support the project, make sure to leave a ⭐️!
|
||||
- EXE Wrapper for $10 @ https://www.cttstore.com/windows-toolbox
|
||||
|
||||
## Sponsors
|
||||
## 💖 Sponsors
|
||||
|
||||
These are the sponsors that help keep this project alive with monthly contributions.
|
||||
|
||||
<!-- sponsors --><a href="https://github.com/ysaito8015"><img src="https://github.com/ysaito8015.png" width="60px" alt="User avatar: Yusuke Saito" /></a><a href="https://github.com/dwelfusius"><img src="https://github.com/dwelfusius.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/mews-se"><img src="https://github.com/mews-se.png" width="60px" alt="User avatar: Martin" /></a><a href="https://github.com/jdiegmueller"><img src="https://github.com/jdiegmueller.png" width="60px" alt="User avatar: Jason A. Diegmueller" /></a><a href="https://github.com/robertsandrock"><img src="https://github.com/robertsandrock.png" width="60px" alt="User avatar: RMS" /></a><a href="https://github.com/paulsheets"><img src="https://github.com/paulsheets.png" width="60px" alt="User avatar: Paul" /></a><a href="https://github.com/djones369"><img src="https://github.com/djones369.png" width="60px" alt="User avatar: Dave J (WhamGeek)" /></a><a href="https://github.com/anthonymendez"><img src="https://github.com/anthonymendez.png" width="60px" alt="User avatar: Anthony Mendez" /></a><a href="https://github.com/FatBastard0"><img src="https://github.com/FatBastard0.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/DursleyGuy"><img src="https://github.com/DursleyGuy.png" width="60px" alt="User avatar: DursleyGuy" /></a><a href="https://github.com/DwayneTheRockLobster1"><img src="https://github.com/DwayneTheRockLobster1.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/KieraKujisawa"><img src="https://github.com/KieraKujisawa.png" width="60px" alt="User avatar: Kiera Meredith" /></a><a href="https://github.com/andrewpayne68"><img src="https://github.com/andrewpayne68.png" width="60px" alt="User avatar: Andrew P" /></a><a href="https://github.com/seanh1995"><img src="https://github.com/seanh1995.png" width="60px" alt="User avatar: Sean (ANGRYxScotsman)" /></a><a href="https://github.com/Abs313a"><img src="https://github.com/Abs313a.png" width="60px" alt="User avatar: Abs" /></a><!-- sponsors -->
|
||||
<!-- sponsors --><a href="https://github.com/dwelfusius"><img src="https://github.com/dwelfusius.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/mews-se"><img src="https://github.com/mews-se.png" width="60px" alt="User avatar: Martin Stockzell" /></a><a href="https://github.com/jdiegmueller"><img src="https://github.com/jdiegmueller.png" width="60px" alt="User avatar: Jason A. Diegmueller" /></a><a href="https://github.com/robertsandrock"><img src="https://github.com/robertsandrock.png" width="60px" alt="User avatar: RMS" /></a><a href="https://github.com/paulsheets"><img src="https://github.com/paulsheets.png" width="60px" alt="User avatar: Paul" /></a><a href="https://github.com/djones369"><img src="https://github.com/djones369.png" width="60px" alt="User avatar: Dave J (WhamGeek)" /></a><a href="https://github.com/anthonymendez"><img src="https://github.com/anthonymendez.png" width="60px" alt="User avatar: Anthony Mendez" /></a><a href="https://github.com/FatBastard0"><img src="https://github.com/FatBastard0.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/DursleyGuy"><img src="https://github.com/DursleyGuy.png" width="60px" alt="User avatar: DursleyGuy" /></a><a href="https://github.com/DwayneTheRockLobster1"><img src="https://github.com/DwayneTheRockLobster1.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/KieraKujisawa"><img src="https://github.com/KieraKujisawa.png" width="60px" alt="User avatar: Kiera Meredith" /></a><a href="https://github.com/andrewpayne68"><img src="https://github.com/andrewpayne68.png" width="60px" alt="User avatar: Andrew P" /></a><a href="https://github.com/ameaninglessname"><img src="https://github.com/ameaninglessname.png" width="60px" alt="User avatar: CodingBot" /></a><!-- sponsors -->
|
||||
|
||||
---
|
||||
|
||||
## Contributors
|
||||
## 🏅 Thanks to all Contributors
|
||||
Thanks a lot for spending your time helping Winutil grow. Thanks a lot! Keep rocking 🍻.
|
||||
|
||||
[](https://github.com/ChrisTitusTech/winutil/graphs/contributors)
|
||||
|
||||
Thanks to everyone who has contributed time and effort to this project. Keep rocking 🍻
|
||||
## 📊 GitHub Stats
|
||||
|
||||

|
||||
|
||||
@@ -1,112 +0,0 @@
|
||||
# SPEC.md
|
||||
|
||||
Project contract for WinUtil — what the project is, how it's built, and how it runs. Written for anyone, human or AI, who needs to understand the project itself.
|
||||
|
||||
`AGENTS.md` in the repository root points here for these facts, and separately covers how an agent should behave while working in this repo. This file does not change based on who's reading it.
|
||||
|
||||
## Project Context
|
||||
|
||||
WinUtil is a Windows PowerShell utility with a WPF interface. The repository is maintained as modular source, but the distributed artifact is one compiled PowerShell script.
|
||||
|
||||
### Stack
|
||||
|
||||
- Language: Windows PowerShell / PowerShell.
|
||||
- UI: WPF via `xaml/inputXML.xaml`.
|
||||
- Configuration: JSON files under `config/`.
|
||||
- Tests: Pester tests under `pester/`.
|
||||
- Lint: PowerShell Script Analyzer with settings in `lint/PSScriptAnalyser.ps1`.
|
||||
- Docs: Astro + Starlight site under `docs/`, built independently of `Compile.ps1` (its own `package.json`/`node_modules`).
|
||||
- Release artifact: generated root `winutil.ps1`.
|
||||
|
||||
### Repository Layout
|
||||
|
||||
- `Compile.ps1`: build script that creates `winutil.ps1`.
|
||||
- `scripts/start.ps1`: startup/bootstrap segment used at the beginning of the compiled script.
|
||||
- `scripts/main.ps1`: main entrypoint appended at the end of the compiled script.
|
||||
- `functions/public/`: public/UI-facing PowerShell functions.
|
||||
- `functions/private/`: internal helper PowerShell functions.
|
||||
- `config/`: JSON configuration consumed at compile time and embedded into `$sync.configs`.
|
||||
- `xaml/inputXML.xaml`: WPF UI markup embedded into the compiled script.
|
||||
- `tools/autounattend.xml`: unattended setup XML embedded for Windows ISO workflows.
|
||||
- `pester/`: Pester tests for config and function checks.
|
||||
- `lint/PSScriptAnalyser.ps1`: PowerShell Script Analyzer settings.
|
||||
- `docs/`: Astro + Starlight documentation site, with its own `package.json` and build independent of `Compile.ps1`.
|
||||
- `winutil.ps1`: ignored generated build artifact.
|
||||
|
||||
## Goals
|
||||
|
||||
- Provide a single-script Windows utility that can be launched from PowerShell.
|
||||
- Keep development modular enough for contributors to work on functions, config, UI, docs, and tooling independently.
|
||||
- Make install, tweak, feature, repair, update, and ISO workflows discoverable from the WPF UI.
|
||||
- Keep common lists and options declarative in JSON config where possible.
|
||||
- Preserve a repeatable compile process so local builds and GitHub Actions builds produce the distributable script from the same inputs.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
- `winutil.ps1` is not hand-maintained.
|
||||
- The project is not structured as a PowerShell module at runtime.
|
||||
- The GUI is not a separate packaged desktop application in this repository's normal release path.
|
||||
- Generated files should not be reviewed as source changes.
|
||||
|
||||
## Build Model
|
||||
|
||||
`Compile.ps1` combines the repository sources into `winutil.ps1` in this order:
|
||||
|
||||
1. Read `scripts/start.ps1` and replace `#{replaceme}` with the current `yy.MM.dd` build date.
|
||||
2. Append every file under `functions/` recursively.
|
||||
3. Convert each `config/*.json` file into embedded `$sync.configs` objects.
|
||||
4. Special-case `config/applications.json` so keys receive the `WPFInstall` prefix in compiled config.
|
||||
5. Embed `xaml/inputXML.xaml` into `$inputXML`.
|
||||
6. Embed `tools/autounattend.xml` into `$WinUtilAutounattendXml`.
|
||||
7. Append `scripts/main.ps1`.
|
||||
8. Write the result to root `winutil.ps1`.
|
||||
|
||||
Because the final script is concatenated, code cannot rely on runtime module imports or source-relative dot-sourcing unless the compiled script will also contain the required code/data.
|
||||
|
||||
## Runtime Model
|
||||
|
||||
- WinUtil runs in PowerShell on Windows and uses WPF for the UI.
|
||||
- Shared mutable state is stored in `$sync`, including configs, UI element references, runspace state, selections, and progress.
|
||||
- Long-running operations use runspaces or existing async patterns so the UI remains responsive.
|
||||
- UI updates from background work are dispatched back to the WPF UI thread.
|
||||
- Declarative features such as apps, tweaks, presets, DNS providers, and navigation stay in `config/*.json` unless code is required.
|
||||
|
||||
## UI And Event Contract
|
||||
|
||||
- UI layout lives in `xaml/inputXML.xaml`.
|
||||
- Named WPF controls are discovered and stored in `$sync`.
|
||||
- Button/action wiring follows a naming convention: an element named like `WPFThingButton` maps to a function named like `Invoke-WPFThingButton`.
|
||||
|
||||
## Configuration Contract
|
||||
|
||||
- Config files must remain valid JSON and compile cleanly through `ConvertFrom-Json`.
|
||||
- `config/applications.json` defines installable applications; each entry includes the fields expected by tests and UI code, such as package manager IDs, category, display content, description, and link.
|
||||
- `config/tweaks.json` defines Windows tweaks; registry and service changes include original values or original states when applicable so undo workflows can restore user systems.
|
||||
- Preset and navigation files reference valid config keys. Renaming a config key requires updating all presets, UI references, docs, and code paths together.
|
||||
|
||||
## Safety Requirements
|
||||
|
||||
- Registry, service, package manager, Windows Update, AppX removal, and ISO operations affect the host system and are treated as high-risk.
|
||||
- Tweak changes include undo metadata when the schema supports it, so changes stay reversible.
|
||||
- ISO workflows never modify the user's original ISO file; they work on copied/mounted content.
|
||||
|
||||
## Docs Site (Astro)
|
||||
|
||||
- `docs/` is an Astro + Starlight site, independent of `Compile.ps1`'s build (its own `package.json`/`node_modules`, deployed via the `docs.yaml` GitHub Actions workflow to GitHub Pages).
|
||||
- Pages live under `docs/src/content/docs/` (`.mdx`), organized into `guides/`, `code-reference/`, plus top-level pages like `faq.mdx`, `knownissues.mdx`, `contributing.mdx`, `index.mdx`.
|
||||
- `docs/src/content/docs/code-reference/tweaks/` and `.../features/` are auto-generated by `tools/devdocs-generator.ps1` from `config/tweaks.json`/`config/feature.json` and the relevant PowerShell function files. Other pages under `code-reference/` (e.g. `architecture.mdx`) are hand-written and untouched by the generator.
|
||||
- Sidebar entries in `docs/astro.config.mjs` must match actual page slugs under `docs/src/content/docs/`.
|
||||
- `docs/public/` is tracked source for static assets (favicons, etc.), not generated output. Generated/ignored paths are listed in `docs/.gitignore` (`dist/`, `.astro/`, `node_modules/`, local env files).
|
||||
- `docs/Dockerfile` and `docs/docker-compose.yml` (service `winutil-astro`) containerize the site's npm tooling; see AGENTS.md's Dependency Installs, Builds, And Dev Servers for why and how agents must use them instead of running npm on the host.
|
||||
|
||||
## Testing And CI
|
||||
|
||||
- `.\Compile.ps1` verifies the compiler can generate `winutil.ps1`.
|
||||
- `.\Compile.ps1 -Run` compiles and launches the generated utility for manual GUI verification.
|
||||
- Pester 5.8.0 runs the suite under `pester/*.Tests.ps1`. GitHub Actions (`unittests.yaml`) installs Pester 5.8.0 fresh and runs with `-CI`, which produces `testResults.xml` and exits non-zero on failure.
|
||||
- GitHub Actions also runs PowerShell Script Analyzer with `lint/PSScriptAnalyser.ps1` on every push.
|
||||
- The generated `winutil.ps1` may appear locally after compile. It remains ignored build output (see root `.gitignore`) and must not be committed.
|
||||
|
||||
## Release Artifact
|
||||
|
||||
GitHub Actions is responsible for producing the release `winutil.ps1` from repository sources. A release is considered valid only if the generated script came from the compile process, not from direct manual edits to `winutil.ps1`.
|
||||
@@ -18,7 +18,7 @@
|
||||
"foss": true
|
||||
},
|
||||
"adobe": {
|
||||
"category": "Document",
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "adobereader",
|
||||
"content": "Adobe Acrobat Reader",
|
||||
"description": "Adobe Acrobat Reader is a free PDF viewer with essential features for viewing, printing, and annotating PDF documents.",
|
||||
@@ -125,15 +125,6 @@
|
||||
"winget": "Brave.Brave",
|
||||
"foss": true
|
||||
},
|
||||
"bruno": {
|
||||
"category": "Development",
|
||||
"choco": "bruno",
|
||||
"content": "Bruno",
|
||||
"description": "Bruno is a local-first API client that stores collections as plain text files for version control and collaboration.",
|
||||
"link": "https://www.usebruno.com/",
|
||||
"winget": "Bruno.Bruno",
|
||||
"foss": true
|
||||
},
|
||||
"bulkcrapuninstaller": {
|
||||
"category": "Utilities",
|
||||
"choco": "bulk-crap-uninstaller",
|
||||
@@ -170,15 +161,6 @@
|
||||
"winget": "Cemu.Cemu",
|
||||
"foss": true
|
||||
},
|
||||
"chatgpt": {
|
||||
"category": "Development",
|
||||
"choco": "na",
|
||||
"content": "ChatGPT Desktop",
|
||||
"description": "The official ChatGPT desktop app for Windows, distributed through the Microsoft Store.",
|
||||
"link": "https://apps.microsoft.com/detail/9nt1r1c2hh7j",
|
||||
"winget": "msstore:9NT1R1C2HH7J",
|
||||
"foss": false
|
||||
},
|
||||
"chatterino": {
|
||||
"category": "Communications",
|
||||
"choco": "chatterino",
|
||||
@@ -206,33 +188,6 @@
|
||||
"winget": "Hibbiki.Chromium",
|
||||
"foss": true
|
||||
},
|
||||
"cinebenchr23": {
|
||||
"category": "Pro Tools",
|
||||
"choco": "na",
|
||||
"content": "Cinebench R23",
|
||||
"description": "Cinebench R23 is a benchmark tool for comparing CPU rendering performance across systems.",
|
||||
"link": "https://www.maxon.net/en/cinebench",
|
||||
"winget": "Maxon.CinebenchR23",
|
||||
"foss": false
|
||||
},
|
||||
"claude": {
|
||||
"category": "Development",
|
||||
"choco": "claude",
|
||||
"content": "Claude Desktop",
|
||||
"description": "Anthropic's Claude desktop application for focused AI-assisted work and chat.",
|
||||
"link": "https://claude.ai/download",
|
||||
"winget": "Anthropic.Claude",
|
||||
"foss": false
|
||||
},
|
||||
"claude-code": {
|
||||
"category": "Development",
|
||||
"choco": "claude-code",
|
||||
"content": "Claude Code",
|
||||
"description": "Anthropic's agentic coding tool for terminal and IDE development workflows.",
|
||||
"link": "https://code.claude.com/",
|
||||
"winget": "Anthropic.ClaudeCode",
|
||||
"foss": false
|
||||
},
|
||||
"cmake": {
|
||||
"category": "Development",
|
||||
"choco": "cmake",
|
||||
@@ -242,15 +197,6 @@
|
||||
"winget": "Kitware.CMake",
|
||||
"foss": true
|
||||
},
|
||||
"codex": {
|
||||
"category": "Development",
|
||||
"choco": "codex",
|
||||
"content": "Codex",
|
||||
"description": "Codex CLI is an OpenAI coding agent that runs locally in your terminal.",
|
||||
"link": "https://developers.openai.com/codex/cli",
|
||||
"winget": "OpenAI.Codex",
|
||||
"foss": true
|
||||
},
|
||||
"cpuz": {
|
||||
"category": "Pro Tools",
|
||||
"choco": "cpu-z",
|
||||
@@ -332,15 +278,6 @@
|
||||
"winget": "SpikeHD.Dorion",
|
||||
"foss": true
|
||||
},
|
||||
"dockerdesktop": {
|
||||
"category": "Development",
|
||||
"choco": "docker-desktop",
|
||||
"content": "Docker Desktop",
|
||||
"description": "Docker Desktop provides a local environment for building, running, and testing containerized applications on Windows.",
|
||||
"link": "https://www.docker.com/products/docker-desktop/",
|
||||
"winget": "Docker.DockerDesktop",
|
||||
"foss": false
|
||||
},
|
||||
"dotnet6": {
|
||||
"category": "Microsoft Tools",
|
||||
"choco": "dotnet-6.0-runtime",
|
||||
@@ -377,15 +314,6 @@
|
||||
"winget": "Microsoft.DotNet.DesktopRuntime.10",
|
||||
"foss": true
|
||||
},
|
||||
"dropbox": {
|
||||
"category": "Utilities",
|
||||
"choco": "dropbox",
|
||||
"content": "Dropbox",
|
||||
"description": "Dropbox is a cloud storage client for syncing files, sharing content, and keeping documents available across devices.",
|
||||
"link": "https://www.dropbox.com/desktop",
|
||||
"winget": "Dropbox.Dropbox",
|
||||
"foss": false
|
||||
},
|
||||
"eaapp": {
|
||||
"category": "Games",
|
||||
"choco": "ea-app",
|
||||
@@ -476,33 +404,6 @@
|
||||
"winget": "flux.flux",
|
||||
"foss": false
|
||||
},
|
||||
"foobar": {
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "foobar2000",
|
||||
"content": "foobar2000 (Music Player)",
|
||||
"description": "foobar2000 is a highly customizable and extensible music player for Windows, known for its modular design and advanced features.",
|
||||
"link": "https://www.foobar2000.org/",
|
||||
"winget": "PeterPawlowski.foobar2000",
|
||||
"foss": false
|
||||
},
|
||||
"fnm": {
|
||||
"category": "Development",
|
||||
"choco": "fnm",
|
||||
"content": "Fast Node Manager",
|
||||
"description": "Fast Node Manager (fnm) is a fast, cross-platform tool for installing and switching between Node.js versions.",
|
||||
"link": "https://github.com/Schniz/fnm",
|
||||
"winget": "Schniz.fnm",
|
||||
"foss": true
|
||||
},
|
||||
"foxpdfreader": {
|
||||
"category": "Document",
|
||||
"choco": "foxitreader",
|
||||
"content": "Foxit PDF Reader",
|
||||
"description": "Foxit PDF Reader is a free PDF viewer with a familiar ribbon-style interface.",
|
||||
"link": "https://www.foxit.com/pdf-reader/",
|
||||
"winget": "Foxit.FoxitReader",
|
||||
"foss": false
|
||||
},
|
||||
"geforcenow": {
|
||||
"category": "Games",
|
||||
"choco": "nvidia-geforce-now",
|
||||
@@ -530,24 +431,6 @@
|
||||
"winget": "Git.Git",
|
||||
"foss": true
|
||||
},
|
||||
"gitextensions": {
|
||||
"category": "Development",
|
||||
"choco": "gitextensions",
|
||||
"content": "Git Extensions",
|
||||
"description": "Git Extensions is a graphical Git client for Windows with repository, history, and commit management tools.",
|
||||
"link": "https://gitextensions.github.io/",
|
||||
"winget": "GitExtensionsTeam.GitExtensions",
|
||||
"foss": true
|
||||
},
|
||||
"githubcli": {
|
||||
"category": "Development",
|
||||
"choco": "gh",
|
||||
"content": "GitHub CLI",
|
||||
"description": "GitHub CLI brings pull requests, issues, releases, and other GitHub workflows to the terminal.",
|
||||
"link": "https://cli.github.com/",
|
||||
"winget": "GitHub.cli",
|
||||
"foss": true
|
||||
},
|
||||
"githubdesktop": {
|
||||
"category": "Development",
|
||||
"choco": "git;github-desktop",
|
||||
@@ -593,15 +476,6 @@
|
||||
"winget": "TechPowerUp.GPU-Z",
|
||||
"foss": false
|
||||
},
|
||||
"gsudo": {
|
||||
"category": "Pro Tools",
|
||||
"choco": "gsudo",
|
||||
"content": "gsudo",
|
||||
"description": "gsudo is a sudo equivalent for Windows. It allows you to run commands with elevated administrative privileges directly within the current console window.",
|
||||
"link": "https://github.com/gerardog/gsudo",
|
||||
"winget": "gerardog.gsudo",
|
||||
"foss": true
|
||||
},
|
||||
"helium": {
|
||||
"category": "Browsers",
|
||||
"choco": "helium",
|
||||
@@ -665,23 +539,13 @@
|
||||
"winget": "DuongDieuPhap.ImageGlass",
|
||||
"foss": true
|
||||
},
|
||||
"internetdownloadmanager": {
|
||||
"category": "Utilities",
|
||||
"choco": "internet-download-manager",
|
||||
"content": "Internet Download Manager",
|
||||
"description": "Internet Download Manager is a download manager for accelerating, resuming, and scheduling file downloads.",
|
||||
"link": "https://www.internetdownloadmanager.com/",
|
||||
"winget": "Tonec.InternetDownloadManager",
|
||||
"foss": false
|
||||
},
|
||||
"irfanview": {
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "irfanview",
|
||||
"content": "IrfanView",
|
||||
"description": "IrfanView is a lightweight, fast, and free image viewer and editor. Supports multiple formats, batch processing, and powerful plugins.",
|
||||
"link": "https://irfanview.com/",
|
||||
"winget": "IrfanSkiljan.IrfanView",
|
||||
"foss": false
|
||||
"winget": "IrfanSkiljan.IrfanView"
|
||||
},
|
||||
"itch": {
|
||||
"category": "Games",
|
||||
@@ -759,29 +623,11 @@
|
||||
"category": "Utilities",
|
||||
"choco": "jpegview",
|
||||
"content": "JPEG View",
|
||||
"description": "JPEGView is a lean, fast and highly configurable viewer/editor for JPEG, BMP, PNG, WEBP, TGA, GIF, JXL, HEIC, HEIF, AVIF, and TIFF images with a minimal GUI.",
|
||||
"description": "JPEGView is a lean, fast and highly configurable viewer/editor for JPEG, BMP, PNG, WEBP, TGA, GIF, JXL, HEIC, HEIF, AVIF and TIFF images with a minimal GUI.",
|
||||
"link": "https://github.com/sylikc/jpegview",
|
||||
"winget": "sylikc.JPEGView",
|
||||
"foss": true
|
||||
},
|
||||
"joplin": {
|
||||
"category": "Document",
|
||||
"choco": "joplin",
|
||||
"content": "Joplin",
|
||||
"description": "Joplin is an open-source note-taking and to-do application with synchronization capabilities.",
|
||||
"link": "https://joplinapp.org/",
|
||||
"winget": "Joplin.Joplin",
|
||||
"foss": true
|
||||
},
|
||||
"keepassxc": {
|
||||
"category": "Utilities",
|
||||
"choco": "keepassxc",
|
||||
"content": "KeePassXC",
|
||||
"description": "KeePassXC is a modern, secure, and open-source password manager that stores and manages your most sensitive information. You can run KeePassXC on Windows, macOS, and Linux systems. KeePassXC is for people with extremely high demands of secure personal data management. It saves many different types of information, such as usernames, passwords, URLs, attachments, and notes in an offline, encrypted file that can be stored in any location, including private and public cloud solutions. For easy identification and management, user-defined titles and icons can be specified for entries. In addition, entries are sorted into customizable groups. An integrated search function allows you to use advanced patterns to easily find any entry in your database. A customizable, fast, and easy-to-use password generator utility allows you to create passwords with any combination of characters or easy to remember passphrases.",
|
||||
"link": "https://keepassxc.org/",
|
||||
"winget": "KeePassXCTeam.KeePassXC",
|
||||
"foss": true
|
||||
},
|
||||
"klite": {
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "k-litecodecpack-standard",
|
||||
@@ -810,7 +656,7 @@
|
||||
"foss": true
|
||||
},
|
||||
"libreoffice": {
|
||||
"category": "Document",
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "libreoffice-fresh",
|
||||
"content": "LibreOffice",
|
||||
"description": "LibreOffice is a powerful and free office suite, compatible with other major office suites.",
|
||||
@@ -845,14 +691,6 @@
|
||||
"winget": "mpc-qt.mpc-qt",
|
||||
"foss": true
|
||||
},
|
||||
"mpv": {
|
||||
"category": "Multimedia Tools",
|
||||
"content": "mpv",
|
||||
"description": "mpv is a free, open source, and cross-platform media player supporting a wide variety of media formats, codecs, and subtitle types.",
|
||||
"link": "https://mpv.io/",
|
||||
"winget": "shinchiro.mpv",
|
||||
"foss": true
|
||||
},
|
||||
"matrix": {
|
||||
"category": "Communications",
|
||||
"choco": "element-desktop",
|
||||
@@ -862,15 +700,6 @@
|
||||
"winget": "Element.Element",
|
||||
"foss": true
|
||||
},
|
||||
"minitoolpartitionwizard": {
|
||||
"category": "Utilities",
|
||||
"choco": "minitoolpartitionwizard",
|
||||
"content": "MiniTool Partition Wizard",
|
||||
"description": "Comprehensive free partition manager that performs advanced operations Windows natively cannot, such as merging partitions, converting file systems, and organizing disk capacity.",
|
||||
"link": "https://www.partitionwizard.com/",
|
||||
"winget": "MiniTool.PartitionWizard.Free",
|
||||
"foss": false
|
||||
},
|
||||
"modrinth": {
|
||||
"category": "Games",
|
||||
"choco": "modrinth-app",
|
||||
@@ -934,15 +763,6 @@
|
||||
"winget": "MullvadVPN.MullvadBrowser",
|
||||
"foss": true
|
||||
},
|
||||
"nomacs": {
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "nomacs",
|
||||
"content": "nomacs",
|
||||
"description": "nomacs is a free, open-source image viewer, which supports multiple platforms. You can use it for viewing all common image formats, including RAW and .psd images.",
|
||||
"link": "https://nomacs.org/",
|
||||
"winget": "nomacs.nomacs",
|
||||
"foss": true
|
||||
},
|
||||
"nanazip": {
|
||||
"category": "Utilities",
|
||||
"choco": "nanazip",
|
||||
@@ -956,15 +776,15 @@
|
||||
"category": "Selfhosted Tools",
|
||||
"choco": "netbird",
|
||||
"content": "NetBird",
|
||||
"description": "NetBird is an open-source alternative comparable to TailScale that can be connected to a self-hosted server.",
|
||||
"description": "NetBird is a open-source alternative comparable to TailScale that can be connected to a self-hosted server.",
|
||||
"link": "https://netbird.io/",
|
||||
"winget": "Netbird.Netbird",
|
||||
"foss": true
|
||||
},
|
||||
"naps2": {
|
||||
"category": "Document",
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "naps2",
|
||||
"content": "NAPS2 (Scanner)",
|
||||
"content": "NAPS2 (Document Scanner)",
|
||||
"description": "NAPS2 is a document scanning application that simplifies the process of creating electronic documents.",
|
||||
"link": "https://www.naps2.com/",
|
||||
"winget": "Cyanfish.NAPS2",
|
||||
@@ -1015,14 +835,6 @@
|
||||
"winget": "OpenJS.NodeJS.LTS",
|
||||
"foss": true
|
||||
},
|
||||
"pnpm": {
|
||||
"category": "Development",
|
||||
"content": "pnpm",
|
||||
"description": "pnpm is a fast and disk space efficient package manager for JavaScript and Node.js applications.",
|
||||
"link": "https://pnpm.io/",
|
||||
"winget": "pnpm.pnpm",
|
||||
"foss": true
|
||||
},
|
||||
"notepadplus": {
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "notepadplusplus",
|
||||
@@ -1060,7 +872,7 @@
|
||||
"foss": true
|
||||
},
|
||||
"obsidian": {
|
||||
"category": "Document",
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "obsidian",
|
||||
"content": "Obsidian",
|
||||
"description": "Obsidian is a powerful note-taking and knowledge management application.",
|
||||
@@ -1068,15 +880,6 @@
|
||||
"winget": "Obsidian.Obsidian",
|
||||
"foss": false
|
||||
},
|
||||
"okular": {
|
||||
"category": "Document",
|
||||
"choco": "okular",
|
||||
"content": "Okular",
|
||||
"description": "Okular is a versatile document viewer with advanced features.",
|
||||
"link": "https://okular.kde.org/",
|
||||
"winget": "KDE.Okular",
|
||||
"foss": true
|
||||
},
|
||||
"onedrive": {
|
||||
"category": "Microsoft Tools",
|
||||
"choco": "onedrive",
|
||||
@@ -1087,10 +890,10 @@
|
||||
"foss": false
|
||||
},
|
||||
"onlyoffice": {
|
||||
"category": "Document",
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "onlyoffice",
|
||||
"content": "ONLYOFFICE Desktop",
|
||||
"description": "ONLYOFFICE Desktop is a comprehensive office suite for document editing and collaboration.",
|
||||
"content": "ONLYOffice Desktop",
|
||||
"description": "ONLYOffice Desktop is a comprehensive office suite for document editing and collaboration.",
|
||||
"link": "https://www.onlyoffice.com/desktop.aspx",
|
||||
"winget": "ONLYOFFICE.DesktopEditors",
|
||||
"foss": true
|
||||
@@ -1117,10 +920,10 @@
|
||||
"category": "Pro Tools",
|
||||
"choco": "openvpn-connect",
|
||||
"content": "OpenVPN Connect",
|
||||
"description": "OpenVPN Connect is a VPN client that allows you to connect securely to a VPN server. It provides a secure and encrypted connection for protecting your online privacy.",
|
||||
"description": "OpenVPN Connect is an open-source VPN client that allows you to connect securely to a VPN server. It provides a secure and encrypted connection for protecting your online privacy.",
|
||||
"link": "https://openvpn.net/",
|
||||
"winget": "OpenVPNTechnologies.OpenVPNConnect",
|
||||
"foss": false
|
||||
"foss": true
|
||||
},
|
||||
"OVirtualBox": {
|
||||
"category": "Utilities",
|
||||
@@ -1176,51 +979,6 @@
|
||||
"winget": "Giorgiotani.Peazip",
|
||||
"foss": true
|
||||
},
|
||||
"pdf-xchange": {
|
||||
"category": "Document",
|
||||
"choco": "pdfxchangeeditor",
|
||||
"content": "PDF-XChange Editor",
|
||||
"description": "A comprehensive Windows-based software suite and editor for creating, viewing, editing, annotating, and signing PDF files.",
|
||||
"link": "https://www.pdf-xchange.com/",
|
||||
"winget": "TrackerSoftware.PDF-XChangeEditor",
|
||||
"foss": false
|
||||
},
|
||||
"pdf24creator": {
|
||||
"category": "Document",
|
||||
"choco": "pdf24",
|
||||
"content": "PDF24 Creator",
|
||||
"description": "Free and easy-to-use online/desktop PDF tools that make you more productive",
|
||||
"link": "https://tools.pdf24.org/en/creator",
|
||||
"winget": "geeksoftwareGmbH.PDF24Creator",
|
||||
"foss": false
|
||||
},
|
||||
"pdfgear": {
|
||||
"category": "Document",
|
||||
"choco": "pdfgear",
|
||||
"content": "PDFgear",
|
||||
"description": "PDFgear is a piece of full-featured PDF management software for Windows, macOS, and mobile, and it's completely free to use.",
|
||||
"link": "https://www.pdfgear.com/",
|
||||
"winget": "PDFgear.PDFgear",
|
||||
"foss": false
|
||||
},
|
||||
"pdfsam": {
|
||||
"category": "Document",
|
||||
"choco": "pdfsam",
|
||||
"content": "PDFsam Basic",
|
||||
"description": "PDFsam Basic is a free and open-source tool for splitting, merging, and rotating PDF files.",
|
||||
"link": "https://pdfsam.org/",
|
||||
"winget": "PDFsam.PDFsam",
|
||||
"foss": true
|
||||
},
|
||||
"playnite": {
|
||||
"category": "Games",
|
||||
"choco": "playnite",
|
||||
"content": "Playnite",
|
||||
"description": "Playnite is an open-source video game library manager with one simple goal: To provide a unified interface for all of your games.",
|
||||
"link": "https://playnite.link/",
|
||||
"winget": "Playnite.Playnite",
|
||||
"foss": true
|
||||
},
|
||||
"plex": {
|
||||
"category": "Selfhosted Tools",
|
||||
"choco": "plexmediaserver",
|
||||
@@ -1248,15 +1006,6 @@
|
||||
"winget": "JanDeDobbeleer.OhMyPosh",
|
||||
"foss": true
|
||||
},
|
||||
"postman": {
|
||||
"category": "Development",
|
||||
"choco": "postman",
|
||||
"content": "Postman",
|
||||
"description": "Postman is an API platform and desktop client for designing, testing, documenting, and collaborating on APIs.",
|
||||
"link": "https://www.postman.com/downloads/",
|
||||
"winget": "Postman.Postman",
|
||||
"foss": false
|
||||
},
|
||||
"powershell": {
|
||||
"category": "Microsoft Tools",
|
||||
"choco": "powershell-core",
|
||||
@@ -1279,7 +1028,7 @@
|
||||
"category": "Games",
|
||||
"choco": "prismlauncher",
|
||||
"content": "Prism Launcher",
|
||||
"description": "Prism Launcher is an open-source Minecraft launcher with the ability to manage multiple instances, accounts, and mods.",
|
||||
"description": "Prism Launcher is an open-source Minecraft launcher with the ability to manage multiple instances, accounts and mods.",
|
||||
"link": "https://prismlauncher.org/",
|
||||
"winget": "PrismLauncher.PrismLauncher",
|
||||
"foss": true
|
||||
@@ -1341,7 +1090,7 @@
|
||||
"processmonitor": {
|
||||
"category": "Microsoft Tools",
|
||||
"choco": "procexp",
|
||||
"content": "Process Monitor",
|
||||
"content": "SysInternals Process Monitor",
|
||||
"description": "SysInternals Process Monitor is an advanced monitoring tool that shows real-time file system, registry, and process/thread activity.",
|
||||
"link": "https://docs.microsoft.com/en-us/sysinternals/downloads/procmon",
|
||||
"winget": "Microsoft.Sysinternals.ProcessMonitor",
|
||||
@@ -1410,6 +1159,15 @@
|
||||
"winget": "Rufus.Rufus",
|
||||
"foss": true
|
||||
},
|
||||
"rustdesk": {
|
||||
"category": "Pro Tools",
|
||||
"choco": "rustdesk.portable",
|
||||
"content": "RustDesk",
|
||||
"description": "RustDesk is a free and open-source remote desktop application. It provides a secure way to connect to remote machines and access desktop environments.",
|
||||
"link": "https://rustdesk.com/",
|
||||
"winget": "RustDesk.RustDesk",
|
||||
"foss": true
|
||||
},
|
||||
"rustlang": {
|
||||
"category": "Development",
|
||||
"choco": "rust",
|
||||
@@ -1473,15 +1231,6 @@
|
||||
"winget": "WhirlwindFX.SignalRgb",
|
||||
"foss": false
|
||||
},
|
||||
"simplenote": {
|
||||
"category": "Document",
|
||||
"choco": "simplenote",
|
||||
"content": "Simplenote",
|
||||
"description": "Simplenote is an easy way to keep notes, lists, ideas and more.",
|
||||
"link": "https://simplenote.com/",
|
||||
"winget": "Automattic.Simplenote",
|
||||
"foss": true
|
||||
},
|
||||
"simplewall": {
|
||||
"category": "Pro Tools",
|
||||
"choco": "simplewall",
|
||||
@@ -1500,24 +1249,6 @@
|
||||
"winget": "SlackTechnologies.Slack",
|
||||
"foss": false
|
||||
},
|
||||
"startallback": {
|
||||
"category": "Utilities",
|
||||
"choco": "StartAllBack",
|
||||
"content": "StartAllBack",
|
||||
"description": "StartAllBack restores and improves Windows taskbar, Start menu, File Explorer, and shell UI behavior.",
|
||||
"link": "https://www.startallback.com/",
|
||||
"winget": "StartIsBack.StartAllBack",
|
||||
"foss": false
|
||||
},
|
||||
"starship": {
|
||||
"category": "Development",
|
||||
"choco": "starship",
|
||||
"content": "Starship (Shell Prompt)",
|
||||
"description": "Starship is a fast, customizable, cross-platform prompt for PowerShell and other shells.",
|
||||
"link": "https://starship.rs/",
|
||||
"winget": "Starship.Starship",
|
||||
"foss": true
|
||||
},
|
||||
"steam": {
|
||||
"category": "Games",
|
||||
"choco": "steam-client",
|
||||
@@ -1527,15 +1258,6 @@
|
||||
"winget": "Valve.Steam",
|
||||
"foss": false
|
||||
},
|
||||
"roblox": {
|
||||
"category": "Games",
|
||||
"choco": "na",
|
||||
"content": "Roblox",
|
||||
"description": "Roblox is a platform and game creation system that allows users to create and play games developed by the community.",
|
||||
"link": "https://www.roblox.com/",
|
||||
"winget": "Roblox.Roblox",
|
||||
"foss": false
|
||||
},
|
||||
"sublimetext": {
|
||||
"category": "Development",
|
||||
"choco": "sublimetext4",
|
||||
@@ -1545,15 +1267,6 @@
|
||||
"winget": "SublimeHQ.SublimeText.4",
|
||||
"foss": false
|
||||
},
|
||||
"sumatra": {
|
||||
"category": "Document",
|
||||
"choco": "sumatrapdf",
|
||||
"content": "Sumatra PDF",
|
||||
"description": "Sumatra PDF is a lightweight and fast PDF viewer with minimalistic design.",
|
||||
"link": "https://www.sumatrapdfreader.org/free-pdf-reader.html",
|
||||
"winget": "SumatraPDF.SumatraPDF",
|
||||
"foss": true
|
||||
},
|
||||
"sunshine": {
|
||||
"category": "Selfhosted Tools",
|
||||
"choco": "sunshine",
|
||||
@@ -1566,7 +1279,7 @@
|
||||
"tcpview": {
|
||||
"category": "Microsoft Tools",
|
||||
"choco": "tcpview",
|
||||
"content": "TCPView",
|
||||
"content": "SysInternals TCPView",
|
||||
"description": "SysInternals TCPView is a network monitoring tool that displays a detailed list of all TCP and UDP endpoints on your system.",
|
||||
"link": "https://docs.microsoft.com/en-us/sysinternals/downloads/tcpview",
|
||||
"winget": "Microsoft.Sysinternals.TCPView",
|
||||
@@ -1594,20 +1307,11 @@
|
||||
"category": "Communications",
|
||||
"choco": "teamspeak",
|
||||
"content": "TeamSpeak 3",
|
||||
"description": "TEAMSPEAK. YOUR TEAM. YOUR RULES. Use crystal clear sound to communicate with your teammates cross-platform with military-grade security, lag-free performance & unparalleled reliability and uptime.",
|
||||
"description": "TEAMSPEAK. YOUR TEAM. YOUR RULES. Use crystal clear sound to communicate with your team mates cross-platform with military-grade security, lag-free performance & unparalleled reliability and uptime.",
|
||||
"link": "https://www.teamspeak.com/",
|
||||
"winget": "TeamSpeakSystems.TeamSpeakClient",
|
||||
"foss": false
|
||||
},
|
||||
"teamspeak6": {
|
||||
"category": "Communications",
|
||||
"choco": "na",
|
||||
"content": "TeamSpeak 6",
|
||||
"description": "TEAMSPEAK. YOUR TEAM. YOUR RULES. Use crystal clear sound to communicate with your teammates cross-platform with military-grade security, lag-free performance & unparalleled reliability and uptime.",
|
||||
"link": "https://www.teamspeak.com/",
|
||||
"winget": "TeamSpeakSystems.TeamSpeakClient.Beta.6",
|
||||
"foss": false
|
||||
},
|
||||
"telegram": {
|
||||
"category": "Communications",
|
||||
"choco": "telegram",
|
||||
@@ -1692,7 +1396,7 @@
|
||||
"ungoogled": {
|
||||
"category": "Browsers",
|
||||
"choco": "ungoogled-chromium",
|
||||
"content": "Ungoogled Chromium",
|
||||
"content": "Ungoogled",
|
||||
"description": "Ungoogled Chromium is a version of Chromium without Google's integration for enhanced privacy and control.",
|
||||
"link": "https://github.com/Eloston/ungoogled-chromium",
|
||||
"winget": "eloston.ungoogled-chromium",
|
||||
@@ -1707,24 +1411,6 @@
|
||||
"winget": "Unity.UnityHub",
|
||||
"foss": false
|
||||
},
|
||||
"vagrant": {
|
||||
"category": "Development",
|
||||
"choco": "vagrant",
|
||||
"content": "Vagrant",
|
||||
"description": "Vagrant builds and manages reproducible virtual machine development environments from declarative configuration.",
|
||||
"link": "https://developer.hashicorp.com/vagrant",
|
||||
"winget": "Hashicorp.Vagrant",
|
||||
"foss": false
|
||||
},
|
||||
"everything": {
|
||||
"category": "Utilities",
|
||||
"choco": "everything",
|
||||
"content": "Everything",
|
||||
"description": "Everything is a search engine that locates files and folders by filename instantly for Windows. Unlike Windows search Everything initially displays every file and folder on your computer (hence the name Everything). You type in a search filter to limit what files and folders are displayed.",
|
||||
"link": "https://www.voidtools.com/",
|
||||
"winget": "voidtools.Everything",
|
||||
"foss": false
|
||||
},
|
||||
"vc2015_32": {
|
||||
"category": "Microsoft Tools",
|
||||
"choco": "vcredist2015",
|
||||
@@ -1842,15 +1528,6 @@
|
||||
"winget": "Waterfox.Waterfox",
|
||||
"foss": true
|
||||
},
|
||||
"whatsapp": {
|
||||
"category": "Communications",
|
||||
"choco": "na",
|
||||
"content": "WhatsApp Desktop",
|
||||
"description": "WhatsApp Desktop is the official Windows desktop messaging app from Meta, distributed through the Microsoft Store.",
|
||||
"link": "https://apps.microsoft.com/detail/9nksqgp7f2nh",
|
||||
"winget": "msstore:9NKSQGP7F2NH",
|
||||
"foss": false
|
||||
},
|
||||
"wingetui": {
|
||||
"category": "Utilities",
|
||||
"choco": "wingetui",
|
||||
@@ -1914,15 +1591,6 @@
|
||||
"winget": "MHNexus.HxD",
|
||||
"foss": false
|
||||
},
|
||||
"xournal": {
|
||||
"category": "Document",
|
||||
"choco": "xournalplusplus",
|
||||
"content": "Xournal++",
|
||||
"description": "Xournal++ is an open-source handwriting notetaking software with PDF annotation capabilities.",
|
||||
"link": "https://xournalpp.github.io/",
|
||||
"winget": "Xournal++.Xournal++",
|
||||
"foss": true
|
||||
},
|
||||
"yarn": {
|
||||
"category": "Development",
|
||||
"choco": "yarn",
|
||||
@@ -2004,15 +1672,6 @@
|
||||
"winget": "ZedIndustries.Zed",
|
||||
"foss": true
|
||||
},
|
||||
"zotero": {
|
||||
"category": "Document",
|
||||
"choco": "zotero",
|
||||
"content": "Zotero",
|
||||
"description": "Zotero is a free, easy-to-use tool to help you collect, organize, cite, and share your research materials.",
|
||||
"link": "https://www.zotero.org/",
|
||||
"winget": "DigitalScholar.Zotero",
|
||||
"foss": true
|
||||
},
|
||||
"deskflow": {
|
||||
"category": "Utilities",
|
||||
"choco": "deskflow",
|
||||
|
||||
@@ -73,11 +73,12 @@
|
||||
"Order": "5",
|
||||
"Description": "Show the selected applications"
|
||||
},
|
||||
"WPFInstallFOSSInfo": {
|
||||
"Content": "Free and Open Source Software",
|
||||
"WPFToggleFOSSHighlight": {
|
||||
"Content": "Highlight FOSS",
|
||||
"Category": "__Selection",
|
||||
"Type": "Note",
|
||||
"Order": "0",
|
||||
"Description": "Information about the #FOSS label on application entries"
|
||||
"Type": "Toggle",
|
||||
"Checked": true,
|
||||
"Order": "6",
|
||||
"Description": "Toggle the green highlight for FOSS applications"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,263 +0,0 @@
|
||||
{
|
||||
"WPFAppxMicrosoft_WindowsFeedbackHub": {
|
||||
"Category": "Microsoft Apps",
|
||||
"Content": "Feedback Hub",
|
||||
"Description": "Allows users to submit bug reports, feature suggestions, and diagnostic data directly to Microsoft.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.WindowsFeedbackHub",
|
||||
"StoreId": "9NBLGGH4R32N"
|
||||
},
|
||||
"WPFAppxMicrosoft_GetHelp": {
|
||||
"Category": "Microsoft Apps",
|
||||
"Content": "Get Help",
|
||||
"Description": "Provides access to automated troubleshooting guides, support documentation, and direct Microsoft customer assistance.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.GetHelp",
|
||||
"StoreId": "9PKDZBMV1H3T"
|
||||
},
|
||||
"WPFAppxMicrosoft_OutlookForWindows": {
|
||||
"Category": "Microsoft Apps",
|
||||
"Content": "Outlook for Windows",
|
||||
"Description": "Provides modern email management, calendar scheduling, and contact organization features.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.OutlookForWindows",
|
||||
"StoreId": "9NRX63209R7B"
|
||||
},
|
||||
"WPFAppxMSTeams": {
|
||||
"Category": "Microsoft Apps",
|
||||
"Content": "Microsoft Teams",
|
||||
"Description": "Facilitates instant messaging, video conferencing, file sharing, and workspace collaboration.",
|
||||
"Panel": "0",
|
||||
"PackageId": "MSTeams",
|
||||
"StoreId": "XP8BT8DW290MPQ"
|
||||
},
|
||||
"WPFAppxClipchamp_Clipchamp": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Clipchamp",
|
||||
"Description": "Provides a user-friendly video editor with built-in templates, effects, and timeline editing tools.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Clipchamp.Clipchamp",
|
||||
"StoreId": "9P1J8S7CCWWT"
|
||||
},
|
||||
"WPFAppxMicrosoft_MicrosoftOfficeHub": {
|
||||
"Category": "Microsoft Apps",
|
||||
"Content": "Microsoft 365",
|
||||
"Description": "Serves as a centralized launcher and dashboard for accessing cloud-based Microsoft 365 apps and recent documents.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.MicrosoftOfficeHub",
|
||||
"StoreId": "9WZDNCRD29V9"
|
||||
},
|
||||
"WPFAppxMicrosoft_ZuneMusic": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Media Player",
|
||||
"Description": "Plays local audio and video files with modern playlist management and casting capabilities.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.ZuneMusic",
|
||||
"StoreId": "9WZDNCRFJ3PT"
|
||||
},
|
||||
"WPFAppxMicrosoft_BingSearch": {
|
||||
"Category": "Bing & Web Services",
|
||||
"Content": "Bing Search",
|
||||
"Description": "Integrates Microsoft Bing search capabilities and web services directly into the operating system.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.BingSearch",
|
||||
"StoreId": "9NZBF4GT040C"
|
||||
},
|
||||
"WPFAppxMicrosoftCorporationII_QuickAssist": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Quick Assist",
|
||||
"Description": "Enables secure remote technical support and screen sharing over an internet connection.",
|
||||
"Panel": "0",
|
||||
"PackageId": "MicrosoftCorporationII.QuickAssist",
|
||||
"StoreId": "9P7BP5VNWKX5"
|
||||
},
|
||||
"WPFAppxMicrosoft_WindowsDevHome": {
|
||||
"Category": "Developer Tools",
|
||||
"Content": "Dev Home",
|
||||
"Description": "Provides a specialized dashboard for software developer environment setups, repository syncing, and hardware widgets.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.Windows.DevHome",
|
||||
"StoreId": "9N8MHTPHNGVV"
|
||||
},
|
||||
"WPFAppxMicrosoft_WindowsCrossDevice": {
|
||||
"Category": "Microsoft Ecosystem",
|
||||
"Content": "Mobile Devices",
|
||||
"Description": "Manages system-level background connectivity with paired mobile devices. Removing this may disable cross-device features such as phone screen mirroring, file transfer, and mobile hotspot handoff integrated into Windows Settings.",
|
||||
"Panel": "0",
|
||||
"PackageId": "MicrosoftWindows.CrossDevice",
|
||||
"StoreId": "9NTXGKQ8P7N0"
|
||||
},
|
||||
"WPFAppxMicrosoft_Todos": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "To Do",
|
||||
"Description": "Creates, tracks, and synchronizes personal tasks, smart lists, and daily reminders.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.Todos",
|
||||
"StoreId": "9NBLGGH5R558"
|
||||
},
|
||||
"WPFAppxMicrosoft_PowerAutomateDesktop": {
|
||||
"Category": "Developer Tools",
|
||||
"Content": "Power Automate",
|
||||
"Description": "Automates repetitive workflows and desktop tasks using low-code visual scripting.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.PowerAutomateDesktop",
|
||||
"StoreId": "9NFTCH6J7FHV"
|
||||
},
|
||||
"WPFAppxMicrosoft_YourPhone": {
|
||||
"Category": "Microsoft Ecosystem",
|
||||
"Content": "Phone Link",
|
||||
"Description": "Synchronizes text messages, phone notifications, photos, and calls from a mobile device to the desktop.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.YourPhone",
|
||||
"StoreId": "9NMPJ99VJBWV"
|
||||
},
|
||||
"WPFAppxMicrosoft_MicrosoftStickyNotes": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Sticky Notes",
|
||||
"Description": "Creates quick, floating text notes on the desktop that automatically sync across devices.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.MicrosoftStickyNotes",
|
||||
"StoreId": "9NBLGGH4QGHW"
|
||||
},
|
||||
"WPFAppxMicrosoft_WindowsSoundRecorder": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Sound Recorder",
|
||||
"Description": "Records and trims live audio inputs with simple microphone adjustment controls.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.WindowsSoundRecorder",
|
||||
"StoreId": "9WZDNCRFHWKN"
|
||||
},
|
||||
"WPFAppxMicrosoft_WindowsAlarms": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Clock",
|
||||
"Description": "Features world clocks, alarms, countdown timers, stopwatches, and dedicated focus session tracking.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.WindowsAlarms",
|
||||
"StoreId": "9WZDNCRFJ3PR"
|
||||
},
|
||||
"WPFAppxMicrosoft_Paint": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Paint",
|
||||
"Description": "Provides built-in digital sketching, basic image editing, and pixel-level graphic manipulation tools.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.Paint",
|
||||
"StoreId": "9PCFS5B6T72H"
|
||||
},
|
||||
"WPFAppxMicrosoft_WindowsNotepad": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Notepad",
|
||||
"Description": "Provides a lightweight text editor with multi-tab support for plain text files and code snippets.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.WindowsNotepad",
|
||||
"StoreId": "9MSMLRH6LZF3"
|
||||
},
|
||||
"WPFAppxMicrosoft_ScreenSketch": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Snipping Tool",
|
||||
"Description": "Captures screenshots or screen recordings with built-in markup, image cropping, and optical character recognition (OCR).",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.ScreenSketch",
|
||||
"StoreId": "9MZ95KL8MR0L"
|
||||
},
|
||||
"WPFAppxMicrosoft_Copilot": {
|
||||
"Category": "Bing & Web Services",
|
||||
"Content": "Copilot",
|
||||
"Description": "Launches the Microsoft AI companion for contextual answers, creative writing assistance, and intelligent web search.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.Copilot",
|
||||
"StoreId": "9NHT9RB2F4HD"
|
||||
},
|
||||
"WPFAppxMicrosoft_WindowsCalculator": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Calculator",
|
||||
"Description": "Performs standard arithmetic, scientific operations, programming calculations, and unit conversions.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.WindowsCalculator",
|
||||
"StoreId": "9WZDNCRFHVN5"
|
||||
},
|
||||
"WPFAppxMicrosoft_WindowsCamera": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Camera",
|
||||
"Description": "Captures photographs and records video files via connected webcams or imaging hardware.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.WindowsCamera",
|
||||
"StoreId": "9WZDNCRFJBBG"
|
||||
},
|
||||
"WPFAppxMicrosoft_WindowsPhotos": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Photos",
|
||||
"Description": "Organizes, views, and crops local images with basic color adjustment and album creation tools.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.Windows.Photos",
|
||||
"StoreId": "9WZDNCRFJBH4"
|
||||
},
|
||||
"WPFAppxMicrosoft_BingNews": {
|
||||
"Category": "Bing & Web Services",
|
||||
"Content": "News",
|
||||
"Description": "Aggregates breaking news headlines, personalized article feeds, and world current events.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.BingNews",
|
||||
"StoreId": "9WZDNCRFHVFW"
|
||||
},
|
||||
"WPFAppxMicrosoft_BingWeather": {
|
||||
"Category": "Bing & Web Services",
|
||||
"Content": "Weather",
|
||||
"Description": "Displays local real-time weather tracking, radar maps, and historical meteorological forecasts.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.BingWeather",
|
||||
"StoreId": "9WZDNCRFJ3Q2"
|
||||
},
|
||||
"WPFAppxMicrosoft_GamingApp": {
|
||||
"Category": "Xbox & Gaming",
|
||||
"Content": "Xbox App",
|
||||
"Description": "Serves as the primary gaming library manager, social community interface, and PC Game Pass dashboard.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.GamingApp",
|
||||
"StoreId": "9MV0B5HZVK9Z"
|
||||
},
|
||||
"WPFAppxMicrosoft_XboxGamingOverlay": {
|
||||
"Category": "Xbox & Gaming",
|
||||
"Content": "Xbox Game Bar",
|
||||
"Description": "Provides customizable in-game status widgets, audio balancing sliders, system monitoring tools, and gameplay recording.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.XboxGamingOverlay",
|
||||
"StoreId": "9NZKPSTSNW4P"
|
||||
},
|
||||
"WPFAppxMicrosoft_XboxIdentityProvider": {
|
||||
"Category": "Xbox & Gaming",
|
||||
"Content": "Xbox Identity Provider",
|
||||
"Description": "Manages Xbox network user authentication and background account validation for connected titles. Warning: removing this may break Microsoft account sign-in for non-Xbox games and apps that rely on this authentication pipeline.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.XboxIdentityProvider",
|
||||
"StoreId": "9WZDNCRD1HKW"
|
||||
},
|
||||
"WPFAppxMicrosoft_XboxSpeechToTextOverlay": {
|
||||
"Category": "Xbox & Gaming",
|
||||
"Content": "Xbox Speech To Text Overlay",
|
||||
"Description": "Provides system-level live accessibility captions and voice-to-text translation for gaming chat networks.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.XboxSpeechToTextOverlay"
|
||||
},
|
||||
"WPFAppxMicrosoft_Xbox_TCUI": {
|
||||
"Category": "Xbox & Gaming",
|
||||
"Content": "Xbox TCUI",
|
||||
"Description": "Provides core account connection UI modules for single sign-on flows within game titles. Warning: removing this may break Microsoft account authentication in games and apps that do not otherwise require the Xbox app.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.Xbox.TCUI"
|
||||
},
|
||||
"WPFAppxMicrosoft_StartExperiencesApp": {
|
||||
"Category": "Bing & Web Services",
|
||||
"Content": "Start Experiences App",
|
||||
"Description": "Powers the Windows Widgets board, delivering a personalized feed of news, weather, sports, and finance content.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.StartExperiencesApp",
|
||||
"StoreId": "9PC1H9VN18CM"
|
||||
},
|
||||
"WPFAppxMicrosoft_MicrosoftSolitaireCollection": {
|
||||
"Category": "Xbox & Gaming",
|
||||
"Content": "Solitaire Collection",
|
||||
"Description": "Bundles built-in card game modes including Klondike, Spider, FreeCell, Pyramid, and TriPeaks alongside daily challenges.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.MicrosoftSolitaireCollection"
|
||||
}
|
||||
}
|
||||
@@ -3,110 +3,48 @@
|
||||
"Primary": "8.8.8.8",
|
||||
"Secondary": "8.8.4.4",
|
||||
"Primary6": "2001:4860:4860::8888",
|
||||
"Secondary6": "2001:4860:4860::8844",
|
||||
"DohTemplate": "https://dns.google/dns-query"
|
||||
"Secondary6": "2001:4860:4860::8844"
|
||||
},
|
||||
"Cloudflare":{
|
||||
"Primary": "1.1.1.1",
|
||||
"Secondary": "1.0.0.1",
|
||||
"Primary6": "2606:4700:4700::1111",
|
||||
"Secondary6": "2606:4700:4700::1001",
|
||||
"DohTemplate": "https://cloudflare-dns.com/dns-query"
|
||||
"Secondary6": "2606:4700:4700::1001"
|
||||
},
|
||||
"Cloudflare_Malware":{
|
||||
"Primary": "1.1.1.2",
|
||||
"Secondary": "1.0.0.2",
|
||||
"Primary6": "2606:4700:4700::1112",
|
||||
"Secondary6": "2606:4700:4700::1002",
|
||||
"DohTemplate": "https://security.cloudflare-dns.com/dns-query"
|
||||
"Secondary6": "2606:4700:4700::1002"
|
||||
},
|
||||
"Cloudflare_Malware_Adult":{
|
||||
"Primary": "1.1.1.3",
|
||||
"Secondary": "1.0.0.3",
|
||||
"Primary6": "2606:4700:4700::1113",
|
||||
"Secondary6": "2606:4700:4700::1003",
|
||||
"DohTemplate": "https://family.cloudflare-dns.com/dns-query"
|
||||
"Secondary6": "2606:4700:4700::1003"
|
||||
},
|
||||
"Open_DNS":{
|
||||
"Primary": "208.67.222.222",
|
||||
"Secondary": "208.67.220.220",
|
||||
"Primary6": "2620:119:35::35",
|
||||
"Secondary6": "2620:119:53::53",
|
||||
"DohTemplate": "https://doh.opendns.com/dns-query"
|
||||
"Secondary6": "2620:119:53::53"
|
||||
},
|
||||
"Quad9":{
|
||||
"Primary": "9.9.9.9",
|
||||
"Secondary": "149.112.112.112",
|
||||
"Primary6": "2620:fe::fe",
|
||||
"Secondary6": "2620:fe::9",
|
||||
"DohTemplate": "https://dns.quad9.net/dns-query"
|
||||
"Secondary6": "2620:fe::9"
|
||||
},
|
||||
"AdGuard_Ads_Trackers":{
|
||||
"Primary": "94.140.14.14",
|
||||
"Secondary": "94.140.15.15",
|
||||
"Primary6": "2a10:50c0::ad1:ff",
|
||||
"Secondary6": "2a10:50c0::ad2:ff",
|
||||
"DohTemplate": "https://dns.adguard-dns.com/dns-query"
|
||||
"Secondary6": "2a10:50c0::ad2:ff"
|
||||
},
|
||||
"AdGuard_Ads_Trackers_Malware_Adult":{
|
||||
"Primary": "94.140.14.15",
|
||||
"Secondary": "94.140.15.16",
|
||||
"Primary6": "2a10:50c0::bad1:ff",
|
||||
"Secondary6": "2a10:50c0::bad2:ff",
|
||||
"DohTemplate": "https://family.adguard-dns.com/dns-query"
|
||||
},
|
||||
"Mullvad":{
|
||||
"Primary": "194.242.2.2",
|
||||
"Secondary": "194.242.2.3",
|
||||
"Primary6": "2a07:e340::2",
|
||||
"Secondary6": "2a07:e340::3",
|
||||
"DohOnly": true,
|
||||
"DohTemplate": "https://dns.mullvad.net/dns-query",
|
||||
"SecondaryDohTemplate": "https://adblock.dns.mullvad.net/dns-query"
|
||||
},
|
||||
"Mullvad_Ads_Trackers":{
|
||||
"Primary": "194.242.2.3",
|
||||
"Secondary": "194.242.2.2",
|
||||
"Primary6": "2a07:e340::3",
|
||||
"Secondary6": "2a07:e340::2",
|
||||
"DohOnly": true,
|
||||
"DohTemplate": "https://adblock.dns.mullvad.net/dns-query",
|
||||
"SecondaryDohTemplate": "https://dns.mullvad.net/dns-query"
|
||||
},
|
||||
"Mullvad_Ads_Trackers_Malware":{
|
||||
"Primary": "194.242.2.4",
|
||||
"Secondary": "194.242.2.3",
|
||||
"Primary6": "2a07:e340::4",
|
||||
"Secondary6": "2a07:e340::3",
|
||||
"DohOnly": true,
|
||||
"DohTemplate": "https://base.dns.mullvad.net/dns-query",
|
||||
"SecondaryDohTemplate": "https://adblock.dns.mullvad.net/dns-query"
|
||||
},
|
||||
"Mullvad_Ads_Trackers_Malware_Social":{
|
||||
"Primary": "194.242.2.5",
|
||||
"Secondary": "194.242.2.4",
|
||||
"Primary6": "2a07:e340::5",
|
||||
"Secondary6": "2a07:e340::4",
|
||||
"DohOnly": true,
|
||||
"DohTemplate": "https://extended.dns.mullvad.net/dns-query",
|
||||
"SecondaryDohTemplate": "https://base.dns.mullvad.net/dns-query"
|
||||
},
|
||||
"Mullvad_Ads_Trackers_Malware_Adult_Gambling":{
|
||||
"Primary": "194.242.2.6",
|
||||
"Secondary": "194.242.2.5",
|
||||
"Primary6": "2a07:e340::6",
|
||||
"Secondary6": "2a07:e340::5",
|
||||
"DohOnly": true,
|
||||
"DohTemplate": "https://family.dns.mullvad.net/dns-query",
|
||||
"SecondaryDohTemplate": "https://extended.dns.mullvad.net/dns-query"
|
||||
},
|
||||
"Mullvad_Ads_Trackers_Malware_Adult_Gambling_Social":{
|
||||
"Primary": "194.242.2.9",
|
||||
"Secondary": "194.242.2.6",
|
||||
"Primary6": "2a07:e340::9",
|
||||
"Secondary6": "2a07:e340::6",
|
||||
"DohOnly": true,
|
||||
"DohTemplate": "https://all.dns.mullvad.net/dns-query",
|
||||
"SecondaryDohTemplate": "https://family.dns.mullvad.net/dns-query"
|
||||
"Secondary6": "2a10:50c0::bad2:ff"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"NetFx3"
|
||||
],
|
||||
"InvokeScript": [],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/dotnet"
|
||||
"link": "https://winutil.christitus.com/dev/features/features/dotnet"
|
||||
},
|
||||
"WPFFixesNTPPool": {
|
||||
"Content": "NTP Server - Enable",
|
||||
@@ -19,7 +19,7 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WPFFixesNTPPool",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/fixes/ntppool"
|
||||
"link": "https://winutil.christitus.com/dev/features/fixes/ntppool"
|
||||
},
|
||||
"WPFFeatureshyperv": {
|
||||
"Content": "Hyper-V - Enable",
|
||||
@@ -29,7 +29,10 @@
|
||||
"feature": [
|
||||
"Microsoft-Hyper-V-All"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/hyperv"
|
||||
"InvokeScript": [
|
||||
"bcdedit /set hypervisorschedulertype classic"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/dev/features/features/hyperv"
|
||||
},
|
||||
"WPFFeatureslegacymedia": {
|
||||
"Content": "Legacy Media Components (WMP, DirectPlay) - Enable",
|
||||
@@ -43,7 +46,7 @@
|
||||
"LegacyComponents"
|
||||
],
|
||||
"InvokeScript": [],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/legacymedia"
|
||||
"link": "https://winutil.christitus.com/dev/features/features/legacymedia"
|
||||
},
|
||||
"WPFFeaturewsl": {
|
||||
"Content": "Windows Subsystem for Linux (WSL) - Enable",
|
||||
@@ -55,7 +58,7 @@
|
||||
"Microsoft-Windows-Subsystem-Linux"
|
||||
],
|
||||
"InvokeScript": [],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/wsl"
|
||||
"link": "https://winutil.christitus.com/dev/features/features/wsl"
|
||||
},
|
||||
"WPFFeaturenfs": {
|
||||
"Content": "Network File System (NFS) - Enable",
|
||||
@@ -74,7 +77,7 @@
|
||||
"nfsadmin client start",
|
||||
"nfsadmin client localhost config fileaccess=755 SecFlavors=+sys -krb5 -krb5i"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/nfs"
|
||||
"link": "https://winutil.christitus.com/dev/features/features/nfs"
|
||||
},
|
||||
"WPFFeatureRegBackup": {
|
||||
"Content": "Registry Backup (Daily Task 12:30am) - Enable",
|
||||
@@ -91,7 +94,7 @@
|
||||
Register-ScheduledTask -Action $action -Trigger $trigger -TaskName 'AutoRegBackup' -Description 'Create System Registry Backups' -User 'System'
|
||||
"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/regbackup"
|
||||
"link": "https://winutil.christitus.com/dev/features/features/regbackup"
|
||||
},
|
||||
"WPFFeatureEnableLegacyRecovery": {
|
||||
"Content": "Legacy F8 Boot Recovery - Enable",
|
||||
@@ -102,7 +105,7 @@
|
||||
"InvokeScript": [
|
||||
"bcdedit /set bootmenupolicy legacy"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/enablelegacyrecovery"
|
||||
"link": "https://winutil.christitus.com/dev/features/features/enablelegacyrecovery"
|
||||
},
|
||||
"WPFFeatureDisableLegacyRecovery": {
|
||||
"Content": "Legacy F8 Boot Recovery - Disable",
|
||||
@@ -113,7 +116,7 @@
|
||||
"InvokeScript": [
|
||||
"bcdedit /set bootmenupolicy standard"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/disablelegacyrecovery"
|
||||
"link": "https://winutil.christitus.com/dev/features/features/disablelegacyrecovery"
|
||||
},
|
||||
"WPFFeaturesSandbox": {
|
||||
"Content": "Windows Sandbox - Enable",
|
||||
@@ -123,7 +126,7 @@
|
||||
"feature": [
|
||||
"Containers-DisposableClientVM"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/sandbox"
|
||||
"link": "https://winutil.christitus.com/dev/features/features/sandbox"
|
||||
},
|
||||
"WPFFeatureInstall": {
|
||||
"Content": "Install Features",
|
||||
@@ -132,7 +135,7 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WPFFeatureInstall",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/features/install"
|
||||
"link": "https://winutil.christitus.com/dev/features/features/install"
|
||||
},
|
||||
"WPFPanelAutologin": {
|
||||
"Content": "AutoLogon - Run",
|
||||
@@ -141,7 +144,7 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WPFPanelAutologin",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/fixes/autologin"
|
||||
"link": "https://winutil.christitus.com/dev/features/fixes/autologin"
|
||||
},
|
||||
"WPFFixesUpdate": {
|
||||
"Content": "Windows Update - Reset",
|
||||
@@ -150,7 +153,7 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WPFFixesUpdate",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/fixes/update"
|
||||
"link": "https://winutil.christitus.com/dev/features/fixes/update"
|
||||
},
|
||||
"WPFFixesNetwork": {
|
||||
"Content": "Network - Reset",
|
||||
@@ -159,7 +162,7 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WPFFixesNetwork",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/fixes/network"
|
||||
"link": "https://winutil.christitus.com/dev/features/fixes/network"
|
||||
},
|
||||
"WPFPanelDISM": {
|
||||
"Content": "System Corruption Scan - Run",
|
||||
@@ -168,7 +171,7 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WPFSystemRepair",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/fixes/dism"
|
||||
"link": "https://winutil.christitus.com/dev/features/fixes/dism"
|
||||
},
|
||||
"WPFFixesWinget": {
|
||||
"Content": "WinGet - Reinstall",
|
||||
@@ -177,18 +180,7 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WPFFixesWinget",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/fixes/winget"
|
||||
},
|
||||
"WPFPanelComputer": {
|
||||
"Content": "Computer Management",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"compmgmt.msc"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/computer"
|
||||
"link": "https://winutil.christitus.com/dev/features/fixes/winget"
|
||||
},
|
||||
"WPFPanelControl": {
|
||||
"Content": "Control Panel",
|
||||
@@ -199,18 +191,18 @@
|
||||
"InvokeScript": [
|
||||
"control"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/control"
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/control"
|
||||
},
|
||||
"WPFPanelMouse": {
|
||||
"Content": "Mouse Properties",
|
||||
"WPFPanelComputer": {
|
||||
"Content": "Computer Management",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"main.cpl"
|
||||
"compmgmt.msc"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/mouse"
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/computer"
|
||||
},
|
||||
"WPFPanelNetwork": {
|
||||
"Content": "Network Connections",
|
||||
@@ -221,7 +213,7 @@
|
||||
"InvokeScript": [
|
||||
"ncpa.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/network"
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/network"
|
||||
},
|
||||
"WPFPanelPower": {
|
||||
"Content": "Power Panel",
|
||||
@@ -232,7 +224,7 @@
|
||||
"InvokeScript": [
|
||||
"powercfg.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/power"
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/power"
|
||||
},
|
||||
"WPFPanelPrinter": {
|
||||
"Content": "Printer Panel",
|
||||
@@ -243,18 +235,7 @@
|
||||
"InvokeScript": [
|
||||
"Start-Process 'shell:::{A8A91A66-3A7D-4424-8D24-04E180695C7A}'"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/printer"
|
||||
},
|
||||
"WPFPanelPrograms": {
|
||||
"Content": "Programs and Features",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"appwiz.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/programs"
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/printer"
|
||||
},
|
||||
"WPFPanelRegion": {
|
||||
"Content": "Region",
|
||||
@@ -265,62 +246,7 @@
|
||||
"InvokeScript": [
|
||||
"intl.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/region"
|
||||
},
|
||||
"WPFPanelSecurity": {
|
||||
"Content": "Security and Maintenance",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"wscui.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/security"
|
||||
},
|
||||
"WPFPanelSound": {
|
||||
"Content": "Sound Settings",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"mmsys.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/sound"
|
||||
},
|
||||
"WPFPanelSystem": {
|
||||
"Content": "System Properties",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"sysdm.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/system"
|
||||
},
|
||||
"WPFPanelTimedate": {
|
||||
"Content": "Time and Date",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"timedate.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/timedate"
|
||||
},
|
||||
"WPFPanelFirewall": {
|
||||
"Content": "Windows Defender Firewall",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"firewall.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/firewall"
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/region"
|
||||
},
|
||||
"WPFPanelRestore": {
|
||||
"Content": "Windows Restore",
|
||||
@@ -331,7 +257,40 @@
|
||||
"InvokeScript": [
|
||||
"rstrui.exe"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/features/legacy-windows-panels/restore"
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/restore"
|
||||
},
|
||||
"WPFPanelSound": {
|
||||
"Content": "Sound Settings",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"mmsys.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/sound"
|
||||
},
|
||||
"WPFPanelSystem": {
|
||||
"Content": "System Properties",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"sysdm.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/system"
|
||||
},
|
||||
"WPFPanelTimedate": {
|
||||
"Content": "Time and Date",
|
||||
"category": "Legacy Windows Panels",
|
||||
"panel": "2",
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"InvokeScript": [
|
||||
"timedate.cpl"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/dev/features/legacy-windows-panels/timedate"
|
||||
},
|
||||
"WPFWinUtilInstallPSProfile": {
|
||||
"Content": "CTT PowerShell Profile - Install",
|
||||
@@ -340,7 +299,7 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WinUtilInstallPSProfile",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/powershell-profile-powershell-7--only/installpsprofile"
|
||||
"link": "https://winutil.christitus.com/dev/features/powershell-profile-powershell-7--only/installpsprofile"
|
||||
},
|
||||
"WPFWinUtilUninstallPSProfile": {
|
||||
"Content": "CTT PowerShell Profile - Remove",
|
||||
@@ -349,7 +308,7 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WinUtilUninstallPSProfile",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/powershell-profile-powershell-7--only/uninstallpsprofile"
|
||||
"link": "https://winutil.christitus.com/dev/features/powershell-profile-powershell-7--only/uninstallpsprofile"
|
||||
},
|
||||
"WPFWinUtilSSHServer": {
|
||||
"Content": "OpenSSH Server - Enable",
|
||||
@@ -358,6 +317,6 @@
|
||||
"Type": "Button",
|
||||
"ButtonWidth": "300",
|
||||
"function": "Invoke-WPFSSHServer",
|
||||
"link": "https://winutil.christitus.com/code-reference/features/remote-access/sshserver"
|
||||
"link": "https://winutil.christitus.com/dev/features/remote-access/sshserver"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,31 +4,34 @@
|
||||
"WPFTweaksConsumerFeatures",
|
||||
"WPFTweaksDisableExplorerAutoDiscovery",
|
||||
"WPFTweaksWPBT",
|
||||
"WPFTweaksDVR",
|
||||
"WPFTweaksDeBloat",
|
||||
"WPFTweaksLocation",
|
||||
"WPFTweaksServices",
|
||||
"WPFTweaksTelemetry",
|
||||
"WPFTweaksDeliveryOptimization",
|
||||
"WPFTweaksDiskCleanup",
|
||||
"WPFTweaksDeleteTempFiles",
|
||||
"WPFTweaksEndTaskOnTaskbar",
|
||||
"WPFTweaksRestorePoint"
|
||||
"WPFTweaksRestorePoint",
|
||||
"WPFTweaksPowershell7Tele"
|
||||
],
|
||||
"Minimal": [
|
||||
"WPFTweaksConsumerFeatures",
|
||||
"WPFTweaksDeBloat",
|
||||
"WPFTweaksWPBT",
|
||||
"WPFTweaksServices",
|
||||
"WPFTweaksTelemetry"
|
||||
],
|
||||
"Advanced": [
|
||||
"WPFTweaksRestorePoint",
|
||||
"WPFTweaksActivity",
|
||||
"WPFTweaksConsumerFeatures",
|
||||
"WPFTweaksDisableExplorerAutoDiscovery",
|
||||
"WPFTweaksWPBT",
|
||||
"WPFTweaksDVR",
|
||||
"WPFTweaksDeBloat",
|
||||
"WPFTweaksLocation",
|
||||
"WPFTweaksServices",
|
||||
"WPFTweaksTelemetry",
|
||||
"WPFTweaksDeliveryOptimization",
|
||||
"WPFTweaksDeleteTempFiles",
|
||||
"WPFTweaksEndTaskOnTaskbar",
|
||||
"WPFTweaksDisableStoreSearch",
|
||||
@@ -36,26 +39,7 @@
|
||||
"WPFTweaksWidget",
|
||||
"WPFTweaksRemoveOneDrive",
|
||||
"WPFTweaksWindowsAI",
|
||||
"WPFTweaksRightClickMenu"
|
||||
],
|
||||
"AppxDefault": [
|
||||
"WPFAppxMicrosoft_WindowsFeedbackHub",
|
||||
"WPFAppxMicrosoft_GetHelp",
|
||||
"WPFAppxMicrosoft_MicrosoftOfficeHub",
|
||||
"WPFAppxMicrosoft_WindowsCalculator",
|
||||
"WPFAppxClipchamp_Clipchamp",
|
||||
"WPFAppxMicrosoft_WindowsAlarms",
|
||||
"WPFAppxMicrosoftCorporationII_QuickAssist",
|
||||
"WPFAppxMicrosoft_WindowsSoundRecorder",
|
||||
"WPFAppxMicrosoft_MicrosoftStickyNotes",
|
||||
"WPFAppxMicrosoft_Todos",
|
||||
"WPFAppxMicrosoft_MicrosoftSolitaireCollection",
|
||||
"WPFAppxMicrosoft_PowerAutomateDesktop",
|
||||
"WPFAppxMicrosoft_WindowsDevHome",
|
||||
"WPFAppxMicrosoft_BingWeather",
|
||||
"WPFAppxMicrosoft_StartExperiencesApp",
|
||||
"WPFAppxMicrosoft_BingNews",
|
||||
"WPFAppxMicrosoft_Copilot",
|
||||
"WPFAppxMicrosoft_BingSearch"
|
||||
"WPFTweaksRightClickMenu",
|
||||
"WPFTweaksPowershell7Tele"
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
{
|
||||
"shared": {
|
||||
"AppEntryWidth": "220",
|
||||
"AppEntryFontSize": "13.2",
|
||||
"AppEntryIconSize": "28",
|
||||
"AppEntryMargin": "3",
|
||||
"AppEntryBorderThickness": "1",
|
||||
"AppEntryWidth": "200",
|
||||
"AppEntryFontSize": "11",
|
||||
"AppEntryMargin": "1,0,1,0",
|
||||
"AppEntryBorderThickness": "0",
|
||||
"CustomDialogFontSize": "12",
|
||||
"CustomDialogFontSizeHeader": "14",
|
||||
"CustomDialogLogoSize": "25",
|
||||
@@ -25,7 +24,7 @@
|
||||
"IconFontSize": "14",
|
||||
"IconButtonSize": "35",
|
||||
"SettingsIconFontSize": "18",
|
||||
"CloseIconFontSize": "12",
|
||||
"CloseIconFontSize": "18",
|
||||
"GroupBorderBackgroundColor": "#232629",
|
||||
"ButtonFontSize": "12",
|
||||
"ButtonFontFamily": "Arial",
|
||||
@@ -46,6 +45,7 @@
|
||||
"AppInstallUnselectedColor": "#F7F7F7",
|
||||
"AppInstallHighlightedColor": "#CFCFCF",
|
||||
"AppInstallSelectedColor": "#C2C2C2",
|
||||
"AppInstallOverlayBackgroundColor": "#6A6D72",
|
||||
"ComboBoxForegroundColor": "#232629",
|
||||
"ComboBoxBackgroundColor": "#F7F7F7",
|
||||
"LabelboxForegroundColor": "#232629",
|
||||
@@ -59,18 +59,17 @@
|
||||
"ScrollBarDraggingColor": "#6A6D72",
|
||||
"ProgressBarForegroundColor": "#2E77FF",
|
||||
"ProgressBarBackgroundColor": "Transparent",
|
||||
"ProgressBarTextColor": "#232629",
|
||||
"ButtonInstallBackgroundColor": "#F7F7F7",
|
||||
"ButtonTweaksBackgroundColor": "#F7F7F7",
|
||||
"ButtonConfigBackgroundColor": "#F7F7F7",
|
||||
"ButtonUpdatesBackgroundColor": "#F7F7F7",
|
||||
"ButtonWin11ISOBackgroundColor": "#F7F7F7",
|
||||
"ButtonAppxBackgroundColor": "#F7F7F7",
|
||||
"ButtonInstallForegroundColor": "#232629",
|
||||
"ButtonTweaksForegroundColor": "#232629",
|
||||
"ButtonConfigForegroundColor": "#232629",
|
||||
"ButtonUpdatesForegroundColor": "#232629",
|
||||
"ButtonWin11ISOForegroundColor": "#232629",
|
||||
"ButtonAppxForegroundColor": "#232629",
|
||||
"ButtonBackgroundColor": "#F5F5F5",
|
||||
"ButtonBackgroundPressedColor": "#1A1A1A",
|
||||
"ButtonBackgroundMouseoverColor": "#C2C2C2",
|
||||
@@ -86,6 +85,7 @@
|
||||
"AppInstallUnselectedColor": "#232629",
|
||||
"AppInstallHighlightedColor": "#3C3C3C",
|
||||
"AppInstallSelectedColor": "#4C4C4C",
|
||||
"AppInstallOverlayBackgroundColor": "#2E3135",
|
||||
"ComboBoxForegroundColor": "#F7F7F7",
|
||||
"ComboBoxBackgroundColor": "#1E3747",
|
||||
"LabelboxForegroundColor": "#5BDCFF",
|
||||
@@ -97,20 +97,19 @@
|
||||
"ScrollBarBackgroundColor": "#2E3135",
|
||||
"ScrollBarHoverColor": "#3B4252",
|
||||
"ScrollBarDraggingColor": "#5E81AC",
|
||||
"ProgressBarForegroundColor": "#6EFF72",
|
||||
"ProgressBarForegroundColor": "#222222",
|
||||
"ProgressBarBackgroundColor": "Transparent",
|
||||
"ProgressBarTextColor": "#232629",
|
||||
"ButtonInstallBackgroundColor": "#222222",
|
||||
"ButtonTweaksBackgroundColor": "#333333",
|
||||
"ButtonConfigBackgroundColor": "#444444",
|
||||
"ButtonUpdatesBackgroundColor": "#555555",
|
||||
"ButtonWin11ISOBackgroundColor": "#666666",
|
||||
"ButtonAppxBackgroundColor": "#777777",
|
||||
"ButtonInstallForegroundColor": "#F7F7F7",
|
||||
"ButtonTweaksForegroundColor": "#F7F7F7",
|
||||
"ButtonConfigForegroundColor": "#F7F7F7",
|
||||
"ButtonUpdatesForegroundColor": "#F7F7F7",
|
||||
"ButtonWin11ISOForegroundColor": "#F7F7F7",
|
||||
"ButtonAppxForegroundColor": "#F7F7F7",
|
||||
"ButtonBackgroundColor": "#1E3747",
|
||||
"ButtonBackgroundPressedColor": "#F7F7F7",
|
||||
"ButtonBackgroundMouseoverColor": "#3B4252",
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
node_modules
|
||||
.astro
|
||||
dist
|
||||
.git
|
||||
.env
|
||||
.env.*
|
||||
*.log
|
||||
@@ -1,23 +0,0 @@
|
||||
# build output
|
||||
dist/
|
||||
# generated types
|
||||
.astro/
|
||||
|
||||
# dependencies
|
||||
node_modules/
|
||||
|
||||
# logs
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
pnpm-debug.log*
|
||||
|
||||
|
||||
# environment variables
|
||||
.env
|
||||
.env.production
|
||||
.env.local
|
||||
.env.*.local
|
||||
|
||||
# macOS-specific files
|
||||
.DS_Store
|
||||
@@ -1,16 +0,0 @@
|
||||
FROM node:22-bookworm-slim
|
||||
|
||||
RUN corepack enable
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY package*.json ./
|
||||
RUN npm install
|
||||
|
||||
COPY . .
|
||||
|
||||
RUN chown -R node:node /app
|
||||
USER node
|
||||
|
||||
EXPOSE 4321
|
||||
CMD ["npm", "run", "dev", "--", "--host", "0.0.0.0"]
|
||||
@@ -1,61 +0,0 @@
|
||||
# WinUtil Docs
|
||||
|
||||
[](https://starlight.astro.build)
|
||||
|
||||
Documentation site for [WinUtil](https://github.com/ChrisTitusTech/winutil), built with [Astro](https://astro.build) and [Starlight](https://starlight.astro.build). Served at [winutil.christitus.com](https://winutil.christitus.com/).
|
||||
|
||||
## 🚀 Project Structure
|
||||
|
||||
```
|
||||
.
|
||||
├── public/
|
||||
├── src/
|
||||
│ ├── assets/
|
||||
│ ├── components/
|
||||
│ ├── content/
|
||||
│ │ └── docs/
|
||||
│ ├── styles/
|
||||
│ └── content.config.ts
|
||||
├── astro.config.mjs
|
||||
├── docker-compose.yml
|
||||
├── Dockerfile
|
||||
├── package.json
|
||||
└── tsconfig.json
|
||||
```
|
||||
|
||||
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
|
||||
|
||||
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
|
||||
|
||||
Static assets, like favicons, can be placed in the `public/` directory.
|
||||
|
||||
## 🧞 Commands
|
||||
|
||||
All commands run in a Docker container — there's no need to install Node or npm dependencies on your host. This is deliberate, not just convenience: npm/pnpm/yarn have seen a steady stream of supply-chain attacks (malicious `postinstall`/`preinstall` scripts, credential-stealing packages), so `npm install` and friends never run directly on a contributor's machine here. Note the container still has read-write access to this `docs/` directory (it's bind-mounted for live reload), so this only contains a compromised package to the project folder plus the container itself — it doesn't reach the rest of your host (SSH keys, other repos, cloud credentials elsewhere on disk). Don't keep real secrets in `docs/` as a result.
|
||||
|
||||
[Docker](https://www.docker.com/) (with Compose) is required — install Docker Desktop (or Docker Engine + the `docker compose` plugin on Linux) and make sure the daemon is running before using any of the commands below.
|
||||
|
||||
All commands are run from the `docs/` directory, from a terminal:
|
||||
|
||||
| Command | Action |
|
||||
| :------------------------------------------------ | :----------------------------------------------- |
|
||||
| `docker compose build` | Builds the dev image (needed after Dockerfile or dependency changes) |
|
||||
| `docker compose up winutil-astro` | Starts local dev server at `localhost:4321` |
|
||||
| `docker compose run --rm winutil-astro npm run build` | Build the production site to `./dist/` |
|
||||
| `docker compose run --rm --service-ports winutil-astro npm run preview -- --host 0.0.0.0` | Preview the build locally, before deploying |
|
||||
| `docker compose run --rm winutil-astro npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||
| `docker compose down` | Stop and remove the dev container |
|
||||
|
||||
Source files are bind-mounted into the container, so edits on the host are picked up immediately by the dev server — no rebuild needed for normal content or code changes. After changing `package.json`, `package-lock.json`, or the `Dockerfile`, rebuild the image *and* drop the `node_modules` volume, since Docker only seeds a named volume from the image the first time it's created — a plain rebuild leaves the old `node_modules` in place:
|
||||
|
||||
```sh
|
||||
docker compose build
|
||||
docker compose down -v
|
||||
docker compose up winutil-astro
|
||||
```
|
||||
|
||||
The first `docker compose up` (or any command before an image exists) builds the image and runs `npm install` from scratch, which can take a few minutes. Subsequent runs reuse the cached image and start almost immediately.
|
||||
|
||||
## 👀 Want to learn more?
|
||||
|
||||
Check out [Starlight's docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: '{{ replace .File.ContentBaseName "-" " " | title }}'
|
||||
description: ""
|
||||
date: '{{ .Date }}'
|
||||
draft: true
|
||||
---
|
||||
|
After Width: | Height: | Size: 139 KiB |
|
After Width: | Height: | Size: 139 KiB |
|
After Width: | Height: | Size: 139 KiB |
|
After Width: | Height: | Size: 139 KiB |
|
After Width: | Height: | Size: 139 KiB |
|
Before Width: | Height: | Size: 173 KiB After Width: | Height: | Size: 173 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 149 KiB After Width: | Height: | Size: 149 KiB |
|
After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
@@ -1,76 +0,0 @@
|
||||
// @ts-check
|
||||
import { defineConfig } from 'astro/config';
|
||||
import starlight from '@astrojs/starlight';
|
||||
import { siteLinks } from './src/site-links.ts';
|
||||
|
||||
// https://astro.build/config
|
||||
export default defineConfig({
|
||||
site: 'https://winutil.christitus.com/',
|
||||
integrations: [
|
||||
starlight({
|
||||
title: 'WinUtil',
|
||||
description: "Chris Titus Tech's Windows Utility — install apps, apply tweaks, run fixes, and manage Windows from one place.",
|
||||
logo: {
|
||||
src: './src/assets/branding/navlogo.png',
|
||||
replacesTitle: true,
|
||||
},
|
||||
favicon: '/favicon.svg',
|
||||
head: [
|
||||
{ tag: 'meta', attrs: { property: 'og:image', content: 'https://winutil.christitus.com/social-preview.png' } },
|
||||
{ tag: 'meta', attrs: { property: 'og:image:width', content: '1200' } },
|
||||
{ tag: 'meta', attrs: { property: 'og:image:height', content: '630' } },
|
||||
{ tag: 'meta', attrs: { name: 'twitter:image', content: 'https://winutil.christitus.com/social-preview.png' } },
|
||||
],
|
||||
social: [
|
||||
{ icon: 'github', label: 'GitHub', href: 'https://github.com/ChrisTitusTech/winutil' },
|
||||
{ icon: 'discord', label: 'Discord', href: 'https://discord.gg/RUbZUZyByQ' },
|
||||
],
|
||||
// Global theme overrides (colors, fonts, landing-page section styles).
|
||||
customCss: ['./src/styles/theme.css'],
|
||||
// Custom component overrides, all under src/components/.
|
||||
components: {
|
||||
ThemeProvider: './src/components/ThemeProvider.astro',
|
||||
Header: './src/components/Header.astro',
|
||||
Hero: './src/components/Hero.astro',
|
||||
Footer: './src/components/Footer.astro',
|
||||
},
|
||||
editLink: {
|
||||
baseUrl: 'https://github.com/ChrisTitusTech/winutil/edit/main/docs/',
|
||||
},
|
||||
// Sidebar groups, top to bottom: User Guide, Code Reference, Help.
|
||||
sidebar: [
|
||||
{
|
||||
label: 'User Guide',
|
||||
items: [
|
||||
{ label: 'Overview', slug: 'guides' },
|
||||
{ label: 'Getting Started', slug: 'guides/getting-started' },
|
||||
{ label: 'Applications', slug: 'guides/application' },
|
||||
{ label: 'Tweaks', slug: 'guides/tweaks' },
|
||||
{ label: 'Features', slug: 'guides/features' },
|
||||
{ label: 'Updates', slug: 'guides/updates' },
|
||||
{ label: 'Automation', slug: 'guides/automation' },
|
||||
{ label: 'Win11 Creator', slug: 'guides/win11creator' },
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Code Reference',
|
||||
items: [
|
||||
{ label: 'Architecture & Design', slug: 'code-reference/architecture' },
|
||||
{ label: 'Tweaks Reference', items: [{ autogenerate: { directory: 'code-reference/tweaks' } }] },
|
||||
{ label: 'Features Reference', items: [{ autogenerate: { directory: 'code-reference/features' } }] },
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Help',
|
||||
items: [
|
||||
{ label: 'FAQ', slug: 'faq' },
|
||||
{ label: 'Known Issues', slug: 'knownissues' },
|
||||
{ label: 'Contributing', slug: 'contributing' },
|
||||
{ label: siteLinks.forums.label, link: siteLinks.forums.href, attrs: { target: '_blank', rel: 'noreferrer' } },
|
||||
],
|
||||
},
|
||||
{ label: siteLinks.store.label, link: siteLinks.store.href, attrs: { target: '_blank', rel: 'noreferrer' } },
|
||||
],
|
||||
}),
|
||||
],
|
||||
});
|
||||
@@ -0,0 +1,153 @@
|
||||
---
|
||||
toc: true
|
||||
---
|
||||
|
||||
## Contributing Code
|
||||
|
||||
### Before You Start
|
||||
|
||||
- Keep each pull request focused on a single feature or fix.
|
||||
- Avoid unnecessary formatting changes or large unrelated edits.
|
||||
- Document what changed and why in your PR description.
|
||||
|
||||
---
|
||||
|
||||
## Basic Git Workflow
|
||||
|
||||
### 1. Fork the Repository
|
||||
|
||||
Go to the ChrisTitusTech/winutil repository on GitHub and click the Fork button in the top right corner.
|
||||
|
||||
<img width="171" height="50" alt="{650A4723-F38A-44A4-9820-D232BC87C8A0}" src="https://github.com/user-attachments/assets/a214f27c-2fee-444a-920f-d87b14f5896f" />
|
||||
|
||||
---
|
||||
|
||||
### 2. Clone Your Fork
|
||||
|
||||
```bash
|
||||
git clone https://github.com/YOUR_USERNAME/winutil.git
|
||||
cd winutil
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 3. Create a Branch
|
||||
|
||||
Never work directly on `main`.
|
||||
|
||||
Create a branch related to your change:
|
||||
|
||||
```bash
|
||||
git checkout -b feature-name
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
git checkout -b add-firefox-tweak
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 4. Edit the Code
|
||||
|
||||
Open the project in your preferred text editor and make your changes.
|
||||
|
||||
Keep changes small and focused.
|
||||
|
||||
---
|
||||
|
||||
### 5. Test Your Changes
|
||||
|
||||
Open PowerShell as Administrator.
|
||||
|
||||
Go to the project folder:
|
||||
|
||||
```powershell
|
||||
cd path\to\winutil
|
||||
```
|
||||
|
||||
Run:
|
||||
|
||||
```powershell
|
||||
.\Compile.ps1 -Run
|
||||
```
|
||||
|
||||
Verify:
|
||||
|
||||
- WinUtil launches correctly
|
||||
- Your feature works
|
||||
- Nothing else breaks
|
||||
|
||||
If something fails, fix it before committing.
|
||||
|
||||
---
|
||||
|
||||
### 6. Review Your Changes
|
||||
|
||||
Check what changed:
|
||||
|
||||
```bash
|
||||
git status
|
||||
```
|
||||
|
||||
Review the diff:
|
||||
|
||||
```bash
|
||||
git diff
|
||||
```
|
||||
|
||||
Make sure you did not accidentally modify unrelated files.
|
||||
|
||||
---
|
||||
|
||||
### 7. Commit Your Changes
|
||||
|
||||
Stage files:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
```
|
||||
|
||||
Commit them:
|
||||
|
||||
```bash
|
||||
git commit -m "Add feature description"
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
git commit -m "Add Firefox package tweak"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 8. Push Your Branch
|
||||
|
||||
```bash
|
||||
git push origin branch-name
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
git push origin add-firefox-tweak
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 9. Open a Pull Request
|
||||
|
||||
Go to your fork on GitHub.
|
||||
|
||||
GitHub will show a button to create a pull request.
|
||||
<img width="1009" height="71" alt="{C8C6A3CC-79D4-44FD-A54C-4C5717F12730}" src="https://github.com/user-attachments/assets/0419d193-d4e7-47c0-87cf-b986742201a0" />
|
||||
|
||||
Before submitting:
|
||||
|
||||
- Explain what changed
|
||||
- Explain why you changed it
|
||||
- Make sure unrelated files are not included
|
||||
|
||||
Once submitted, maintainers will review your PR.
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
title: Known Issues
|
||||
toc: true
|
||||
---
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
If it still isn't working in your region, it may be due to temporary ISP or network filtering of GitHub content domains. This has been reported by some users in India in the past. See: [Times of India](https://timesofindia.indiatimes.com/gadgets-news/github-content-domain-blocked-for-these-indian-users-reports/articleshow/96687992.cms).
|
||||
|
||||
If you are still having issues, try using a **VPN**, or changing your **DNS provider** to one of the following two providers:
|
||||
|
||||
| Provider | Primary DNS | Secondary DNS |
|
||||
| :--------: | :---------: | :-----------: |
|
||||
| Cloudflare | `1.1.1.1` | `1.0.0.1` |
|
||||
| Google | `8.8.8.8` | `8.8.4.4` |
|
||||
|
||||
### Script Won't Run
|
||||
|
||||
If you run WinUtil and get the error:
|
||||
|
||||
`"WinUtil is unable to run on your system, powershell execution is restricted by security policies,"`
|
||||
|
||||
this means that your PowerShell session is in **Constrained Language Mode**, which prevents WinUtil from running.
|
||||
|
||||
### Ultimate Performance Plan Not Working
|
||||
|
||||
The Ultimate Performance power plan may not work on some laptops who do not fully support this power plan.
|
||||
|
||||
In these cases, the power plan may fail to apply, This is expected behavior on unsupported hardware.
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
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://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.
|
||||
|
||||
{{< image src="images/Title-Screen" alt="Winutil title screen" >}}
|
||||
|
||||
## Running the latest release of Winutil
|
||||
|
||||
* You will first need to start a PowerShell terminal **as Admin**.
|
||||
* Now you can run the following command:
|
||||
|
||||
```
|
||||
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.
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Developer Reference
|
||||
weight: 3
|
||||
toc: false
|
||||
---
|
||||
|
||||
> [!NOTE]
|
||||
> This section contains technical documentation for developers. For end-user documentation, see the [User Guide](../userguide/).
|
||||
|
||||
## Architecture
|
||||
|
||||
- [Architecture & Design](architecture/) - Code structure, data flow, and how Winutil works internally
|
||||
|
||||
## Tweaks
|
||||
|
||||
### Essential Tweaks
|
||||
|
||||
{{< autolinks section="dev/tweaks/essential-tweaks" >}}
|
||||
|
||||
### Advanced Tweaks (CAUTION)
|
||||
|
||||
{{< autolinks section="dev/tweaks/z--advanced-tweaks---caution" >}}
|
||||
|
||||
### Customize Preferences
|
||||
|
||||
{{< autolinks section="dev/tweaks/customize-preferences" >}}
|
||||
|
||||
### Performance Plans
|
||||
|
||||
{{< autolinks section="dev/tweaks/performance-plans" >}}
|
||||
|
||||
## Features
|
||||
|
||||
### Fixes
|
||||
|
||||
{{< autolinks section="dev/features/fixes" >}}
|
||||
|
||||
### Legacy Windows Panels
|
||||
|
||||
{{< autolinks section="dev/features/legacy-windows-panels" >}}
|
||||
|
||||
### Features
|
||||
|
||||
{{< autolinks section="dev/features/features" >}}
|
||||
|
||||
### Remote Access
|
||||
|
||||
{{< autolinks section="dev/features/remote-access" >}}
|
||||
|
||||
### Powershell Profile Powershell 7+ Only
|
||||
|
||||
{{< autolinks section="dev/features/powershell-profile-powershell-7--only" >}}
|
||||
@@ -1,11 +1,12 @@
|
||||
---
|
||||
title: Architecture & Design
|
||||
description: How WinUtil's GUI, functions, and JSON configuration files fit together, plus a deep dive into the Win11 Creator subsystem.
|
||||
weight: 1
|
||||
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
|
||||
|
||||
@@ -73,7 +74,7 @@ winutil/
|
||||
1. Reads all function files from `/functions/`
|
||||
2. Includes configuration JSON files
|
||||
3. Embeds XAML GUI definition
|
||||
4. Combines into a single script
|
||||
4. Combines into single script
|
||||
5. Outputs `winutil.ps1`
|
||||
|
||||
**Why**: Makes distribution easier (single file) and improves load time.
|
||||
@@ -149,6 +150,8 @@ The **Win11 Creator** is a specialized subsystem within Winutil that creates cus
|
||||
- Applies offline registry tweaks (hardware bypass, privacy, telemetry, OOBE)
|
||||
- Deletes telemetry scheduled task definitions
|
||||
- Pre-stages setup scripts from autounattend.xml
|
||||
- Removes unused Windows editions
|
||||
- Cleans component store via DISM
|
||||
|
||||
### Win11 Creator Data Flow
|
||||
|
||||
@@ -179,14 +182,16 @@ Invoke-WinUtilISOModify (runs in background runspace)
|
||||
│ ├─ Delete telemetry scheduled task files
|
||||
│ ├─ Pre-stage setup scripts from autounattend.xml to C:\Windows\Setup\Scripts\
|
||||
│ └─ Unload registry hives
|
||||
├─ DISM /Cleanup-Image /StartComponentCleanup /ResetBase (saves 300-800 MB)
|
||||
├─ Dismount and save the modified install.wim (~10+ minutes, slowest step)
|
||||
├─ Export selected edition only (removes all other editions, saves 1-2 GB each)
|
||||
├─ Dismount source ISO
|
||||
└─ Report completion, enable export options
|
||||
↓
|
||||
Invoke-WinUtilISOExport (user chooses output)
|
||||
├─ Option 1: Save as ISO
|
||||
│ ├─ Build bootable ISO via oscdimg.exe (BIOS/UEFI dual-boot)
|
||||
│ └─ Output: Win11_Modified_[date].iso (close to the source ISO size)
|
||||
│ └─ Output: Win11_Modified_[date].iso (2.5-3.5 GB)
|
||||
│
|
||||
└─ Option 2: Write to USB
|
||||
├─ Format USB as GPT
|
||||
@@ -268,7 +273,7 @@ The `Invoke-WinUtilISOScript` function applies **50+ offline registry tweaks**:
|
||||
|
||||
- **Temporary working directory**: ~10-15 GB
|
||||
- **Original ISO**: 4-6 GB
|
||||
- **Modified ISO**: close to the source ISO size
|
||||
- **Modified ISO**: 2.5-3.5 GB
|
||||
- **Total needed**: ~25 GB for safe operation
|
||||
|
||||
## Data Flow
|
||||
@@ -337,7 +342,7 @@ Update UI
|
||||
|
||||
### applications.json Structure
|
||||
|
||||
```json title="config/applications.json"
|
||||
```json {filename="config/applications.json"}
|
||||
{
|
||||
"WPFInstall<AppName>": {
|
||||
"category": "Browsers",
|
||||
@@ -360,7 +365,7 @@ Update UI
|
||||
|
||||
### tweaks.json Structure
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
```json {filename="config/tweaks.json"}
|
||||
{
|
||||
"WPFTweaksTelemetry": {
|
||||
"Content": "Disable Telemetry",
|
||||
@@ -385,8 +390,6 @@ Update UI
|
||||
- `Description`: What it does
|
||||
- `category`: Essential/Advanced/Customize
|
||||
- `registry`: Registry changes to make
|
||||
- `registry[].Values`: Per-state values for a registry-backed combobox
|
||||
- `registry[].DefaultValue`: Effective value when the registry entry is absent
|
||||
- `service`: Services to change
|
||||
- `OriginalValue/State`: For undo functionality
|
||||
|
||||
@@ -501,7 +504,7 @@ $sync.form.Dispatcher.Invoke([action]{
|
||||
### Adding a New Application
|
||||
|
||||
1. Edit `config/applications.json`:
|
||||
```json title="config/applications.json"
|
||||
```json {filename="config/applications.json"}
|
||||
{
|
||||
"WPFInstallNewApp": {
|
||||
"category": "Utilities",
|
||||
@@ -519,7 +522,7 @@ $sync.form.Dispatcher.Invoke([action]{
|
||||
### Adding a New Tweak
|
||||
|
||||
1. Edit `config/tweaks.json`:
|
||||
```json title="config/tweaks.json"
|
||||
```json {filename="config/tweaks.json"}
|
||||
{
|
||||
"WPFTweaksNewTweak": {
|
||||
"Content": "New Tweak",
|
||||
@@ -575,9 +578,7 @@ Tests are in `/pester/`:
|
||||
|
||||
Run tests:
|
||||
```powershell
|
||||
Install-Module -Name Pester -RequiredVersion 5.8.0 -Scope CurrentUser -Force -SkipPublisherCheck
|
||||
Import-Module Pester -RequiredVersion 5.8.0 -Force
|
||||
Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed -CI
|
||||
Invoke-Pester
|
||||
```
|
||||
|
||||
## Build Process
|
||||
@@ -651,10 +652,10 @@ Outputs `winutil.ps1` in the root directory.
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Contributing Guide](/contributing/) - How to contribute code
|
||||
- [User Guide](/guides/) - End-user documentation
|
||||
- [Win11 Creator Guide](/guides/win11creator/) - Building customized Windows 11 ISOs
|
||||
- [FAQ](/faq/) - Common questions
|
||||
- [Contributing Guide](../../contributing/) - How to contribute code
|
||||
- [User Guide](../../userguide/) - End-user documentation
|
||||
- [Win11 Creator Guide](../../userguide/win11creator/) - Building customized Windows 11 ISOs
|
||||
- [FAQ](../../faq/) - Common questions
|
||||
|
||||
## Additional Resources
|
||||
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Legacy F8 Boot Recovery - Disable"
|
||||
description: "Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=110}
|
||||
"WPFFeatureDisableLegacyRecovery": {
|
||||
"Content": "Legacy F8 Boot Recovery - Disable",
|
||||
"Description": "Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"bcdedit /set bootmenupolicy standard"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Legacy F8 Boot Recovery - Enable"
|
||||
description: "Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=99}
|
||||
"WPFFeatureEnableLegacyRecovery": {
|
||||
"Content": "Legacy F8 Boot Recovery - Enable",
|
||||
"Description": "Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"bcdedit /set bootmenupolicy legacy"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Registry Backup (Daily Task 12:30am) - Enable"
|
||||
description: "Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=82}
|
||||
"WPFFeatureRegBackup": {
|
||||
"Content": "Registry Backup (Daily Task 12:30am) - Enable",
|
||||
"Description": "Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803.",
|
||||
@@ -24,5 +19,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
Register-ScheduledTask -Action $action -Trigger $trigger -TaskName 'AutoRegBackup' -Description 'Create System Registry Backups' -User 'System'
|
||||
"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Windows Sandbox - Enable"
|
||||
description: "Windows Sandbox is a lightweight virtual machine that provides a temporary desktop environment to safely run applications and programs in isolation."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=121}
|
||||
"WPFFeaturesSandbox": {
|
||||
"Content": "Windows Sandbox - Enable",
|
||||
"Description": "Windows Sandbox is a lightweight virtual machine that provides a temporary desktop environment to safely run applications and programs in isolation.",
|
||||
@@ -17,5 +12,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"feature": [
|
||||
"Containers-DisposableClientVM"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Features"
|
||||
weight: 1
|
||||
toc: false
|
||||
---
|
||||
|
||||
{{< autolinks section="dev/features/features" >}}
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: ".NET Framework (Versions 2, 3, 4) - Enable"
|
||||
description: ".NET and .NET Framework is a developer platform made up of tools, programming languages, and libraries for building many different types of applications."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=2}
|
||||
"WPFFeaturesdotnet": {
|
||||
"Content": ".NET Framework (Versions 2, 3, 4) - Enable",
|
||||
"Description": ".NET and .NET Framework is a developer platform made up of tools, programming languages, and libraries for building many different types of applications.",
|
||||
@@ -19,5 +14,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"NetFx3"
|
||||
],
|
||||
"InvokeScript": [],
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: "Hyper-V - Enable"
|
||||
description: ""
|
||||
---
|
||||
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=24}
|
||||
"WPFFeatureshyperv": {
|
||||
"Content": "Hyper-V - Enable",
|
||||
"Description": "Hyper-V is a hardware virtualization product developed by Microsoft that allows users to create and manage virtual machines.",
|
||||
"category": "Features",
|
||||
"panel": "1",
|
||||
"feature": [
|
||||
"Microsoft-Hyper-V-All"
|
||||
],
|
||||
"InvokeScript": [
|
||||
"bcdedit /set hypervisorschedulertype classic"
|
||||
],
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Legacy Media Components (WMP, DirectPlay) - Enable"
|
||||
description: "Enables legacy programs from previous versions of Windows."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=37}
|
||||
"WPFFeatureslegacymedia": {
|
||||
"Content": "Legacy Media Components (WMP, DirectPlay) - Enable",
|
||||
"Description": "Enables legacy programs from previous versions of Windows.",
|
||||
@@ -21,5 +16,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"LegacyComponents"
|
||||
],
|
||||
"InvokeScript": [],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Network File System (NFS) - Enable"
|
||||
description: "Network File System (NFS) is a mechanism for storing files on a network."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=63}
|
||||
"WPFFeaturenfs": {
|
||||
"Content": "Network File System (NFS) - Enable",
|
||||
"Description": "Network File System (NFS) is a mechanism for storing files on a network.",
|
||||
@@ -26,5 +21,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"nfsadmin client start",
|
||||
"nfsadmin client localhost config fileaccess=755 SecFlavors=+sys -krb5 -krb5i"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Windows Subsystem for Linux (WSL) - Enable"
|
||||
description: "Windows Subsystem for Linux is an optional feature of Windows that allows Linux programs to run natively on Windows without the need for a separate virtual machine or dual booting."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=51}
|
||||
"WPFFeaturewsl": {
|
||||
"Content": "Windows Subsystem for Linux (WSL) - Enable",
|
||||
"Description": "Windows Subsystem for Linux is an optional feature of Windows that allows Linux programs to run natively on Windows without the need for a separate virtual machine or dual booting.",
|
||||
@@ -19,5 +14,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"Microsoft-Windows-Subsystem-Linux"
|
||||
],
|
||||
"InvokeScript": [],
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: "AutoLogon - Run"
|
||||
description: ""
|
||||
---
|
||||
|
||||
```powershell {filename="functions/public/Invoke-WPFPanelAutologin.ps1",linenos=inline,linenostart=1}
|
||||
function Invoke-WPFPanelAutologin {
|
||||
<#
|
||||
|
||||
.SYNOPSIS
|
||||
Enables autologin using Sysinternals Autologon.exe
|
||||
|
||||
#>
|
||||
|
||||
# Official Microsoft recommendation: https://learn.microsoft.com/en-us/sysinternals/downloads/autologon
|
||||
Invoke-WebRequest -Uri "https://live.sysinternals.com/Autologon.exe" -OutFile "$env:temp\autologin.exe"
|
||||
cmd /c "$env:temp\autologin.exe" /accepteula
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "System Corruption Scan - Run"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/public/Invoke-WPFSystemRepair.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFSystemRepair.ps1). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```powershell title="functions/public/Invoke-WPFSystemRepair.ps1"
|
||||
```powershell {filename="functions/public/Invoke-WPFSystemRepair.ps1",linenos=inline,linenostart=1}
|
||||
function Invoke-WPFSystemRepair {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "NTP Server - Enable"
|
||||
description: "Replaces the default Windows NTP server (time.windows.com) with pool.ntp.org for improved time synchronization accuracy and reliability."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/public/Invoke-WPFFixesNTPPool.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesNTPPool.ps1). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```powershell title="functions/public/Invoke-WPFFixesNTPPool.ps1"
|
||||
```powershell {filename="functions/public/Invoke-WPFFixesNTPPool.ps1",linenos=inline,linenostart=1}
|
||||
function Invoke-WPFFixesNTPPool {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
title: "Network - Reset"
|
||||
description: ""
|
||||
---
|
||||
|
||||
```powershell {filename="functions/public/Invoke-WPFFixesNetwork.ps1",linenos=inline,linenostart=1}
|
||||
function Invoke-WPFFixesNetwork {
|
||||
<#
|
||||
|
||||
.SYNOPSIS
|
||||
Resets various network configurations
|
||||
|
||||
#>
|
||||
|
||||
Write-Host "Resetting Network with netsh"
|
||||
|
||||
Set-WinUtilTaskbaritem -state "Normal" -value 0.01 -overlay "logo"
|
||||
# Reset WinSock catalog to a clean state
|
||||
Start-Process -NoNewWindow -FilePath "netsh" -ArgumentList "winsock", "reset"
|
||||
|
||||
Set-WinUtilTaskbaritem -state "Normal" -value 0.35 -overlay "logo"
|
||||
# Resets WinHTTP proxy setting to DIRECT
|
||||
Start-Process -NoNewWindow -FilePath "netsh" -ArgumentList "winhttp", "reset", "proxy"
|
||||
|
||||
Set-WinUtilTaskbaritem -state "Normal" -value 0.7 -overlay "logo"
|
||||
# Removes all user configured IP settings
|
||||
Start-Process -NoNewWindow -FilePath "netsh" -ArgumentList "int", "ip", "reset"
|
||||
|
||||
Set-WinUtilTaskbaritem -state "None" -overlay "checkmark"
|
||||
|
||||
Write-Host "Process complete. Please reboot your computer."
|
||||
|
||||
$ButtonType = [System.Windows.MessageBoxButton]::OK
|
||||
$MessageboxTitle = "Network Reset "
|
||||
$Messageboxbody = ("Stock settings loaded.`n Please reboot your computer")
|
||||
$MessageIcon = [System.Windows.MessageBoxImage]::Information
|
||||
|
||||
[System.Windows.MessageBox]::Show($Messageboxbody, $MessageboxTitle, $ButtonType, $MessageIcon)
|
||||
Write-Host "=========================================="
|
||||
Write-Host "-- Network Configuration has been Reset --"
|
||||
Write-Host "=========================================="
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Windows Update - Reset"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/public/Invoke-WPFFixesUpdate.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesUpdate.ps1). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```powershell title="functions/public/Invoke-WPFFixesUpdate.ps1"
|
||||
```powershell {filename="functions/public/Invoke-WPFFixesUpdate.ps1",linenos=inline,linenostart=1}
|
||||
function Invoke-WPFFixesUpdate {
|
||||
|
||||
<#
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "WinGet - Reinstall"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/public/Invoke-WPFFixesWinget.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesWinget.ps1). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```powershell title="functions/public/Invoke-WPFFixesWinget.ps1"
|
||||
```powershell {filename="functions/public/Invoke-WPFFixesWinget.ps1",linenos=inline,linenostart=1}
|
||||
function Invoke-WPFFixesWinget {
|
||||
|
||||
<#
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Fixes"
|
||||
weight: 2
|
||||
toc: false
|
||||
---
|
||||
|
||||
{{< autolinks section="dev/features/fixes" >}}
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Computer Management"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=196}
|
||||
"WPFPanelComputer": {
|
||||
"Content": "Computer Management",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"compmgmt.msc"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Control Panel"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=185}
|
||||
"WPFPanelControl": {
|
||||
"Content": "Control Panel",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"control"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Network Connections"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=207}
|
||||
"WPFPanelNetwork": {
|
||||
"Content": "Network Connections",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"ncpa.cpl"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Power Panel"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=218}
|
||||
"WPFPanelPower": {
|
||||
"Content": "Power Panel",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"powercfg.cpl"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Printer Panel"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=229}
|
||||
"WPFPanelPrinter": {
|
||||
"Content": "Printer Panel",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"Start-Process 'shell:::{A8A91A66-3A7D-4424-8D24-04E180695C7A}'"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Region"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=240}
|
||||
"WPFPanelRegion": {
|
||||
"Content": "Region",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"intl.cpl"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Windows Restore"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=251}
|
||||
"WPFPanelRestore": {
|
||||
"Content": "Windows Restore",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"rstrui.exe"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Sound Settings"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=262}
|
||||
"WPFPanelSound": {
|
||||
"Content": "Sound Settings",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"mmsys.cpl"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "System Properties"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=273}
|
||||
"WPFPanelSystem": {
|
||||
"Content": "System Properties",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"sysdm.cpl"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "Time and Date"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/feature.json"
|
||||
```json {filename="config/feature.json",linenos=inline,linenostart=284}
|
||||
"WPFPanelTimedate": {
|
||||
"Content": "Time and Date",
|
||||
"category": "Legacy Windows Panels",
|
||||
@@ -18,5 +13,4 @@ This page is generated from [`config/feature.json`](https://github.com/ChrisTitu
|
||||
"InvokeScript": [
|
||||
"timedate.cpl"
|
||||
],
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Legacy Windows Panels"
|
||||
weight: 3
|
||||
toc: false
|
||||
---
|
||||
|
||||
{{< autolinks section="dev/features/legacy-windows-panels" >}}
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: "CTT PowerShell Profile - Install"
|
||||
description: ""
|
||||
---
|
||||
|
||||
```powershell {filename="functions/private/Invoke-WinUtilInstallPSProfile.ps1",linenos=inline,linenostart=1}
|
||||
function Invoke-WinUtilInstallPSProfile {
|
||||
if (-not (Get-Command wt)) {
|
||||
Write-Host "Windows Terminal not found installing..."
|
||||
Install-WinUtilWinget
|
||||
winget install Microsoft.WindowsTerminal --source winget --silent
|
||||
}
|
||||
|
||||
if (-not (Get-Command pwsh)) {
|
||||
Write-Host "Powershell 7 not found installing..."
|
||||
Install-WinUtilWinget
|
||||
winget install Microsoft.PowerShell --source winget --silent
|
||||
}
|
||||
|
||||
wt new-tab pwsh -NoExit -Command "irm https://github.com/ChrisTitusTech/powershell-profile/raw/main/setup.ps1 | iex"
|
||||
}
|
||||
```
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "CTT PowerShell Profile - Remove"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/private/Invoke-WinUtilUninstallPSProfile.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/private/Invoke-WinUtilUninstallPSProfile.ps1). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```powershell title="functions/private/Invoke-WinUtilUninstallPSProfile.ps1"
|
||||
```powershell {filename="functions/private/Invoke-WinUtilUninstallPSProfile.ps1",linenos=inline,linenostart=1}
|
||||
function Invoke-WinUtilUninstallPSProfile {
|
||||
|
||||
if (Test-Path ($Profile + ".bak")) {
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Powershell Profile Powershell 7+ Only"
|
||||
weight: 5
|
||||
toc: false
|
||||
---
|
||||
|
||||
{{< autolinks section="dev/features/powershell-profile-powershell-7--only" >}}
|
||||
@@ -1,14 +1,9 @@
|
||||
---
|
||||
title: "OpenSSH Server - Enable"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/public/Invoke-WPFSSHServer.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFSSHServer.ps1). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```powershell title="functions/public/Invoke-WPFSSHServer.ps1"
|
||||
```powershell {filename="functions/public/Invoke-WPFSSHServer.ps1",linenos=inline,linenostart=1}
|
||||
function Invoke-WPFSSHServer {
|
||||
<#
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Remote Access"
|
||||
weight: 4
|
||||
toc: false
|
||||
---
|
||||
|
||||
{{< autolinks section="dev/features/remote-access" >}}
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "Features"
|
||||
weight: 1
|
||||
toc: false
|
||||
---
|
||||
|
||||
### Fixes
|
||||
|
||||
{{< autolinks section="dev/features/fixes" >}}
|
||||
|
||||
### Legacy Windows Panels
|
||||
|
||||
{{< autolinks section="dev/features/legacy-windows-panels" >}}
|
||||
|
||||
### Features
|
||||
|
||||
{{< autolinks section="dev/features/features" >}}
|
||||
|
||||
### Remote Access
|
||||
|
||||
{{< autolinks section="dev/features/remote-access" >}}
|
||||
|
||||
### Powershell Profile Powershell 7+ Only
|
||||
|
||||
{{< autolinks section="dev/features/powershell-profile-powershell-7--only" >}}
|
||||
@@ -1,17 +1,12 @@
|
||||
---
|
||||
title: "System Tray Battery Percentage"
|
||||
description: "Shows numeric battery percentage next to the battery icon in the system tray."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
```json {filename="config/tweaks.json",linenos=inline,linenostart=1268}
|
||||
"WPFToggleBatteryPercentage": {
|
||||
"Content": "System Tray Battery Percentage",
|
||||
"Description": "Shows numeric battery percentage next to the battery icon in the system tray.",
|
||||
"Description": "If enabled, Shows numeric battery percentage next to the battery icon in the system tray.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
@@ -25,7 +20,6 @@ This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitus
|
||||
"DefaultState": "false"
|
||||
}
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
## Registry Changes
|
||||
@@ -1,17 +1,12 @@
|
||||
---
|
||||
title: "Start Menu Bing Search"
|
||||
description: "Toggles Bing web search results in Windows Search."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
```json {filename="config/tweaks.json",linenos=inline,linenostart=1603}
|
||||
"WPFToggleBingSearch": {
|
||||
"Content": "Start Menu Bing Search",
|
||||
"Description": "Toggles Bing web search results in Windows Search.",
|
||||
"Description": "If enabled, Bing web search results will be included in your Start Menu search.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
@@ -25,7 +20,6 @@ This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitus
|
||||
"DefaultState": "true"
|
||||
}
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
## Registry Changes
|
||||
@@ -1,17 +1,12 @@
|
||||
---
|
||||
title: "Dark Theme for Windows"
|
||||
description: "Dark Mode for the system and applications."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
```json {filename="config/tweaks.json",linenos=inline,linenostart=1286}
|
||||
"WPFToggleDarkMode": {
|
||||
"Content": "Dark Theme for Windows",
|
||||
"Description": "Dark Mode for the system and applications.",
|
||||
"Description": "Enable/Disable Dark Mode.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
@@ -49,7 +44,6 @@ This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitus
|
||||
}
|
||||
"
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
## Registry Changes
|
||||
@@ -1,17 +1,12 @@
|
||||
---
|
||||
title: "BSoD Verbose Mode"
|
||||
description: "Gives more information when you blue screen."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
```json {filename="config/tweaks.json",linenos=inline,linenostart=1242}
|
||||
"WPFToggleDetailedBSoD": {
|
||||
"Content": "BSoD Verbose Mode",
|
||||
"Description": "Gives more information when you blue screen.",
|
||||
"Description": "If enabled, you will see a detailed Blue Screen of Death (BSOD) with more information.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
@@ -33,7 +28,6 @@ This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitus
|
||||
"DefaultState": "false"
|
||||
}
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
## Registry Changes
|
||||
@@ -1,31 +1,25 @@
|
||||
---
|
||||
title: "Window Snapping"
|
||||
description: "Toggles the window snapping feature when dragging windows."
|
||||
editUrl: false
|
||||
title: "Cross-Device Resume"
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
"WPFToggleWindowSnapping": {
|
||||
"Content": "Window Snapping",
|
||||
"Description": "Toggles the window snapping feature when dragging windows.",
|
||||
```json {filename="config/tweaks.json",linenos=inline,linenostart=1224}
|
||||
"WPFToggleDisableCrossDeviceResume": {
|
||||
"Content": "Cross-Device Resume",
|
||||
"Description": "This tweak controls the Resume function in Windows 11 24H2 and later, which allows you to resume an activity from a mobile device and vice-versa.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
"registry": [
|
||||
{
|
||||
"Path": "HKCU:\\Control Panel\\Desktop",
|
||||
"Name": "WindowArrangementActive",
|
||||
"Path": "HKCU:\\Software\\Microsoft\\Windows\\CurrentVersion\\CrossDeviceResume\\Configuration",
|
||||
"Name": "IsResumeAllowed",
|
||||
"Value": "1",
|
||||
"Type": "String",
|
||||
"Type": "DWord",
|
||||
"OriginalValue": "0",
|
||||
"DefaultState": "true"
|
||||
}
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
## Registry Changes
|
||||
@@ -1,17 +1,12 @@
|
||||
---
|
||||
title: "Game Mode"
|
||||
description: "Toggles Windows prioritizes gaming performance by allocating system resources to games."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
```json {filename="config/tweaks.json",linenos=inline,linenostart=1765}
|
||||
"WPFToggleGameMode": {
|
||||
"Content": "Game Mode",
|
||||
"Description": "Toggles Windows prioritizes gaming performance by allocating system resources to games.",
|
||||
"Description": "If enabled, Windows prioritizes gaming performance by allocating system resources. Disable for audio/video production to prevent interference.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
@@ -33,7 +28,6 @@ This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitus
|
||||
"DefaultState": "true"
|
||||
}
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
## Registry Changes
|
||||
@@ -1,17 +1,12 @@
|
||||
---
|
||||
title: "File Explorer Hidden Files"
|
||||
description: "Reveals hidden files in Explorer."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
```json {filename="config/tweaks.json",linenos=inline,linenostart=1356}
|
||||
"WPFToggleHiddenFiles": {
|
||||
"Content": "File Explorer Hidden Files",
|
||||
"Description": "Reveals hidden files in Explorer.",
|
||||
"Description": "If enabled, Hidden Files will be shown.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
@@ -35,7 +30,6 @@ This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitus
|
||||
Invoke-WinUtilExplorerUpdate -action \"restart\"
|
||||
"
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
## Registry Changes
|
||||
@@ -1,17 +1,12 @@
|
||||
---
|
||||
title: "Settings Home Page"
|
||||
description: "Toggles the Home Page in the Windows Settings app."
|
||||
editUrl: false
|
||||
description: ""
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
```json {filename="config/tweaks.json",linenos=inline,linenostart=1585}
|
||||
"WPFToggleHideSettingsHome": {
|
||||
"Content": "Settings Home Page",
|
||||
"Description": "Toggles the Home Page in the Windows Settings app.",
|
||||
"Description": "Enable or disable the Home Page in the Windows Settings app.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
@@ -25,7 +20,6 @@ This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitus
|
||||
"DefaultState": "true"
|
||||
}
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
## Registry Changes
|
||||