Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9419b2803e | ||
|
|
92d5a08d49 | ||
|
|
a3a7c500d4 | ||
|
|
40666e1d31 | ||
|
|
4d4e219562 | ||
|
|
fc03af421b | ||
|
|
8939ecf4b4 | ||
|
|
735b59b82f | ||
|
|
d0d39d6478 | ||
|
|
6f1266eb86 | ||
|
|
48885d7c1e | ||
|
|
abcbc23144 | ||
|
|
311fde6f31 | ||
|
|
ad81e0a7af | ||
|
|
8e3998d9fd | ||
|
|
f65d2631a0 | ||
|
|
5f39d3b42d | ||
|
|
448543870a | ||
|
|
91a4f62068 | ||
|
|
2a73455872 | ||
|
|
52ebc931fd | ||
|
|
7aff652d4c | ||
|
|
be394d2ce0 | ||
|
|
b4181bd008 | ||
|
|
da7354bfc0 | ||
|
|
9de91c3999 | ||
|
|
c2d65b6f99 | ||
|
|
700725a878 | ||
|
|
f9139c75ff | ||
|
|
9ac45d6c31 | ||
|
|
2260df6365 | ||
|
|
fc60cbde09 | ||
|
|
dbe1c365f5 | ||
|
|
a0d3c719a6 | ||
|
|
283b9954f1 | ||
|
|
69ff04b632 | ||
|
|
7ee5be3d2f | ||
|
|
4a1db91e3f | ||
|
|
41e4f35897 | ||
|
|
d1a61790a1 | ||
|
|
87dd643176 | ||
|
|
8f7b12bc0d | ||
|
|
88071f2849 | ||
|
|
df858c4cd7 | ||
|
|
cc5e31460b | ||
|
|
d0f7689504 | ||
|
|
22e1dc9b09 | ||
|
|
c00f1eb7b3 | ||
|
|
f54b22da2c | ||
|
|
e15e2be1c4 | ||
|
|
34f7ce5a0e | ||
|
|
086aecf4b7 | ||
|
|
436773df73 | ||
|
|
4b2fe55a7a | ||
|
|
b8b81edcdb | ||
|
|
a7074963a6 | ||
|
|
032ce8ead0 | ||
|
|
792122e998 | ||
|
|
2d0fd43bd3 | ||
|
|
219b2fe137 | ||
|
|
527eefb114 | ||
|
|
d1b8470af2 | ||
|
|
6066675f93 | ||
|
|
b21d416161 | ||
|
|
87a0eb8637 | ||
|
|
8500ed116f | ||
|
|
d16ee0e9f1 | ||
|
|
5ba8686dd7 | ||
|
|
3f1850f623 | ||
|
|
0dbe39bc7d | ||
|
|
91972b0853 | ||
|
|
aee3e7a1f4 | ||
|
|
ea5de27b6c | ||
|
|
2752fe2e03 | ||
|
|
1458327638 | ||
|
|
ea7fcf9d2b | ||
|
|
0aa4ab3a40 | ||
|
|
afc3e1eec2 | ||
|
|
53fc260cc0 | ||
|
|
bc607b6c91 | ||
|
|
7f18b4fd60 | ||
|
|
32ab9f0ab0 | ||
|
|
9fdadd1c8f | ||
|
|
6de45a38b9 | ||
|
|
8860caf357 | ||
|
|
8fb078da4c | ||
|
|
95e3a54405 | ||
|
|
c817d3329a | ||
|
|
19f938e876 | ||
|
|
d64bb18717 | ||
|
|
5ad168e0c4 | ||
|
|
8d3adb599f | ||
|
|
f7c072341d | ||
|
|
32cc623959 | ||
|
|
b096aaa5e5 | ||
|
|
a0142ace72 | ||
|
|
97f2ad6e98 | ||
|
|
97e0711034 | ||
|
|
b832da622f | ||
|
|
f7361fdb72 | ||
|
|
f3cf1587e0 | ||
|
|
91ffd3af30 | ||
|
|
1ef581026f | ||
|
|
89fd09fc0e | ||
|
|
056a819470 | ||
|
|
e96f990c60 | ||
|
|
e591161dac | ||
|
|
d98f8a9916 |
@@ -3,4 +3,7 @@
|
||||
|
||||
# Seanh1917 (ANGRYxScotsmans) is the docs guy
|
||||
docs/ @ChrisTitusTech @seanh1995
|
||||
tools/devdocs-generator.* @ChrisTitusTech @seanh1995
|
||||
tools/devdocs-generator.* @ChrisTitusTech @seanh1995
|
||||
|
||||
# Title screen generation
|
||||
tools/title-screen/ @ChrisTitusTech @mewclouds
|
||||
|
||||
@@ -5,13 +5,13 @@
|
||||
* Test the latest changes to WinUtil by running the pre-release and reporting issues you are encountering to help us continually improve WinUtil!
|
||||
|
||||
#### **Run the latest pre-release**
|
||||
```ps1
|
||||
irm https://christitus.com/windev | iex
|
||||
```
|
||||
|
||||
!!! bug "Keep in mind"
|
||||
```ps1
|
||||
irm https://christitus.com/windev | iex
|
||||
```
|
||||
|
||||
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!
|
||||
> [!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
|
||||
|
||||
@@ -23,19 +23,17 @@
|
||||
|
||||
* If you're doing code changes, then you can submit a PR to the `main` branch.
|
||||
|
||||
!!! warning "Important"
|
||||
|
||||
Do not use a code formatter, make massive amounts of line changes, or make multiple feature changes. EACH FEATURE CHANGE SHOULD BE IT'S 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.
|
||||
> [!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.
|
||||
> [!NOTE]
|
||||
> When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
|
||||
|
||||
## Walk through
|
||||
|
||||
@@ -47,37 +45,34 @@
|
||||
|
||||
### Overview
|
||||
|
||||
``` mermaid
|
||||
```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];
|
||||
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;
|
||||
```
|
||||
!!! info
|
||||
|
||||
This is a diagram to guide you through the process. It may vary depending on the type of change you're making.
|
||||
> [!NOTE]
|
||||
> This is a diagram to guide you through the process. It may vary depending on the type of change you're making.
|
||||
|
||||
### 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.
|
||||
|
||||

|
||||
|
||||

|
||||

|
||||
|
||||
### 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.
|
||||
> [!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.
|
||||
|
||||
* Install GitHub Desktop if it is not already installed.
|
||||
* Log in using the same GitHub account you used to fork WinUtil.
|
||||
@@ -96,7 +91,7 @@ graph TD
|
||||
* Run the following command to compile and run WinUtil:
|
||||
* `.\Compile.ps1 -run`
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
Open PowerShell as Administrator.
|
||||
@@ -107,15 +102,15 @@ Open PowerShell as Administrator.
|
||||
### Committing the changes
|
||||
* Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
|
||||
|
||||

|
||||

|
||||
|
||||
* Now, commit your changes once you are happy with the result.
|
||||
|
||||

|
||||

|
||||
|
||||
* Push the changes to upload them to your fork on github.com.
|
||||
* Push the changes to upload them to your fork on GitHub.
|
||||
|
||||

|
||||

|
||||
|
||||
### 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.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
name: "Bug report"
|
||||
description: "Report a bug to help us identify and fix issues in the project."
|
||||
title: "[Bug Report] - <your summary here>"
|
||||
labels: ["bug"]
|
||||
|
||||
body:
|
||||
@@ -42,14 +43,16 @@ body:
|
||||
- type: textarea
|
||||
id: issue_description
|
||||
attributes:
|
||||
label: Provide a clear and concise description of the issue.
|
||||
label: "Description of the issue"
|
||||
description: Provide a clear and concise description of the issue.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: tweaks_applied
|
||||
attributes:
|
||||
label: List the tweaks you applied before the issue occurred.
|
||||
label: "List of Applied Tweaks"
|
||||
description: List the tweaks you applied before the issue occurred.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
@@ -57,4 +60,5 @@ body:
|
||||
id: error_output
|
||||
attributes:
|
||||
label: Paste the full error output (if available) or Screenshot or Video.
|
||||
placeholder: "Include any relevant logs or error messages."
|
||||
description: "If you're willing to share the whole log, please provide an external link to text-sharing service, i.e. Pastebin"
|
||||
placeholder: "Include any relevant logs or error messages. Keep any sensitive info out of the presented log"
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
name: "Feature request"
|
||||
description: "Suggest a new feature or improvement for the project."
|
||||
title: "[Feature Request] - <your summary here>"
|
||||
labels: ["enhancement"]
|
||||
|
||||
body:
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
# Copilot Instructions
|
||||
|
||||
Read `AGENTS.md` in the repository root for operating instructions before doing anything else.
|
||||
@@ -6,25 +6,17 @@ 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'
|
||||
@@ -38,36 +30,6 @@ jobs:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- 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:
|
||||
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/src/content/docs/code-reference/
|
||||
config/tweaks.json
|
||||
config/feature.json
|
||||
labels: |
|
||||
automated
|
||||
documentation
|
||||
skip-changelog
|
||||
|
||||
- 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, build, and upload your site
|
||||
uses: withastro/action@v6
|
||||
with:
|
||||
|
||||
@@ -0,0 +1,207 @@
|
||||
name: Generate WinUtil title screen
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
concurrency:
|
||||
group: winutil-title-screen
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
generate:
|
||||
runs-on: windows-latest
|
||||
timeout-minutes: 15
|
||||
env:
|
||||
WINUTIL_CAPTURE_WIDTH: "1920"
|
||||
WINUTIL_CAPTURE_HEIGHT: "1080"
|
||||
|
||||
defaults:
|
||||
run:
|
||||
shell: pwsh
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
ref: main
|
||||
persist-credentials: false
|
||||
|
||||
- name: Install uv and Python
|
||||
uses: astral-sh/setup-uv@v10.2.0
|
||||
with:
|
||||
version: "0.12.0"
|
||||
python-version: "3.13"
|
||||
enable-cache: false
|
||||
|
||||
- name: Set display resolution
|
||||
run: |
|
||||
# Set-DisplayResolution is provided by Windows PowerShell's ServerCore
|
||||
# module, so this step intentionally calls powershell.exe from pwsh.
|
||||
& powershell.exe -NoLogo -NoProfile -Command @'
|
||||
Set-DisplayResolution `
|
||||
-Width $env:WINUTIL_CAPTURE_WIDTH `
|
||||
-Height $env:WINUTIL_CAPTURE_HEIGHT `
|
||||
-Force
|
||||
'@
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
throw "Failed to set the runner display resolution."
|
||||
}
|
||||
|
||||
Add-Type @"
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
public static class ResolutionCheck {
|
||||
[DllImport("user32.dll")]
|
||||
public static extern int GetSystemMetrics(int index);
|
||||
}
|
||||
"@
|
||||
|
||||
$actualWidth = [ResolutionCheck]::GetSystemMetrics(0)
|
||||
$actualHeight = [ResolutionCheck]::GetSystemMetrics(1)
|
||||
if (
|
||||
$actualWidth -ne [int]$env:WINUTIL_CAPTURE_WIDTH -or
|
||||
$actualHeight -ne [int]$env:WINUTIL_CAPTURE_HEIGHT
|
||||
) {
|
||||
throw (
|
||||
"The hosted runner rejected the requested resolution. " +
|
||||
"Requested: $env:WINUTIL_CAPTURE_WIDTH" +
|
||||
"x$env:WINUTIL_CAPTURE_HEIGHT; " +
|
||||
"actual: ${actualWidth}x${actualHeight}."
|
||||
)
|
||||
}
|
||||
|
||||
- name: Report display environment
|
||||
run: |
|
||||
Add-Type @"
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
public static class DisplayInfo {
|
||||
[DllImport("user32.dll")]
|
||||
public static extern int GetSystemMetrics(int index);
|
||||
}
|
||||
"@
|
||||
|
||||
$width = [DisplayInfo]::GetSystemMetrics(0)
|
||||
$height = [DisplayInfo]::GetSystemMetrics(1)
|
||||
$sessionId = [Diagnostics.Process]::GetCurrentProcess().SessionId
|
||||
|
||||
Write-Host "Resolution: ${width}x${height}"
|
||||
Write-Host "Session ID: $sessionId"
|
||||
Write-Host "User: $env:USERNAME"
|
||||
|
||||
- name: Compile WinUtil
|
||||
run: |
|
||||
Set-ExecutionPolicy Bypass -Scope Process -Force
|
||||
./Compile.ps1
|
||||
|
||||
- name: Launch WinUtil
|
||||
run: |
|
||||
$scriptPath = Join-Path $env:GITHUB_WORKSPACE "winutil.ps1"
|
||||
$command = "& '$scriptPath'"
|
||||
$bytes = [Text.Encoding]::Unicode.GetBytes($command)
|
||||
$encodedCommand = [Convert]::ToBase64String($bytes)
|
||||
|
||||
# Hide the console host while leaving the WPF window available.
|
||||
$process = Start-Process powershell.exe -ArgumentList @(
|
||||
"-NoLogo",
|
||||
"-NoProfile",
|
||||
"-ExecutionPolicy", "Bypass",
|
||||
"-EncodedCommand", $encodedCommand
|
||||
) -WindowStyle Hidden -PassThru
|
||||
|
||||
"WINUTIL_HOST_PID=$($process.Id)" |
|
||||
Out-File $env:GITHUB_ENV -Append -Encoding utf8
|
||||
|
||||
$deadline = (Get-Date).AddSeconds(90)
|
||||
do {
|
||||
Start-Sleep -Seconds 2
|
||||
# A versioned title excludes the unversioned console host.
|
||||
$window = Get-Process |
|
||||
Where-Object { $_.MainWindowTitle -match '^WinUtil\s+\d' } |
|
||||
Select-Object -First 1
|
||||
} until ($window -or (Get-Date) -ge $deadline)
|
||||
|
||||
if (-not $window) {
|
||||
throw "WinUtil did not expose a window within 90 seconds."
|
||||
}
|
||||
|
||||
Write-Host "WinUtil HWND: $($window.MainWindowHandle)"
|
||||
Write-Host "WinUtil title: $($window.MainWindowTitle)"
|
||||
|
||||
# The exact HWND avoids desktop-enumeration ambiguity. Python validates
|
||||
# the title and WPF class before using it.
|
||||
"WINUTIL_HWND=$($window.MainWindowHandle)" |
|
||||
Out-File $env:GITHUB_ENV -Append -Encoding utf8
|
||||
|
||||
- name: Generate title screen
|
||||
working-directory: tools/title-screen
|
||||
run: |
|
||||
& uv run --locked python automate_title_screen.py `
|
||||
--output ..\..\docs\src\assets\branding\title-screen.png 2>&1 |
|
||||
Tee-Object -FilePath "$env:RUNNER_TEMP\title-screen-capture.log"
|
||||
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
throw "Title-screen automation exited with code $LASTEXITCODE."
|
||||
}
|
||||
|
||||
- name: Create title-screen update pull request
|
||||
id: cpr
|
||||
uses: peter-evans/create-pull-request@v8
|
||||
with:
|
||||
token: ${{ secrets.AUTO_MERGE }}
|
||||
add-paths: docs/src/assets/branding/title-screen.png
|
||||
base: main
|
||||
branch: title-screen-update
|
||||
delete-branch: true
|
||||
commit-message: "docs: update WinUtil title screen"
|
||||
title: "docs: update WinUtil title screen"
|
||||
body: |
|
||||
Regenerates the WinUtil Light and Dark title-screen composite from the current main branch.
|
||||
|
||||
Source workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
|
||||
labels: |
|
||||
automated
|
||||
documentation
|
||||
skip-changelog
|
||||
|
||||
- name: Report pull request
|
||||
if: steps.cpr.outputs.pull-request-url
|
||||
env:
|
||||
PR_OPERATION: ${{ steps.cpr.outputs.pull-request-operation }}
|
||||
PR_URL: ${{ steps.cpr.outputs.pull-request-url }}
|
||||
run: |
|
||||
Write-Host "Pull request $env:PR_OPERATION`: $env:PR_URL"
|
||||
|
||||
- name: Inspect UI Automation on failure
|
||||
if: failure()
|
||||
continue-on-error: true
|
||||
working-directory: tools/title-screen
|
||||
run: |
|
||||
uv run --locked python inspect_winutil.py `
|
||||
"$env:RUNNER_TEMP\winutil-title-screen-inspect.txt"
|
||||
|
||||
- name: Upload failure diagnostics
|
||||
if: failure()
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: winutil-title-screen-failure-${{ github.run_number }}
|
||||
path: |
|
||||
docs/src/assets/branding/title-screen.png
|
||||
${{ runner.temp }}/title-screen-capture.log
|
||||
${{ runner.temp }}/winutil-title-screen-inspect.txt
|
||||
if-no-files-found: warn
|
||||
retention-days: 14
|
||||
|
||||
- name: Close WinUtil
|
||||
if: always()
|
||||
run: |
|
||||
if ($env:WINUTIL_HOST_PID) {
|
||||
Stop-Process `
|
||||
-Id ([int]$env:WINUTIL_HOST_PID) `
|
||||
-Force `
|
||||
-ErrorAction SilentlyContinue
|
||||
}
|
||||
@@ -31,21 +31,23 @@ 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 JSON Links
|
||||
- name: Create Pull Request for Updated Docs and JSON Links
|
||||
id: cpr
|
||||
uses: peter-evans/create-pull-request@v8
|
||||
with:
|
||||
token: ${{ secrets.AUTO_MERGE }}
|
||||
commit-message: 'chore: Update documentation links in JSON configs'
|
||||
title: 'chore: Update documentation links in JSON configs'
|
||||
body: 'Automated update of documentation links in JSON configs from pre-release build'
|
||||
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'
|
||||
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
|
||||
|
||||
@@ -0,0 +1,212 @@
|
||||
name: Repo Contributors' Issue Triage Tools
|
||||
|
||||
on:
|
||||
issue_comment:
|
||||
types: [created, edited]
|
||||
|
||||
jobs:
|
||||
triage-tools:
|
||||
if: ${{ !github.event.issue.pull_request }}
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
issues: write
|
||||
pull-requests: none
|
||||
contents: none
|
||||
steps:
|
||||
- name: Process issue command
|
||||
uses: actions/github-script@v9
|
||||
with:
|
||||
script: |
|
||||
const trustedUsers = [
|
||||
7896101, // ChrisTitusTech
|
||||
57459428, // FluffyPunk
|
||||
125669256, // FallenGME
|
||||
90123670, // mewclouds
|
||||
121827219, // MyDrift-user
|
||||
17331812, // Callum
|
||||
101426328, // CodingWonders
|
||||
70659536 // og-mrk
|
||||
];
|
||||
|
||||
if (context.payload.issue.pull_request) {
|
||||
console.log("Pull request comments are not supported. Exiting.");
|
||||
return;
|
||||
}
|
||||
|
||||
const comment = context.payload.comment;
|
||||
const commentAuthor = comment.user;
|
||||
|
||||
if (!trustedUsers.includes(commentAuthor.id)) {
|
||||
console.log(`Comment author ${commentAuthor.login} is not a trusted user. Exiting.`);
|
||||
return;
|
||||
}
|
||||
|
||||
const {owner, repo} = context.repo;
|
||||
const issueNumber = context.issue.number;
|
||||
const command = comment.body.trim().toLowerCase();
|
||||
const triageMatch = command.match(/^\/triage$/);
|
||||
const triageOffMatch = command.match(/^\/triageoff$/);
|
||||
const notPlannedMatch = command.match(/^\/np(?:\s+(\w+))?$/);
|
||||
const duplicateMatch = command.match(/^\/duplicate\s+#?(\d+)$/);
|
||||
|
||||
if (triageMatch) {
|
||||
const issue = await github.rest.issues.get({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber
|
||||
});
|
||||
|
||||
if (issue.data.labels.some(label => label.name === "needs-triage")) {
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: "This issue already has the 'needs-triage' label. Use /triageoff to remove it."
|
||||
});
|
||||
} else {
|
||||
await github.rest.issues.addLabels({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
labels: ["needs-triage"]
|
||||
});
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: `${commentAuthor.login} requested maintainer triage for this issue.`
|
||||
});
|
||||
}
|
||||
} else if (triageOffMatch) {
|
||||
const issue = await github.rest.issues.get({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber
|
||||
});
|
||||
|
||||
if (issue.data.labels.some(label => label.name === "needs-triage")) {
|
||||
await github.rest.issues.removeLabel({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
name: "needs-triage"
|
||||
});
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: `${commentAuthor.login} removed the triage request from this issue.`
|
||||
});
|
||||
} else {
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: "This issue is not currently marked for triage."
|
||||
});
|
||||
}
|
||||
} else if (notPlannedMatch) {
|
||||
const reason = notPlannedMatch[1];
|
||||
|
||||
if (reason === "wontfix") {
|
||||
await github.rest.issues.addLabels({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
labels: ["wontfix"]
|
||||
});
|
||||
} else if (reason === "notrelated") {
|
||||
await github.rest.issues.addLabels({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
labels: ["not-related"]
|
||||
});
|
||||
}
|
||||
|
||||
await github.rest.issues.update({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
state: "closed",
|
||||
state_reason: "not_planned"
|
||||
});
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: `${commentAuthor.login} closed this issue as not planned.`
|
||||
});
|
||||
} else if (duplicateMatch) {
|
||||
const duplicateIssueNumber = Number(duplicateMatch[1]);
|
||||
|
||||
if (!Number.isSafeInteger(duplicateIssueNumber) || duplicateIssueNumber < 1) {
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: "The duplicate target must be a positive issue number."
|
||||
});
|
||||
} else if (duplicateIssueNumber === issueNumber) {
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: "An issue cannot be marked as a duplicate of itself."
|
||||
});
|
||||
} else {
|
||||
let duplicateIssue;
|
||||
try {
|
||||
const response = await github.rest.issues.get({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: duplicateIssueNumber
|
||||
});
|
||||
duplicateIssue = response.data;
|
||||
} catch (error) {
|
||||
if (error.status !== 404) {
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
if (duplicateIssue?.pull_request) {
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: `#${duplicateIssueNumber} is a pull request, not an issue.`
|
||||
});
|
||||
} else if (duplicateIssue) {
|
||||
await github.rest.issues.update({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
state: "closed",
|
||||
state_reason: "duplicate",
|
||||
duplicate_issue_id: duplicateIssue.id
|
||||
});
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: `${commentAuthor.login} closed this issue as a duplicate of #${duplicateIssueNumber}.`
|
||||
});
|
||||
} else {
|
||||
await github.rest.issues.createComment({
|
||||
owner,
|
||||
repo,
|
||||
issue_number: issueNumber,
|
||||
body: `Issue #${duplicateIssueNumber} does not exist.`
|
||||
});
|
||||
}
|
||||
}
|
||||
} else {
|
||||
console.log("Comment does not contain a supported issue command. Exiting.");
|
||||
return;
|
||||
}
|
||||
|
||||
await github.rest.issues.deleteComment({
|
||||
owner,
|
||||
repo,
|
||||
comment_id: comment.id
|
||||
});
|
||||
@@ -10,11 +10,9 @@ testResults.xml
|
||||
# general software/os specific
|
||||
desktop.ini
|
||||
.DS_Store
|
||||
__pycache__/
|
||||
*.pyc
|
||||
.venv/
|
||||
|
||||
.vscode/
|
||||
.idea/
|
||||
|
||||
# hugo files (archived docs)
|
||||
docs-old/public/
|
||||
docs-old/.hugo_build.lock
|
||||
docs-old/resources/
|
||||
|
||||
@@ -4,35 +4,22 @@ Drop-in operating instructions for coding agents. Read this file before every ta
|
||||
|
||||
**Working code only. Finish the job. Plausibility is not correctness.**
|
||||
|
||||
This repository follows the AGENTS.md convention: these instructions are for Codex, Claude Code, Cursor, Windsurf, Copilot, Aider, Devin, Amp, and other coding agents that read `AGENTS.md`.
|
||||
`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. Change source files and compile.
|
||||
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 fabricate.** Do not invent file paths, function names, command output, test results, commit hashes, or API behavior. Read the file or run the command.
|
||||
4. **Disagree when the premise is wrong.** Say what is wrong before acting on it.
|
||||
5. **Stop when genuinely ambiguous.** If two interpretations would produce materially different diffs, ask before editing.
|
||||
6. **Touch only what the task requires.** No drive-by refactors, formatting sweeps, or unrelated cleanup.
|
||||
7. **Verify before saying done.** A plausible-looking diff is not proof.
|
||||
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. 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: Hugo site under `docs/`.
|
||||
- Release artifact: generated root `winutil.ps1`.
|
||||
|
||||
### Key Commands
|
||||
## 1. Key Commands
|
||||
|
||||
- Compile:
|
||||
```powershell
|
||||
@@ -42,48 +29,47 @@ WinUtil is a Windows PowerShell utility with a WPF interface. The repository is
|
||||
```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
|
||||
Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed -CI
|
||||
```
|
||||
- Run Script Analyzer with project settings when available:
|
||||
- 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. Source Of Truth
|
||||
## 2. Dependency Installs, Builds, And Dev Servers
|
||||
|
||||
Make durable changes only in files consumed by `Compile.ps1` or in documentation/test files:
|
||||
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`).
|
||||
|
||||
- `scripts/start.ps1` for startup/bootstrap code.
|
||||
- `functions/public/*.ps1` for UI-facing and user-facing workflows.
|
||||
- `functions/private/*.ps1` for internal helpers.
|
||||
- `config/*.json` for applications, tweaks, features, DNS, presets, navigation, themes, and related declarative data.
|
||||
- `xaml/inputXML.xaml` for the WPF UI layout.
|
||||
- `tools/autounattend.xml` for the embedded unattended Windows setup template.
|
||||
- `scripts/main.ps1` for the final entrypoint and GUI initialization logic appended during compile.
|
||||
- `pester/*.Tests.ps1` for automated checks.
|
||||
- `docs/` for Hugo documentation.
|
||||
- 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/`. PowerShell tooling runs directly on the host per Section 1. The Python project under `tools/title-screen/` runs with uv as documented in its README.
|
||||
|
||||
If behavior changes require the compiled script to change, update these source files and run `.\Compile.ps1` only to verify generation.
|
||||
## 3. Source Of Truth
|
||||
|
||||
## 3. Build Model
|
||||
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.
|
||||
|
||||
`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, do not rely on runtime module imports or source-relative dot-sourcing unless the compiled script will also contain the required code/data.
|
||||
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
|
||||
|
||||
@@ -97,11 +83,10 @@ Because the final script is concatenated, do not rely on runtime module imports
|
||||
|
||||
- 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. A button named `WPFExampleButton` is typically handled by `Invoke-WPFExampleButton`.
|
||||
- Use `$sync` for shared state and UI references, consistent with the existing runspace model.
|
||||
- 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.
|
||||
- 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.
|
||||
@@ -109,7 +94,7 @@ Because the final script is concatenated, do not rely on runtime module imports
|
||||
|
||||
## 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.
|
||||
- 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.
|
||||
@@ -136,24 +121,27 @@ Define success in terms that can be checked, then check it.
|
||||
- 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.
|
||||
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`, `docs/public/`, `docs/resources/`, `binary/`, editor folders, or other ignored build artifacts.
|
||||
- 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.
|
||||
- `docs/src/assets/branding/title-screen.png` is a tracked generated asset. Do not edit it manually. Update `tools/title-screen/` or run the title-screen workflow.
|
||||
- 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/content/` when user-facing behavior changes.
|
||||
- Update developer docs when architecture, build flow, config schema, or contribution workflow changes.
|
||||
- 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 build/runtime contract changes.
|
||||
- Keep SPEC.md aligned with project/architecture changes, and this file aligned with process changes.
|
||||
|
||||
## 11. Communication Style
|
||||
|
||||
@@ -187,8 +175,16 @@ When the user corrects an agent approach, add or tighten one concrete rule here
|
||||
- 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 `Step-WinUtilJob` safe to call without a window; the `-Preset` and `-Config` paths run the workflows before the form is created and before PresentationCore is loaded. Ask `Test-WinUtilUIAlive` rather than writing the `$sync.Form` / dispatcher / `HasShutdownStarted` check out by hand.
|
||||
- Put long operations on the job layer with `Start-WinUtilJob` and report from them with `Step-WinUtilJob`; a job body must not set the busy flag, print its own banner, or carry its own try/catch/finally around the interface. `Invoke-WPFRunspace` directly is for fire-and-forget work that is not a job.
|
||||
- Drain interface work that nobody is waiting for through `Start-WinUtilBackgroundQueue`; do not hand-roll another dequeue-and-re-post pump.
|
||||
- Values a posted scriptblock needs travel as the dispatcher's argument or through `-Parameters`, never captured from the caller: a plain block resolves them when the dispatcher gets to it, and `GetNewClosure` binds command lookup to a copied scope. For the same reason, prefer a compiled `[action]` over `Invoke-WPFUIThread -Async` on hot re-posting paths, which marshals its body as text and recompiles it per post.
|
||||
- Diagnostic scaffolding does not ship. Measure with it, then delete it.
|
||||
- Have each Pester file load the assemblies and dot-source the functions it needs; several passed only because an earlier file in alphabetical order happened to load them.
|
||||
- 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 Win11 Creator driver injection, inject storage controllers (`SCSIAdapter` / `HDC`) into `boot.wim` index 2 with DISM, not `$WinpeDriver$`. Keep `install.wim` on its own per-package `/Add-Driver` retry loop. For each image, add each root package folder with its own `/Add-Driver /Recurse` so a single bad driver cannot fail the rest, and skip any folder whose ancestor is already in the set, since that ancestor's `/Recurse` covers it. Warn per failure and commit only when at least one package was added; when none were, warn and discard rather than throwing, so the run still produces an ISO. The discard in the cleanup block carries both orphaned mounts and that intentional zero-added case; keep it. Do not export editions or run unrelated WIM cleanup, and reject damaged metadata before ISO export. Use `-LiteralPath` for driver export paths, since `%TEMP%` can contain wildcard characters.
|
||||
- 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.
|
||||
- Public pull-request diffs may be sent to configured external review services without a separate privacy approval; do not block the review loop on upload authorization for this public repository.
|
||||
- Keep install-tab favicon loading overlapped with app-entry rendering; do not replace native WPF loading with a deferred second phase unless visible completion time is proven no slower than `main`.
|
||||
|
||||
@@ -9,6 +9,8 @@ $sync = [Hashtable]::Synchronized(@{})
|
||||
$sync.configs = @{}
|
||||
|
||||
$script = (Get-Content -Path scripts\start.ps1) -replace '#{replaceme}', (Get-Date -Format 'yy.MM.dd')
|
||||
$isLocalCompile = -not [string]::Equals($env:GITHUB_ACTIONS, "true", [StringComparison]::OrdinalIgnoreCase)
|
||||
$script = $script -replace '#{islocalcompile}', $isLocalCompile.ToString().ToLowerInvariant()
|
||||
|
||||
$script += Get-ChildItem -Path functions -Recurse -File | ForEach-Object {
|
||||
Get-Content -Path $_.FullName -Raw
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
# GEMINI.md
|
||||
|
||||
Read `AGENTS.md` in the repository root for operating instructions before doing anything else.
|
||||
@@ -6,13 +6,14 @@
|
||||
|
||||
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.
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
> **WinUtil must be run as Administrator** Because it performs system-wide changes.
|
||||
> **WinUtil must be run as Administrator** because it performs system-wide changes.
|
||||
|
||||
Open PowerShell or Terminal as admin, then run:
|
||||
|
||||
@@ -71,13 +72,15 @@ See https://github.com/ChrisTitusTech/winutil/blob/main/.github/CONTRIBUTING.md
|
||||
## Support
|
||||
|
||||
- Leave a ⭐ to show support!
|
||||
- EXE Wrapper for $10 @ https://www.cttstore.com/windows-toolbox
|
||||
- Faster Dotnet Implementation for sale here: https://www.cttstore.com/windows-toolbox
|
||||
|
||||
## 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 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/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" /></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/seanh1995"><img src="https://github.com/seanh1995.png" width="60px" alt="User avatar: Sean (ANGRYxScotsman)" /></a><a href="https://github.com/F-L-Perez"><img src="https://github.com/F-L-Perez.png" width="60px" alt="User avatar: Fra · ppe" /></a><a href="https://github.com/josencarnacao"><img src="https://github.com/josencarnacao.png" width="60px" alt="User avatar: José Encarnação" /></a><!-- sponsors -->
|
||||
|
||||
*<sub>Sponsors with a recurring subscription also get access to the .NET alternative.</sub>
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,10 +1,38 @@
|
||||
# SPEC.md
|
||||
|
||||
## Project Contract
|
||||
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.
|
||||
|
||||
WinUtil is a Windows PowerShell utility with a WPF interface. The repository is maintained as modular source files, but the released artifact is a single generated `winutil.ps1` script.
|
||||
`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.
|
||||
|
||||
The compiled `winutil.ps1` is not source code for editing or review. It is generated by `Compile.ps1` and produced during release automation. All durable changes must be made to the source files that feed the compiler.
|
||||
## 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.
|
||||
- `tools/title-screen/`: uv project that captures WinUtil's Light and Dark themes and generates the title-screen composite.
|
||||
- `docs/`: Astro + Starlight documentation site, with its own `package.json` and build independent of `Compile.ps1`.
|
||||
- `winutil.ps1`: ignored generated build artifact.
|
||||
|
||||
## Goals
|
||||
|
||||
@@ -21,85 +49,68 @@ The compiled `winutil.ps1` is not source code for editing or review. It is gener
|
||||
- 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.
|
||||
|
||||
## Repository Layout
|
||||
## Build Model
|
||||
|
||||
- `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/`: Hugo documentation site.
|
||||
- `winutil.ps1`: ignored generated build artifact.
|
||||
`Compile.ps1` combines the repository sources into `winutil.ps1` in this order:
|
||||
|
||||
## Compile Specification
|
||||
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`.
|
||||
|
||||
`Compile.ps1` must produce a standalone root `winutil.ps1` by combining all required project files.
|
||||
|
||||
The compile flow is:
|
||||
|
||||
1. Initialize shared state with `$sync = [Hashtable]::Synchronized(@{})` and `$sync.configs = @{}`.
|
||||
2. Read `scripts/start.ps1`.
|
||||
3. Replace `#{replaceme}` in startup code with the current `yy.MM.dd` build date.
|
||||
4. Append raw content from all files under `functions/` recursively.
|
||||
5. For every file in `config/`, parse JSON and embed it into `$sync.configs.<basename>`.
|
||||
6. Special-case `config/applications.json` so application keys are emitted with the `WPFInstall` prefix.
|
||||
7. Embed `xaml/inputXML.xaml` as `$inputXML`.
|
||||
8. Embed `tools/autounattend.xml` as `$WinUtilAutounattendXml`.
|
||||
9. Append `scripts/main.ps1`.
|
||||
10. Write the combined script to `winutil.ps1`.
|
||||
11. If `-Run` is supplied, execute the generated script.
|
||||
|
||||
The generated script must have everything it needs from repository sources embedded or appended by this process.
|
||||
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 should use runspaces or existing async patterns so the UI remains responsive.
|
||||
- UI updates from background work must be dispatched back to the WPF UI thread.
|
||||
- Declarative features such as apps, tweaks, presets, DNS providers, and navigation should stay in `config/*.json` unless code is required.
|
||||
- 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 existing naming conventions, where an element named like `WPFThingButton` maps to a function named like `Invoke-WPFThingButton`.
|
||||
- When adding controls, ensure the XAML name, config key, and PowerShell function names line up with the existing event system.
|
||||
- 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 application entry should include 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 should include original values or original states when applicable so undo workflows can restore user systems.
|
||||
|
||||
Preset and navigation files should reference valid config keys. Avoid renaming config keys unless all presets, UI references, docs, and code paths are updated together.
|
||||
- Config files must remain valid JSON and compile cleanly through `ConvertFrom-Json`.
|
||||
- `config/dns.json` opts unfiltered providers into Fastest selection with `BenchmarkEligible: true`; missing or false values exclude a provider from the TCP latency benchmark.
|
||||
- `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 can affect the host system. Changes must be explicit, reversible where practical, and consistent with existing logging and confirmation patterns.
|
||||
- Tweak changes should include undo metadata when the schema supports it.
|
||||
- Package installation should prefer existing WinGet and Chocolatey helper functions.
|
||||
- ISO workflows must not modify the user's original ISO file; they should work on copied/mounted content following existing patterns.
|
||||
- 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/src/assets/branding/title-screen.png` is a tracked generated image used by the repository README and docs homepage. Its raw Light and Dark captures are temporary.
|
||||
- `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
|
||||
|
||||
Expected validation for source changes:
|
||||
|
||||
- `.\Compile.ps1` verifies the compiler can generate `winutil.ps1`.
|
||||
- `.\Compile.ps1 -Run` compiles and launches the generated utility for manual GUI verification.
|
||||
- `Install-Module -Name Pester -RequiredVersion 5.8.0 -Scope CurrentUser -Force -SkipPublisherCheck` installs the supported Pester version.
|
||||
- `Import-Module Pester -RequiredVersion 5.8.0 -Force; Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed -CI` runs the Pester suite.
|
||||
- GitHub Actions also runs a compile check and PowerShell Script Analyzer with `lint/PSScriptAnalyser.ps1`.
|
||||
|
||||
The generated `winutil.ps1` may appear locally after compile. It remains ignored build output and must not be committed.
|
||||
- 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.
|
||||
- The manually triggered title-screen workflow compiles WinUtil from `main` and opens an image-only pull request when the generated composite changes. These pull requests require manual review. Failed runs retain diagnostics for 14 days.
|
||||
|
||||
## Release Artifact
|
||||
|
||||
GitHub Actions is responsible for producing the release `winutil.ps1` from repository sources. A release should be considered valid only if the generated script came from the compile process, not from direct manual edits to `winutil.ps1`.
|
||||
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`.
|
||||
|
||||
@@ -17,8 +17,17 @@
|
||||
"winget": "7zip.7zip",
|
||||
"foss": true
|
||||
},
|
||||
"abdownloadmanager": {
|
||||
"category": "Utilities",
|
||||
"choco": "ab-download-manager",
|
||||
"content": "AB Download Manager",
|
||||
"description": "AB Download Manager is an open-source download accelerator and manager with multi-threaded downloads, queue scheduling, speed limiting, and browser integration.",
|
||||
"link": "https://abdownloadmanager.com/",
|
||||
"winget": "amir1376.ABDownloadManager",
|
||||
"foss": true
|
||||
},
|
||||
"adobe": {
|
||||
"category": "Multimedia Tools",
|
||||
"category": "Document",
|
||||
"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.",
|
||||
@@ -98,6 +107,15 @@
|
||||
"winget": "AutoHotkey.AutoHotkey",
|
||||
"foss": true
|
||||
},
|
||||
"battlenet": {
|
||||
"category": "Games",
|
||||
"choco": "na",
|
||||
"winget": "Blizzard.BattleNet",
|
||||
"content": "Battle.net",
|
||||
"description": "Battle.net is a launcher for games created and developed by Activision Blizzard",
|
||||
"link": "https://battle.net",
|
||||
"foss": false
|
||||
},
|
||||
"bitwarden": {
|
||||
"category": "Utilities",
|
||||
"choco": "bitwarden",
|
||||
@@ -125,6 +143,15 @@
|
||||
"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",
|
||||
@@ -166,7 +193,7 @@
|
||||
"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",
|
||||
"link": "https://openai.com/chatgpt/download/",
|
||||
"winget": "msstore:9NT1R1C2HH7J",
|
||||
"foss": false
|
||||
},
|
||||
@@ -193,7 +220,7 @@
|
||||
"choco": "chromium",
|
||||
"content": "Chromium",
|
||||
"description": "Chromium is the open-source project that serves as the foundation for various web browsers, including Chrome.",
|
||||
"link": "https://github.com/Hibbiki/chromium-win64",
|
||||
"link": "https://www.chromium.org/",
|
||||
"winget": "Hibbiki.Chromium",
|
||||
"foss": true
|
||||
},
|
||||
@@ -319,10 +346,19 @@
|
||||
"choco": "dorion",
|
||||
"content": "Dorion",
|
||||
"description": "Tiny alternative Discord client with a smaller footprint, snappier startup, themes, plugins and more!",
|
||||
"link": "https://github.com/SpikeHD/Dorion",
|
||||
"link": "https://spikehd.dev/projects/dorion/",
|
||||
"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",
|
||||
@@ -395,6 +431,16 @@
|
||||
"winget": "Microsoft.Edge",
|
||||
"foss": false
|
||||
},
|
||||
"es-de": {
|
||||
"category": "Games",
|
||||
"choco": "",
|
||||
"content": "EmulationStation Desktop Edition",
|
||||
"_comment": "This and emulationstation are two completely different things. ES-DE is your frontend for everything and has its own set of emulators. Emulationstation is a graphical frontend for RetroArch.",
|
||||
"description": "EmulationStation Desktop Edition is a frontend for browsing and launching games from your multi-platform game collection.",
|
||||
"link": "https://es-de.org/",
|
||||
"winget": "ES-DE.EmulationStation-DE",
|
||||
"foss": true
|
||||
},
|
||||
"enteauth": {
|
||||
"category": "Utilities",
|
||||
"choco": "ente-auth",
|
||||
@@ -418,10 +464,19 @@
|
||||
"choco": "files",
|
||||
"content": "Files",
|
||||
"description": "Alternative file explorer.",
|
||||
"link": "https://github.com/files-community/Files",
|
||||
"link": "https://files.community",
|
||||
"winget": "FilesCommunity.Files",
|
||||
"foss": true
|
||||
},
|
||||
"fileconverter": {
|
||||
"category": "Multimedia Tools",
|
||||
"choco": "file-converter",
|
||||
"content": "File Converter",
|
||||
"description": "File Converter converts and compresses files from the Windows Explorer context menu.",
|
||||
"link": "https://file-converter.io/",
|
||||
"winget": "AdrienAllard.FileConverter",
|
||||
"foss": true
|
||||
},
|
||||
"firefox": {
|
||||
"category": "Browsers",
|
||||
"choco": "firefox",
|
||||
@@ -458,6 +513,33 @@
|
||||
"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",
|
||||
@@ -485,6 +567,24 @@
|
||||
"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",
|
||||
@@ -544,7 +644,7 @@
|
||||
"choco": "helium",
|
||||
"content": "Helium",
|
||||
"description": "Private, fast, and honest web browser.",
|
||||
"link": "https://github.com/imputnet/helium/",
|
||||
"link": "https://helium.computer",
|
||||
"winget": "ImputNet.Helium",
|
||||
"foss": true
|
||||
},
|
||||
@@ -553,7 +653,7 @@
|
||||
"choco": "hugo-extended",
|
||||
"content": "Hugo",
|
||||
"description": "The world's fastest framework for building websites.",
|
||||
"link": "https://github.com/gohugoio/hugo/",
|
||||
"link": "https://gohugo.io",
|
||||
"winget": "Hugo.Hugo.Extended",
|
||||
"foss": true
|
||||
},
|
||||
@@ -670,7 +770,7 @@
|
||||
"choco": "jellyfin-media-player",
|
||||
"content": "Jellyfin Media Player",
|
||||
"description": "Jellyfin Media Player is a client application for the Jellyfin media server, providing access to your media library.",
|
||||
"link": "https://github.com/jellyfin/jellyfin-media-player",
|
||||
"link": "https://jellyfin.org/",
|
||||
"winget": "Jellyfin.JellyfinMediaPlayer",
|
||||
"foss": true
|
||||
},
|
||||
@@ -701,6 +801,15 @@
|
||||
"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",
|
||||
@@ -738,7 +847,7 @@
|
||||
"foss": true
|
||||
},
|
||||
"libreoffice": {
|
||||
"category": "Multimedia Tools",
|
||||
"category": "Document",
|
||||
"choco": "libreoffice-fresh",
|
||||
"content": "LibreOffice",
|
||||
"description": "LibreOffice is a powerful and free office suite, compatible with other major office suites.",
|
||||
@@ -751,7 +860,7 @@
|
||||
"choco": "librewolf",
|
||||
"content": "LibreWolf",
|
||||
"description": "LibreWolf is a privacy-focused web browser based on Firefox, with additional privacy and security enhancements.",
|
||||
"link": "https://librewolf-community.gitlab.io/",
|
||||
"link": "https://librewolf.net/",
|
||||
"winget": "LibreWolf.LibreWolf",
|
||||
"foss": true
|
||||
},
|
||||
@@ -769,10 +878,18 @@
|
||||
"choco": "mediainfo",
|
||||
"content": "mpc-qt",
|
||||
"description": "Media Player Classic Qute Theater",
|
||||
"link": "https://github.com/mpc-qt/mpc-qt",
|
||||
"link": "https://mpc-qt.github.io",
|
||||
"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",
|
||||
@@ -814,7 +931,7 @@
|
||||
"choco": "mpc-hc-clsid2",
|
||||
"content": "Media Player Classic - Home Cinema",
|
||||
"description": "Media Player Classic - Home Cinema (MPC-HC) is a free and open-source video and audio player for Windows. MPC-HC is based on the original Guliverkli project and contains many additional features and bug fixes.",
|
||||
"link": "https://github.com/clsid2/mpc-hc/",
|
||||
"link": "https://mpc-hc.org/",
|
||||
"winget": "clsid2.mpc-hc",
|
||||
"foss": true
|
||||
},
|
||||
@@ -841,7 +958,7 @@
|
||||
"choco": "mullvad-app",
|
||||
"content": "Mullvad VPN",
|
||||
"description": "This is the VPN client software for the Mullvad VPN service.",
|
||||
"link": "https://github.com/mullvad/mullvadvpn-app",
|
||||
"link": "https://mullvad.net/",
|
||||
"winget": "MullvadVPN.MullvadVPN",
|
||||
"foss": true
|
||||
},
|
||||
@@ -868,7 +985,7 @@
|
||||
"choco": "nanazip",
|
||||
"content": "NanaZip",
|
||||
"description": "NanaZip is a fast and efficient file compression and decompression tool.",
|
||||
"link": "https://github.com/M2Team/NanaZip",
|
||||
"link": "https://nanazip.org",
|
||||
"winget": "M2Team.NanaZip",
|
||||
"foss": true
|
||||
},
|
||||
@@ -881,10 +998,19 @@
|
||||
"winget": "Netbird.Netbird",
|
||||
"foss": true
|
||||
},
|
||||
"tailscale": {
|
||||
"category": "Utilities",
|
||||
"choco": "tailscale",
|
||||
"content": "Tailscale",
|
||||
"description": "The Tailscale client allows you to connect all your devices using WireGuard®, without the hassle. Tailscale makes it as easy as installing an app and signing in.",
|
||||
"link": "https://tailscale.com/",
|
||||
"winget": "Tailscale.Tailscale",
|
||||
"foss": false
|
||||
},
|
||||
"naps2": {
|
||||
"category": "Multimedia Tools",
|
||||
"category": "Document",
|
||||
"choco": "naps2",
|
||||
"content": "NAPS2 (Document Scanner)",
|
||||
"content": "NAPS2 (Scanner)",
|
||||
"description": "NAPS2 is a document scanning application that simplifies the process of creating electronic documents.",
|
||||
"link": "https://www.naps2.com/",
|
||||
"winget": "Cyanfish.NAPS2",
|
||||
@@ -980,7 +1106,7 @@
|
||||
"foss": true
|
||||
},
|
||||
"obsidian": {
|
||||
"category": "Multimedia Tools",
|
||||
"category": "Document",
|
||||
"choco": "obsidian",
|
||||
"content": "Obsidian",
|
||||
"description": "Obsidian is a powerful note-taking and knowledge management application.",
|
||||
@@ -988,6 +1114,15 @@
|
||||
"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",
|
||||
@@ -998,7 +1133,7 @@
|
||||
"foss": false
|
||||
},
|
||||
"onlyoffice": {
|
||||
"category": "Multimedia Tools",
|
||||
"category": "Document",
|
||||
"choco": "onlyoffice",
|
||||
"content": "ONLYOFFICE Desktop",
|
||||
"description": "ONLYOFFICE Desktop is a comprehensive office suite for document editing and collaboration.",
|
||||
@@ -1087,6 +1222,42 @@
|
||||
"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",
|
||||
@@ -1123,6 +1294,15 @@
|
||||
"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",
|
||||
@@ -1240,6 +1420,15 @@
|
||||
"winget": "qBittorrent.qBittorrent",
|
||||
"foss": true
|
||||
},
|
||||
"qownnotes": {
|
||||
"category": "Document",
|
||||
"choco": "qownnotes",
|
||||
"content": "QOwnNotes",
|
||||
"description": "QOwnNotes is a free open-source note-taking app with Nextcloud/ownCloud integration.",
|
||||
"link": "https://www.qownnotes.org/",
|
||||
"winget": "pbek.QOwnNotes",
|
||||
"foss": true
|
||||
},
|
||||
"qtox": {
|
||||
"category": "Communications",
|
||||
"choco": "qtox",
|
||||
@@ -1339,6 +1528,15 @@
|
||||
"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",
|
||||
@@ -1366,6 +1564,15 @@
|
||||
"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",
|
||||
@@ -1375,6 +1582,15 @@
|
||||
"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",
|
||||
@@ -1384,15 +1600,41 @@
|
||||
"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",
|
||||
"content": "Sunshine/GameStream Server",
|
||||
"description": "Sunshine is a GameStream server that allows you to remotely play PC games on Android devices, offering low-latency streaming.",
|
||||
"link": "https://github.com/LizardByte/Sunshine",
|
||||
"link": "https://app.lizardbyte.dev/Sunshine/",
|
||||
"winget": "LizardByte.Sunshine",
|
||||
"foss": true
|
||||
},
|
||||
"synctrayzor": {
|
||||
"category": "Selfhosted Tools",
|
||||
"choco": "synctrayzor",
|
||||
"content": "SyncTrayzor",
|
||||
"description": "SyncTrayzor is a Windows tray utility that bundles and wraps Syncthing, making it behave like a native application to easily manage and monitor file synchronization.",
|
||||
"link": "https://github.com/GermanCoding/SyncTrayzor",
|
||||
"winget": "GermanCoding.SyncTrayzor"
|
||||
},
|
||||
"syncthing": {
|
||||
"category": "Selfhosted Tools",
|
||||
"choco": "syncthing",
|
||||
"content": "Syncthing (CLI / Web UI)",
|
||||
"description": "Syncthing is a decentralized, peer-to-peer file synchronization tool that securely syncs files directly across devices without cloud servers, managed via a local web interface.",
|
||||
"link": "https://syncthing.net/",
|
||||
"winget": "Syncthing.Syncthing",
|
||||
"foss": true
|
||||
},
|
||||
"tcpview": {
|
||||
"category": "Microsoft Tools",
|
||||
"choco": "tcpview",
|
||||
@@ -1429,6 +1671,15 @@
|
||||
"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",
|
||||
@@ -1497,7 +1748,7 @@
|
||||
"choco": "translucenttb",
|
||||
"content": "TranslucentTB",
|
||||
"description": "TranslucentTB is a tool that allows you to customize the transparency of the Windows Taskbar.",
|
||||
"link": "https://github.com/TranslucentTB/TranslucentTB",
|
||||
"link": "https://translucenttb.github.io",
|
||||
"winget": "CharlesMilette.TranslucentTB",
|
||||
"foss": true
|
||||
},
|
||||
@@ -1528,6 +1779,15 @@
|
||||
"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",
|
||||
@@ -1568,8 +1828,8 @@
|
||||
"category": "Communications",
|
||||
"choco": "na",
|
||||
"content": "Vesktop",
|
||||
"description": "A cross platform electron-based desktop app aiming to give you a snappier Discord experience with Vencord pre-installed.",
|
||||
"link": "https://github.com/Vencord/Vesktop",
|
||||
"description": "A cross-platform electron-based desktop app aiming to give you a snappier Discord experience with Vencord pre-installed.",
|
||||
"link": "https://vesktop.dev",
|
||||
"winget": "Vencord.Vesktop",
|
||||
"foss": true
|
||||
},
|
||||
@@ -1659,7 +1919,7 @@
|
||||
"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",
|
||||
"link": "https://www.whatsapp.com/download",
|
||||
"winget": "msstore:9NKSQGP7F2NH",
|
||||
"foss": false
|
||||
},
|
||||
@@ -1726,6 +1986,15 @@
|
||||
"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",
|
||||
@@ -1773,9 +2042,8 @@
|
||||
},
|
||||
"Overwolf": {
|
||||
"category": "Games",
|
||||
"choco": "overwolf",
|
||||
"content": "Overwolf",
|
||||
"description": "Popular platform for game overlays and companion apps (mod managers, trackers, etc.), widely used by gamers.",
|
||||
"content": "CurseForge",
|
||||
"description": "CurseForge is a desktop application for managing mods and modpacks across multiple games, powered by Overwolf.",
|
||||
"link": "https://www.overwolf.com/app/overwolf-curseforge",
|
||||
"winget": "Overwolf.CurseForge",
|
||||
"foss": false
|
||||
@@ -1807,6 +2075,15 @@
|
||||
"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",
|
||||
@@ -1833,5 +2110,15 @@
|
||||
"content": "Lua",
|
||||
"link": "https://github.com/rjpcomputing/luaforwindows",
|
||||
"foss": true
|
||||
},
|
||||
"CloudflareWARP": {
|
||||
"category": "Utilities",
|
||||
"choco": "warp",
|
||||
"winget": "Cloudflare.Warp",
|
||||
"description": "WARP is a freemium VPN service provided by Cloudflare. Includes usage of Cloudflare's DNS",
|
||||
"content": "Cloudflare WARP",
|
||||
"link": "https://one.one.one.one",
|
||||
"foss": false
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -259,5 +259,13 @@
|
||||
"Description": "Bundles built-in card game modes including Klondike, Spider, FreeCell, Pyramid, and TriPeaks alongside daily challenges.",
|
||||
"Panel": "1",
|
||||
"PackageId": "Microsoft.MicrosoftSolitaireCollection"
|
||||
},
|
||||
"WPFAppxMicrosoft_ZuneVideo": {
|
||||
"Category": "Utilities & Productivity",
|
||||
"Content": "Movies & TV",
|
||||
"Description": "The default video player and storefront for purchasing or renting media.",
|
||||
"Panel": "0",
|
||||
"PackageId": "Microsoft.ZuneVideo",
|
||||
"StoreId": "9WZDNCRFJ3P2"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
{
|
||||
"Google":{
|
||||
"BenchmarkEligible": true,
|
||||
"Primary": "8.8.8.8",
|
||||
"Secondary": "8.8.4.4",
|
||||
"Primary6": "2001:4860:4860::8888",
|
||||
@@ -7,6 +8,7 @@
|
||||
"DohTemplate": "https://dns.google/dns-query"
|
||||
},
|
||||
"Cloudflare":{
|
||||
"BenchmarkEligible": true,
|
||||
"Primary": "1.1.1.1",
|
||||
"Secondary": "1.0.0.1",
|
||||
"Primary6": "2606:4700:4700::1111",
|
||||
|
||||
@@ -13,6 +13,9 @@
|
||||
"FontSize": "12",
|
||||
"FontFamily": "Arial",
|
||||
"HeaderFontSize": "16",
|
||||
"Win11StepTitleFontSize": "22",
|
||||
"Win11StepHeroFontSize": "40",
|
||||
"Win11LogFontFamily": "Consolas, Monaco",
|
||||
"HeaderFontFamily": "Consolas, Monaco",
|
||||
"CheckBoxBulletDecoratorSize": "14",
|
||||
"CheckBoxMargin": "15,0,0,2",
|
||||
@@ -58,6 +61,8 @@
|
||||
"ScrollBarHoverColor": "#5A5D62",
|
||||
"ScrollBarDraggingColor": "#6A6D72",
|
||||
"ProgressBarForegroundColor": "#2E77FF",
|
||||
"ProgressBarErrorColor": "#D13438",
|
||||
"ProgressBarWarningColor": "#B36A00",
|
||||
"ProgressBarBackgroundColor": "Transparent",
|
||||
"ButtonInstallBackgroundColor": "#F7F7F7",
|
||||
"ButtonTweaksBackgroundColor": "#F7F7F7",
|
||||
@@ -98,6 +103,8 @@
|
||||
"ScrollBarHoverColor": "#3B4252",
|
||||
"ScrollBarDraggingColor": "#5E81AC",
|
||||
"ProgressBarForegroundColor": "#6EFF72",
|
||||
"ProgressBarErrorColor": "#FF6B6B",
|
||||
"ProgressBarWarningColor": "#FFC83D",
|
||||
"ProgressBarBackgroundColor": "Transparent",
|
||||
"ButtonInstallBackgroundColor": "#222222",
|
||||
"ButtonTweaksBackgroundColor": "#333333",
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
{
|
||||
"WPFTweaksActivity": {
|
||||
"Content": "Activity History - Disable",
|
||||
"Description": "Erases recent docs, clipboard, and run history.",
|
||||
"Description": "Stops Windows from publishing or uploading user activities while preserving clipboard history.",
|
||||
"category": "Essential Tweaks",
|
||||
"panel": "1",
|
||||
"registry": [
|
||||
{
|
||||
"Path": "HKLM:\\SOFTWARE\\Policies\\Microsoft\\Windows\\System",
|
||||
"Name": "EnableActivityFeed",
|
||||
"Value": "0",
|
||||
"Value": "1",
|
||||
"Type": "DWord",
|
||||
"OriginalValue": "<RemoveEntry>"
|
||||
},
|
||||
@@ -99,10 +99,10 @@
|
||||
"category": "Essential Tweaks",
|
||||
"panel": "1",
|
||||
"InvokeScript": [
|
||||
"icacls \"$Env:LocalAppData\\Packages\\Microsoft.WindowsStore_8wekyb3d8bbwe\\LocalState\\store.db\" /deny Everyone:F"
|
||||
"icacls \"$Env:LocalAppData\\Packages\\Microsoft.WindowsStore_8wekyb3d8bbwe\\LocalState\\store.db\" /deny *S-1-1-0:F"
|
||||
],
|
||||
"UndoScript": [
|
||||
"icacls \"$Env:LocalAppData\\Packages\\Microsoft.WindowsStore_8wekyb3d8bbwe\\LocalState\\store.db\" /grant Everyone:F"
|
||||
"icacls \"$Env:LocalAppData\\Packages\\Microsoft.WindowsStore_8wekyb3d8bbwe\\LocalState\\store.db\" /grant *S-1-1-0:F"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/essential-tweaks/disablestoresearch"
|
||||
},
|
||||
@@ -114,7 +114,7 @@
|
||||
"service": [
|
||||
{
|
||||
"Name": "lfsvc",
|
||||
"StartupType": "Disable",
|
||||
"StartupType": "Disabled",
|
||||
"OriginalType": "Manual"
|
||||
}
|
||||
],
|
||||
@@ -647,7 +647,7 @@
|
||||
"InvokeScript": [
|
||||
"
|
||||
# Deny permission to remove OneDrive folder
|
||||
icacls $Env:OneDrive /deny \"Administrators:(D,DC)\"
|
||||
icacls $Env:OneDrive /deny \"*S-1-5-32-544:(D,DC)\"
|
||||
|
||||
Write-Host \"Uninstalling OneDrive...\"
|
||||
Start-Process -FilePath (Join-Path $Env:SystemRoot \"System32\\OneDriveSetup.exe\") -ArgumentList '/uninstall' -Wait
|
||||
@@ -661,7 +661,7 @@
|
||||
Remove-Item \"$Env:ProgramData\\Microsoft OneDrive\" -Recurse -Force
|
||||
|
||||
# Grant back permission to access OneDrive folder
|
||||
icacls $Env:OneDrive /grant \"Administrators:(D,DC)\"
|
||||
icacls $Env:OneDrive /grant \"*S-1-5-32-544:(D,DC)\"
|
||||
|
||||
if (-not (Get-ChildItem -Path $Env:OneDrive)) {
|
||||
Remove-Item -Path $Env:OneDrive -Recurse
|
||||
@@ -854,7 +854,7 @@
|
||||
},
|
||||
"WPFTweaksEndTaskOnTaskbar": {
|
||||
"Content": "End Task With Right Click - Enable",
|
||||
"Description": "Enables option to end task when right clicking a program in the taskbar.",
|
||||
"Description": "Enables option to end task when right-clicking a program in the taskbar.",
|
||||
"category": "Essential Tweaks",
|
||||
"panel": "1",
|
||||
"registry": [
|
||||
@@ -991,16 +991,51 @@
|
||||
New-Item -Path $RazerPath -ItemType Directory
|
||||
}
|
||||
|
||||
icacls $RazerPath /deny \"Everyone:(W)\"
|
||||
icacls $RazerPath /deny \"*S-1-1-0:(W)\"
|
||||
"
|
||||
],
|
||||
"UndoScript": [
|
||||
"
|
||||
icacls \"$Env:SystemRoot\\Installer\\Razer\" /remove:d Everyone
|
||||
icacls \"$Env:SystemRoot\\Installer\\Razer\" /remove:d *S-1-1-0
|
||||
"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/z--advanced-tweaks---caution/razerblock"
|
||||
},
|
||||
"WPFTweaksLogiBlock": {
|
||||
"Content": "Logitech Download Assistant Auto-Install - Disable",
|
||||
"Description": "Blocks the Logi Download Assistant that Windows Update keeps reinstalling with Logitech device drivers. Logitech hardware keeps working without it.",
|
||||
"category": "z__Advanced Tweaks - CAUTION",
|
||||
"panel": "1",
|
||||
"InvokeScript": [
|
||||
"
|
||||
Stop-Process -Name \"logi_download_assistant\" -Force -ErrorAction SilentlyContinue
|
||||
|
||||
$ProgramFiles64 = if ($Env:ProgramW6432) { $Env:ProgramW6432 } else { $Env:ProgramFiles }
|
||||
$LogiPath = \"$ProgramFiles64\\LogiDownloadAssistant\"
|
||||
|
||||
if (Test-Path $LogiPath) {
|
||||
Remove-Item $LogiPath\\* -Recurse -Force
|
||||
} else {
|
||||
New-Item -Path $LogiPath -ItemType Directory
|
||||
}
|
||||
|
||||
icacls $LogiPath /deny \"*S-1-1-0:(W)\"
|
||||
if ($LASTEXITCODE -ne 0) { throw \"icacls failed to deny write access on $LogiPath (exit code $LASTEXITCODE)\" }
|
||||
"
|
||||
],
|
||||
"UndoScript": [
|
||||
"
|
||||
$ProgramFiles64 = if ($Env:ProgramW6432) { $Env:ProgramW6432 } else { $Env:ProgramFiles }
|
||||
$LogiPath = \"$ProgramFiles64\\LogiDownloadAssistant\"
|
||||
|
||||
if (Test-Path $LogiPath) {
|
||||
icacls $LogiPath /remove:d \"*S-1-1-0\"
|
||||
if ($LASTEXITCODE -ne 0) { throw \"icacls failed to remove the write-deny rule on $LogiPath (exit code $LASTEXITCODE)\" }
|
||||
}
|
||||
"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/z--advanced-tweaks---caution/logiblock"
|
||||
},
|
||||
"WPFTweaksDisableNotifications": {
|
||||
"Content": "System Tray Notifications & Calendar - Disable",
|
||||
"Description": "Disables all Notifications INCLUDING Calendar.",
|
||||
@@ -1086,8 +1121,10 @@
|
||||
"panel": "1",
|
||||
"InvokeScript": [
|
||||
"
|
||||
Remove-Item -Path \"$Env:Temp\\*\" -Recurse -Force
|
||||
Remove-Item -Path \"$Env:SystemRoot\\Temp\\*\" -Recurse -Force
|
||||
# A temp folder always holds files something has open, including this run's own, and
|
||||
# the job layer counts a logged error as a failed step
|
||||
Remove-Item -Path \"$Env:Temp\\*\" -Recurse -Force -ErrorAction SilentlyContinue
|
||||
Remove-Item -Path \"$Env:SystemRoot\\Temp\\*\" -Recurse -Force -ErrorAction SilentlyContinue
|
||||
"
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/essential-tweaks/deletetempfiles"
|
||||
@@ -1168,22 +1205,6 @@
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/z--advanced-tweaks---caution/disablebgapps"
|
||||
},
|
||||
"WPFTweaksDisableFSO": {
|
||||
"Content": "Fullscreen Optimizations - Disable",
|
||||
"Description": "Disables FSO in all applications. NOTE: This will disable Color Management in Exclusive Fullscreen.",
|
||||
"category": "z__Advanced Tweaks - CAUTION",
|
||||
"panel": "1",
|
||||
"registry": [
|
||||
{
|
||||
"Path": "HKCU:\\System\\GameConfigStore",
|
||||
"Name": "GameDVR_DXGIHonorFSEWindowsCompatible",
|
||||
"Value": "1",
|
||||
"Type": "DWord",
|
||||
"OriginalValue": "0"
|
||||
}
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/z--advanced-tweaks---caution/disablefso"
|
||||
},
|
||||
"WPFTweaksDisableExplorerAutoDiscovery": {
|
||||
"Content": "File Explorer Automatic Folder Discovery - Disable",
|
||||
"Description": "Windows Explorer automatically tries to guess the type of the folder based on its contents, slowing down the browsing experience. WARNING! Will disable File Explorer grouping.",
|
||||
@@ -1401,7 +1422,7 @@
|
||||
},
|
||||
"WPFToggleNewOutlook": {
|
||||
"Content": "Microsoft Outlook New Version",
|
||||
"Description": "This will ensures the classic Outlook application is used.",
|
||||
"Description": "This will ensure the new Outlook application is used.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
@@ -1454,34 +1475,45 @@
|
||||
"Value": "0",
|
||||
"Type": "DWord",
|
||||
"OriginalValue": "1",
|
||||
"DefaultState": "false",
|
||||
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/scrollbars"
|
||||
"DefaultState": "false"
|
||||
}
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/customize-preferences/scrollbars"
|
||||
},
|
||||
"WPFToggleMultiplaneOverlay": {
|
||||
"WPFMultiplaneOverlay": {
|
||||
"Content": "Multiplane Overlay",
|
||||
"Description": "Multiplane Overlay compose multiple image layers, which can sometimes cause issues with graphics cards.",
|
||||
"Description": "Multiplane Overlay composes multiple image layers, which can sometimes cause issues with graphics cards. Changes to this preference are applied immediately.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
"Type": "Combobox",
|
||||
"ComboItems": "Enabled|Disabled (Compatibility)|Fully Disabled",
|
||||
"ComboDescriptions": {
|
||||
"Enabled": "Uses Windows' default overlay behavior.",
|
||||
"Disabled (Compatibility)": "Disables MPO using OverlayTestMode=5, the less aggressive compatibility method.",
|
||||
"Fully Disabled": "Disables MPO using OverlayTestMode=5 and DisableOverlays=1, the more aggressive method."
|
||||
},
|
||||
"registry": [
|
||||
{
|
||||
"Path": "HKLM:\\SOFTWARE\\Microsoft\\Windows\\Dwm",
|
||||
"Name": "OverlayTestMode",
|
||||
"Value": "0",
|
||||
"Type": "DWord",
|
||||
"OriginalValue": "5",
|
||||
"DefaultState": "true"
|
||||
"DefaultValue": "0",
|
||||
"Values": {
|
||||
"Enabled": "<RemoveEntry>",
|
||||
"Disabled (Compatibility)": "5",
|
||||
"Fully Disabled": "5"
|
||||
}
|
||||
},
|
||||
{
|
||||
"Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Control\\GraphicsDrivers",
|
||||
"Name": "DisableOverlays",
|
||||
"Value": "0",
|
||||
"Type": "DWord",
|
||||
"OriginalValue": "1",
|
||||
"DefaultState": "true"
|
||||
"DefaultValue": "0",
|
||||
"Values": {
|
||||
"Enabled": "<RemoveEntry>",
|
||||
"Disabled (Compatibility)": "<RemoveEntry>",
|
||||
"Fully Disabled": "1"
|
||||
}
|
||||
}
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/customize-preferences/multiplaneoverlay"
|
||||
@@ -1654,7 +1686,7 @@
|
||||
],
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/customize-preferences/loginblur"
|
||||
},
|
||||
"WPFTweaksDisableLockscreen": {
|
||||
"WPFToggleDisableLockscreen": {
|
||||
"Content": "Lock Screen - Disable",
|
||||
"Description": "Skips the lock screen entirely and goes directly to the sign-in screen on boot and wake.",
|
||||
"category": "Customize Preferences",
|
||||
@@ -1853,7 +1885,7 @@
|
||||
"category": "z__Advanced Tweaks - CAUTION",
|
||||
"panel": "1",
|
||||
"Type": "Combobox",
|
||||
"ComboItems": "Default DHCP Google Cloudflare Cloudflare_Malware Cloudflare_Malware_Adult Open_DNS Quad9 AdGuard_Ads_Trackers AdGuard_Ads_Trackers_Malware_Adult",
|
||||
"ComboItems": "Default DHCP Fastest Google Cloudflare Cloudflare_Malware Cloudflare_Malware_Adult Open_DNS Quad9 AdGuard_Ads_Trackers AdGuard_Ads_Trackers_Malware_Adult",
|
||||
"link": "https://winutil.christitus.com/code-reference/tweaks/z--advanced-tweaks---caution/changedns"
|
||||
},
|
||||
"WPFAddUltPerf": {
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
node_modules
|
||||
.astro
|
||||
dist
|
||||
.git
|
||||
.env
|
||||
.env.*
|
||||
*.log
|
||||
@@ -16,6 +16,8 @@ pnpm-debug.log*
|
||||
# environment variables
|
||||
.env
|
||||
.env.production
|
||||
.env.local
|
||||
.env.*.local
|
||||
|
||||
# macOS-specific files
|
||||
.DS_Store
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
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,26 +1,24 @@
|
||||
# Starlight Starter Kit: Basics
|
||||
# WinUtil Docs
|
||||
|
||||
[](https://starlight.astro.build)
|
||||
|
||||
```
|
||||
npm create astro@latest -- --template starlight
|
||||
```
|
||||
|
||||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||
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
|
||||
|
||||
Inside of your Astro + Starlight project, you'll see the following folders and files:
|
||||
|
||||
```
|
||||
.
|
||||
├── public/
|
||||
├── src/
|
||||
│ ├── assets/
|
||||
│ ├── components/
|
||||
│ ├── content/
|
||||
│ │ └── docs/
|
||||
│ ├── styles/
|
||||
│ └── content.config.ts
|
||||
├── astro.config.mjs
|
||||
├── docker-compose.yml
|
||||
├── Dockerfile
|
||||
├── package.json
|
||||
└── tsconfig.json
|
||||
```
|
||||
@@ -33,17 +31,31 @@ Static assets, like favicons, can be placed in the `public/` directory.
|
||||
|
||||
## 🧞 Commands
|
||||
|
||||
All commands are run from the root of the project, from a terminal:
|
||||
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.
|
||||
|
||||
| Command | Action |
|
||||
| :------------------------ | :----------------------------------------------- |
|
||||
| `npm install` | Installs dependencies |
|
||||
| `npm run dev` | Starts local dev server at `localhost:4321` |
|
||||
| `npm run build` | Build your production site to `./dist/` |
|
||||
| `npm run preview` | Preview your build locally, before deploying |
|
||||
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||
| `npm run astro -- --help` | Get help using the Astro CLI |
|
||||
[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).
|
||||
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).
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
// @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({
|
||||
@@ -14,20 +15,29 @@ export default defineConfig({
|
||||
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',
|
||||
Hero: './src/components/Hero.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',
|
||||
@@ -46,6 +56,7 @@ export default defineConfig({
|
||||
label: 'Code Reference',
|
||||
items: [
|
||||
{ label: 'Architecture & Design', slug: 'code-reference/architecture' },
|
||||
{ label: 'Issue Triage Commands', slug: 'code-reference/issue-triage' },
|
||||
{ label: 'Tweaks Reference', items: [{ autogenerate: { directory: 'code-reference/tweaks' } }] },
|
||||
{ label: 'Features Reference', items: [{ autogenerate: { directory: 'code-reference/features' } }] },
|
||||
],
|
||||
@@ -54,10 +65,12 @@ export default defineConfig({
|
||||
label: 'Help',
|
||||
items: [
|
||||
{ label: 'FAQ', slug: 'faq' },
|
||||
{ label: 'Known Issues', slug: 'known-issues' },
|
||||
{ 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,16 @@
|
||||
services:
|
||||
winutil-astro:
|
||||
build: .
|
||||
ports:
|
||||
- "127.0.0.1:4321:4321"
|
||||
volumes:
|
||||
- .:/app
|
||||
- astro_node_modules:/app/node_modules
|
||||
tmpfs:
|
||||
- /app/.astro
|
||||
environment:
|
||||
- CHOKIDAR_USEPOLLING=true
|
||||
- ASTRO_TELEMETRY_DISABLED=1
|
||||
|
||||
volumes:
|
||||
astro_node_modules:
|
||||
@@ -13,7 +13,7 @@
|
||||
"@astrojs/starlight": "^0.41.5",
|
||||
"@fontsource-variable/jetbrains-mono": "^5.3.0",
|
||||
"@fontsource/geist-sans": "^5.3.0",
|
||||
"astro": "^7.0.2",
|
||||
"sharp": "^0.35.3"
|
||||
"astro": "^7.3.2",
|
||||
"sharp": "^0.35.4"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
User-agent: *
|
||||
Allow: /
|
||||
|
||||
Sitemap: https://winutil.christitus.com/sitemap-index.xml
|
||||
|
After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 173 KiB After Width: | Height: | Size: 171 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 96 KiB |
|
After Width: | Height: | Size: 193 KiB |
|
After Width: | Height: | Size: 193 KiB |
|
After Width: | Height: | Size: 193 KiB |
|
Before Width: | Height: | Size: 139 KiB |
|
Before Width: | Height: | Size: 139 KiB |
|
After Width: | Height: | Size: 193 KiB |
|
Before Width: | Height: | Size: 139 KiB |
|
Before Width: | Height: | Size: 139 KiB After Width: | Height: | Size: 193 KiB |
|
Before Width: | Height: | Size: 139 KiB After Width: | Height: | Size: 193 KiB |
|
After Width: | Height: | Size: 193 KiB |
|
After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 78 KiB |
@@ -12,11 +12,13 @@ const { icon, title } = Astro.props;
|
||||
---
|
||||
|
||||
<div class="wu-corner-card">
|
||||
{/* Corner brackets decoration. */}
|
||||
<span class="wu-corner-marks" aria-hidden="true">
|
||||
<span class="mark top-left" /><span class="mark top-right" /><span class="mark bottom-left" /><span
|
||||
class="mark bottom-right"
|
||||
/>
|
||||
</span>
|
||||
{/* Icon badge + heading + description. */}
|
||||
<div class="wu-corner-card-icon">
|
||||
<Icon name={icon} size="1.25rem" />
|
||||
</div>
|
||||
@@ -36,6 +38,7 @@ const { icon, title } = Astro.props;
|
||||
background-color: var(--sl-color-bg);
|
||||
}
|
||||
|
||||
/* Corner brackets decoration (four small L-shaped marks). */
|
||||
.wu-corner-marks {
|
||||
position: absolute;
|
||||
inset: 0;
|
||||
@@ -93,6 +96,7 @@ const { icon, title } = Astro.props;
|
||||
right: 0;
|
||||
}
|
||||
|
||||
/* Icon badge + heading + description. */
|
||||
.wu-corner-card-icon {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
|
||||
@@ -9,12 +9,14 @@ const year = new Date().getFullYear();
|
||||
---
|
||||
|
||||
<footer class="sl-flex">
|
||||
{/* Edit link + last-updated timestamp, and prev/next pagination. */}
|
||||
<div class="meta sl-flex">
|
||||
<EditLink />
|
||||
<LastUpdated />
|
||||
</div>
|
||||
<Pagination />
|
||||
|
||||
{/* "Built with Starlight" credit (only shown if Starlight's `credits` config is enabled). */}
|
||||
{
|
||||
config.credits && (
|
||||
<a class="kudos sl-flex" href="https://starlight.astro.build">
|
||||
@@ -23,11 +25,13 @@ const year = new Date().getFullYear();
|
||||
)
|
||||
}
|
||||
|
||||
{/* Copyright line. */}
|
||||
<div class="site-footer-copyright">© {year} <a href="https://christitus.com">Chris Titus Tech</a>. All rights reserved.</div>
|
||||
</footer>
|
||||
|
||||
<style>
|
||||
@layer starlight.core {
|
||||
/* Footer layout: stacked meta row + pagination. */
|
||||
footer {
|
||||
flex-direction: column;
|
||||
gap: 1.5rem;
|
||||
@@ -44,6 +48,7 @@ const year = new Date().getFullYear();
|
||||
margin-inline-start: auto;
|
||||
}
|
||||
|
||||
/* "Built with Starlight" credit link. */
|
||||
.kudos {
|
||||
align-items: center;
|
||||
gap: 0.5em;
|
||||
@@ -63,16 +68,14 @@ const year = new Date().getFullYear();
|
||||
}
|
||||
}
|
||||
|
||||
/* Collapse the meta/pagination rows entirely when they have nothing in them
|
||||
(e.g. editUrl: false and no prev/next), instead of leaving an empty gap. */
|
||||
/* Collapse the meta/pagination rows entirely when they have nothing in them (e.g. editUrl: false and no prev/next), instead of leaving an empty gap. */
|
||||
footer .meta:empty,
|
||||
footer :global(.pagination-links):empty {
|
||||
display: none;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
/* Site-wide copyright line, matching the previous Hugo docs site's footer.
|
||||
The divider above it comes from Starlight's own .content-panel border. */
|
||||
/* Site-wide copyright line, matching the previous Hugo docs site's footer. The divider above it comes from Starlight's own .content-panel border. */
|
||||
.site-footer-copyright {
|
||||
font-size: var(--sl-text-xs);
|
||||
color: var(--sl-color-gray-3);
|
||||
|
||||
@@ -6,40 +6,79 @@ import Search from 'virtual:starlight/components/Search';
|
||||
import SiteTitle from 'virtual:starlight/components/SiteTitle';
|
||||
import SocialIcons from 'virtual:starlight/components/SocialIcons';
|
||||
import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
|
||||
import { Icon } from '@astrojs/starlight/components';
|
||||
import { siteLinks } from '../site-links';
|
||||
|
||||
/**
|
||||
* Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
|
||||
*/
|
||||
// Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
|
||||
const shouldRenderSearch =
|
||||
config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
|
||||
|
||||
// Pages with a sidebar already have Starlight's own mobile menu toggle; only splash pages need this one.
|
||||
const { hasSidebar } = Astro.locals.starlightRoute;
|
||||
---
|
||||
|
||||
<div class="header">
|
||||
{/* Site title. */}
|
||||
<div class="title-wrapper sl-flex">
|
||||
<SiteTitle />
|
||||
</div>
|
||||
<div class="sl-flex print:hidden">
|
||||
{shouldRenderSearch && <Search />}
|
||||
<div class="mobile-actions sl-flex">
|
||||
{/* Search box. */}
|
||||
<div class="sl-flex print:hidden">
|
||||
{shouldRenderSearch && <Search />}
|
||||
</div>
|
||||
{
|
||||
!hasSidebar && (
|
||||
<div class="site-nav-toggle sl-flex md:sl-hidden print:hidden">
|
||||
<button type="button" aria-expanded="false" aria-controls="site-nav-panel" aria-label="Site navigation">
|
||||
<Icon name="bars" class="open-menu" />
|
||||
<Icon name="close" class="close-menu" />
|
||||
</button>
|
||||
<div id="site-nav-panel" class="site-nav-panel">
|
||||
<div class="site-nav-panel-group">
|
||||
<p class="site-nav-panel-heading">Documentation</p>
|
||||
<a href="/guides/">User Guides</a>
|
||||
<a href="/contributing/">Contribution Guides</a>
|
||||
<a href="/code-reference/architecture/">Code Reference</a>
|
||||
</div>
|
||||
<div class="site-nav-panel-group">
|
||||
<p class="site-nav-panel-heading">Help</p>
|
||||
<a href="/faq/">FAQ</a>
|
||||
<a href="/knownissues/">Known Issues</a>
|
||||
<a href={siteLinks.forums.href} target="_blank" rel="noreferrer">{siteLinks.forums.label}</a>
|
||||
</div>
|
||||
<a class="site-nav-panel-link" href={siteLinks.store.href} target="_blank" rel="noreferrer">{siteLinks.store.label}</a>
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
</div>
|
||||
{/* Right-side group: nav links, social icons, theme/language pickers. */}
|
||||
<div class="sl-hidden md:sl-flex print:hidden right-group">
|
||||
<nav class="site-nav" aria-label="Top">
|
||||
<a class="site-nav-link" href="/guides/">User Guides</a>
|
||||
{/* "Documentation" dropdown. */}
|
||||
<div class="site-nav-dropdown">
|
||||
<button type="button" class="site-nav-link" aria-haspopup="true">Documentation</button>
|
||||
<details name="site-nav-dropdown">
|
||||
<summary class="site-nav-link">Documentation</summary>
|
||||
</details>
|
||||
<div class="site-nav-menu">
|
||||
<a href="/guides/">User Guides</a>
|
||||
<a href="/contributing/">Contribution Guides</a>
|
||||
<a href="/code-reference/architecture/">Developer Docs</a>
|
||||
<a href="/code-reference/architecture/">Code Reference</a>
|
||||
</div>
|
||||
</div>
|
||||
{/* "Help" dropdown. */}
|
||||
<div class="site-nav-dropdown">
|
||||
<button type="button" class="site-nav-link" aria-haspopup="true">Help</button>
|
||||
<details name="site-nav-dropdown">
|
||||
<summary class="site-nav-link">Help</summary>
|
||||
</details>
|
||||
<div class="site-nav-menu">
|
||||
<a href="/faq/">FAQ</a>
|
||||
<a href="/known-issues/">Known Issues</a>
|
||||
<a href="https://forum.christitus.com/" target="_blank" rel="noreferrer">Forums</a>
|
||||
<a href="/knownissues/">Known Issues</a>
|
||||
<a href={siteLinks.forums.href} target="_blank" rel="noreferrer">{siteLinks.forums.label}</a>
|
||||
</div>
|
||||
</div>
|
||||
<a class="site-nav-link" href="https://christitus.com/downloads/" target="_blank" rel="noreferrer">Store</a>
|
||||
<a class="site-nav-link" href={siteLinks.store.href} target="_blank" rel="noreferrer">{siteLinks.store.label}</a>
|
||||
</nav>
|
||||
<div class="sl-flex social-icons">
|
||||
<SocialIcons />
|
||||
@@ -49,8 +88,28 @@ const shouldRenderSearch =
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
const toggle = document.querySelector<HTMLElement>('.site-nav-toggle');
|
||||
const btn = toggle?.querySelector('button');
|
||||
|
||||
if (toggle && btn) {
|
||||
const setExpanded = (expanded: boolean) => btn.setAttribute('aria-expanded', String(expanded));
|
||||
|
||||
btn.addEventListener('click', () => setExpanded(btn.getAttribute('aria-expanded') !== 'true'));
|
||||
toggle.addEventListener('keyup', (e) => {
|
||||
if (e.code === 'Escape') {
|
||||
setExpanded(false);
|
||||
btn.focus();
|
||||
}
|
||||
});
|
||||
// Collapse the panel if the viewport grows past the mobile breakpoint.
|
||||
matchMedia('(min-width: 50em)').addEventListener('change', () => setExpanded(false));
|
||||
}
|
||||
</script>
|
||||
|
||||
<style>
|
||||
@layer starlight.core {
|
||||
/* Header shell: title, search, right-side nav group. */
|
||||
.header {
|
||||
display: flex;
|
||||
gap: var(--sl-nav-gap);
|
||||
@@ -60,14 +119,19 @@ const shouldRenderSearch =
|
||||
}
|
||||
|
||||
.title-wrapper {
|
||||
/* Prevent long titles overflowing and covering the search and menu buttons on narrow viewports. */
|
||||
/* Clips long titles instead of overflowing onto the search/menu buttons; padding/negative margin avoids clipping the focus ring. */
|
||||
overflow: clip;
|
||||
/* Avoid clipping focus ring around title wrapper. */
|
||||
padding: 0.25rem;
|
||||
margin: -0.25rem;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.mobile-actions {
|
||||
align-items: center;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
/* Right-side group: nav + social icons, divided by a hairline. */
|
||||
.right-group,
|
||||
.social-icons {
|
||||
gap: 1rem;
|
||||
@@ -86,6 +150,7 @@ const shouldRenderSearch =
|
||||
:global(:root:not([data-has-toc])) {
|
||||
--__toc-width: 0rem;
|
||||
}
|
||||
/* Columns: site title */
|
||||
.header {
|
||||
--__sidebar-width: max(0rem, var(--sl-content-inline-start, 0rem) - var(--sl-nav-pad-x));
|
||||
--__main-column-fr: calc(
|
||||
@@ -97,21 +162,18 @@ const shouldRenderSearch =
|
||||
);
|
||||
display: grid;
|
||||
grid-template-columns:
|
||||
/* 1 (site title): runs up until the main content column’s left edge or the width of the title, whichever is the largest */
|
||||
minmax(
|
||||
calc(var(--__sidebar-width) + max(0rem, var(--__main-column-fr) - var(--sl-nav-gap))),
|
||||
auto
|
||||
)
|
||||
/* 2 (search box): all free space that is available. */
|
||||
1fr
|
||||
/* 3 (right items): use the space that these need. */
|
||||
auto;
|
||||
align-content: center;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/* Top nav links + dropdowns, matching the previous Hugo docs site's navbar. */
|
||||
/* Top nav links + dropdowns. */
|
||||
.site-nav {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
@@ -120,6 +182,7 @@ const shouldRenderSearch =
|
||||
border-inline-end: 1px solid var(--sl-color-hairline-light);
|
||||
}
|
||||
|
||||
/* Top nav trigger: shared style for plain links and dropdown triggers. */
|
||||
.site-nav-link {
|
||||
font-size: var(--sl-text-sm);
|
||||
font-weight: 500;
|
||||
@@ -136,13 +199,25 @@ const shouldRenderSearch =
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
|
||||
/* Extends the hoverable box down to the menu, closing the dead zone between trigger and menu. */
|
||||
.site-nav-dropdown {
|
||||
position: relative;
|
||||
/* Extends the dropdown's own hoverable box down to meet the menu, so the
|
||||
cursor never crosses a dead zone between the trigger and the menu. */
|
||||
padding-bottom: 0.75rem;
|
||||
margin-bottom: -0.75rem;
|
||||
}
|
||||
/* No box of its own; only the <summary> lays out. Its `open` state (no JS) is read by .site-nav-menu below. */
|
||||
.site-nav-dropdown > details {
|
||||
display: contents;
|
||||
}
|
||||
.site-nav-dropdown > details > summary {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
list-style: none;
|
||||
}
|
||||
.site-nav-dropdown > details > summary::-webkit-details-marker {
|
||||
display: none;
|
||||
}
|
||||
/* Dropdown menu panel: shown on hover (mouse) or when the sibling <details> is toggled open (touch/keyboard). */
|
||||
.site-nav-menu {
|
||||
display: none;
|
||||
position: absolute;
|
||||
@@ -160,7 +235,7 @@ const shouldRenderSearch =
|
||||
z-index: 10;
|
||||
}
|
||||
.site-nav-dropdown:hover .site-nav-menu,
|
||||
.site-nav-dropdown:focus-within .site-nav-menu {
|
||||
.site-nav-dropdown:has(details[open]) .site-nav-menu {
|
||||
display: flex;
|
||||
}
|
||||
.site-nav-menu a {
|
||||
@@ -175,4 +250,82 @@ const shouldRenderSearch =
|
||||
color: var(--sl-color-white);
|
||||
background: var(--sl-color-gray-6);
|
||||
}
|
||||
|
||||
/* Mobile equivalent of the site-nav, shown via a toggle button since the desktop nav is hidden below `md`. */
|
||||
.site-nav-toggle button {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 2.25rem;
|
||||
height: 2.25rem;
|
||||
border: 0;
|
||||
border-radius: var(--wu-radius-sm, 0.5rem);
|
||||
padding: 0;
|
||||
background: none;
|
||||
color: var(--sl-color-gray-2);
|
||||
cursor: pointer;
|
||||
}
|
||||
.site-nav-toggle button:hover {
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
.site-nav-toggle button svg {
|
||||
width: 1.25rem;
|
||||
height: 1.25rem;
|
||||
}
|
||||
.site-nav-toggle button[aria-expanded='true'] .open-menu,
|
||||
.site-nav-toggle button:not([aria-expanded='true']) .close-menu {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.site-nav-panel {
|
||||
display: none;
|
||||
position: fixed;
|
||||
inset-inline: 0;
|
||||
top: var(--sl-nav-height);
|
||||
z-index: var(--sl-z-index-menu);
|
||||
flex-direction: column;
|
||||
gap: 0.25rem;
|
||||
max-height: calc(100vh - var(--sl-nav-height));
|
||||
overflow-y: auto;
|
||||
padding: 1rem var(--sl-nav-pad-x) 1.5rem;
|
||||
background: var(--sl-color-bg-nav);
|
||||
border-bottom: 1px solid var(--sl-color-hairline-shade);
|
||||
}
|
||||
.site-nav-toggle button[aria-expanded='true'] ~ .site-nav-panel {
|
||||
display: flex;
|
||||
}
|
||||
.site-nav-panel-link {
|
||||
padding: 0.5rem 0.25rem;
|
||||
font-size: var(--sl-text-sm);
|
||||
font-weight: 500;
|
||||
color: var(--sl-color-gray-2);
|
||||
text-decoration: none;
|
||||
}
|
||||
.site-nav-panel-link:hover {
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
.site-nav-panel-group {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
border-top: 1px solid var(--sl-color-hairline-light);
|
||||
padding-top: 0.5rem;
|
||||
}
|
||||
.site-nav-panel-heading {
|
||||
margin: 0 0 0.25rem;
|
||||
padding: 0 0.25rem;
|
||||
font-size: var(--sl-text-xs);
|
||||
font-weight: 600;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.02em;
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.site-nav-panel-group a {
|
||||
padding: 0.5rem 0.25rem;
|
||||
font-size: var(--sl-text-sm);
|
||||
color: var(--sl-color-gray-2);
|
||||
text-decoration: none;
|
||||
}
|
||||
.site-nav-panel-group a:hover {
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -6,6 +6,7 @@ import { Icon } from '@astrojs/starlight/components';
|
||||
// Matches Starlight's internal PAGE_TITLE_ID (used by the skip-to-content link).
|
||||
const PAGE_TITLE_ID = '_top';
|
||||
|
||||
// Resolve hero content: Starlight's built-in hero fields plus our custom schema extensions.
|
||||
const { data } = Astro.locals.starlightRoute.entry;
|
||||
const { title = data.title, tagline, image, actions = [] } = data.hero || {};
|
||||
const { heroEyebrow, heroCaption, heroBadges = [] } = data;
|
||||
@@ -15,9 +16,11 @@ if (image && 'file' in image) heroImage = image.file;
|
||||
---
|
||||
|
||||
<section class="wu-hero">
|
||||
{/* Full-bleed grid/glow background layer. */}
|
||||
<div class="wu-hero-grid" aria-hidden="true"></div>
|
||||
<div class="wu-hero-glow" aria-hidden="true"></div>
|
||||
<div class="wu-hero-inner">
|
||||
{/* Copy column: eyebrow, heading, tagline, actions, caption. */}
|
||||
<div class="wu-hero-copy">
|
||||
{heroEyebrow && <p class="wu-eyebrow">{heroEyebrow}</p>}
|
||||
<h1 id={PAGE_TITLE_ID} data-page-title set:html={title} />
|
||||
@@ -42,6 +45,7 @@ if (image && 'file' in image) heroImage = image.file;
|
||||
}
|
||||
{heroCaption && <p class="wu-hero-caption">{heroCaption}</p>}
|
||||
</div>
|
||||
{/* Screenshot framed as a fake browser/app window. */}
|
||||
{
|
||||
heroImage && (
|
||||
<div class="wu-hero-media">
|
||||
@@ -66,6 +70,7 @@ if (image && 'file' in image) heroImage = image.file;
|
||||
)
|
||||
}
|
||||
</div>
|
||||
{/* Badge row (shields.io / dcbadge images) below the two-column layout. */}
|
||||
{
|
||||
heroBadges.length > 0 && (
|
||||
<div class="wu-hero-bottom">
|
||||
@@ -138,6 +143,7 @@ if (image && 'file' in image) heroImage = image.file;
|
||||
padding-block: 3rem 2rem;
|
||||
}
|
||||
|
||||
/* Hero copy: eyebrow, heading, tagline, actions, caption. */
|
||||
.wu-hero-copy {
|
||||
text-align: center;
|
||||
}
|
||||
@@ -198,6 +204,7 @@ if (image && 'file' in image) heroImage = image.file;
|
||||
box-shadow: 0 25px 50px -12px hsl(0 0% 0% / 0.5);
|
||||
}
|
||||
|
||||
/* Window chrome: title bar + traffic-light buttons. */
|
||||
.wu-window-bar {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
|
||||
@@ -5,10 +5,12 @@ import { Icon } from '@astrojs/starlight/components';
|
||||
|
||||
<script is:inline>
|
||||
window.StarlightThemeProvider = (() => {
|
||||
// Apply the resolved theme to <html> immediately, before paint, to avoid a flash of the wrong theme.
|
||||
const storedTheme =
|
||||
typeof localStorage !== 'undefined' && localStorage.getItem('starlight-theme');
|
||||
const theme = storedTheme || 'dark';
|
||||
document.documentElement.dataset.theme = theme === 'light' ? 'light' : 'dark';
|
||||
// Re-syncs each theme-select picker's icon + value after the visitor changes theme.
|
||||
return {
|
||||
updatePickers(theme = storedTheme || 'auto') {
|
||||
document.querySelectorAll('starlight-theme-select').forEach((picker) => {
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
// Responsive 16:9 YouTube embed using the privacy-enhanced (nocookie) domain.
|
||||
interface Props {
|
||||
id: string;
|
||||
title: string;
|
||||
}
|
||||
|
||||
const { id, title } = Astro.props;
|
||||
---
|
||||
|
||||
<div class="wu-video-embed not-content">
|
||||
<iframe
|
||||
src={`https://www.youtube-nocookie.com/embed/${id}`}
|
||||
title={title}
|
||||
loading="lazy"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
|
||||
allowfullscreen
|
||||
></iframe>
|
||||
</div>
|
||||
|
||||
<style>
|
||||
/* `not-content` on the wrapper opts it out of Starlight's markdown reset, which otherwise forces `iframe { height: auto }`. */
|
||||
.wu-video-embed {
|
||||
position: relative;
|
||||
width: 100%;
|
||||
aspect-ratio: 16 / 9;
|
||||
margin: 1.5rem 0;
|
||||
border: 1px solid var(--sl-color-hairline-light);
|
||||
background-color: var(--sl-color-black);
|
||||
}
|
||||
|
||||
.wu-video-embed iframe {
|
||||
position: absolute;
|
||||
inset: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
border: 0;
|
||||
}
|
||||
</style>
|
||||
@@ -79,14 +79,15 @@ winutil/
|
||||
**Why**: Makes distribution easier (single file) and improves load time.
|
||||
|
||||
#### 2. scripts/main.ps1
|
||||
**Purpose**: Entry point that initializes the GUI and event system.
|
||||
**Purpose**: Entry point that manages the run.
|
||||
|
||||
**Responsibilities**:
|
||||
- Load XAML and create WPF window
|
||||
- Initialize form elements
|
||||
- Set up event handlers
|
||||
- Load configurations
|
||||
- Display the GUI
|
||||
- Run the headless `-Preset` and `-Config` paths
|
||||
- Start the interface on a dedicated STA runspace and wait for it
|
||||
- Report anything the interface thread failed with, then clean up
|
||||
|
||||
The interface itself lives in `Start-WinUtilUserInterface`, not here. See [Threading Model](#threading-model).
|
||||
|
||||
#### 3. functions/public/
|
||||
**Purpose**: User-facing functions that implement main features.
|
||||
@@ -129,28 +130,36 @@ winutil/
|
||||
|
||||
## Win11 Creator Architecture
|
||||
|
||||
The **Win11 Creator** is a specialized subsystem within Winutil that creates customized Windows 11 ISOs. It operates independently from the main package installation and tweak system.
|
||||
The **Win11 Creator** is a specialized subsystem within Winutil that creates customized Windows 11 ISOs. It operates independently of the main package installation and tweak system.
|
||||
|
||||
### Win11 Creator Components
|
||||
|
||||
**Core Functions** (`functions/private/`):
|
||||
- `Invoke-WinUtilISO.ps1`: Main orchestrator containing all Win11 Creator functions
|
||||
- `Invoke-WinUtilISO.ps1`: Main orchestrator containing ISO workflow and helper functions
|
||||
- `Invoke-WinUtilISOBrowse`: ISO file selection dialog
|
||||
- `Invoke-WinUtilISOMountAndVerify`: Validates and mounts ISO, verifies it's official Windows 11
|
||||
- `Invoke-WinUtilISOMountAndVerify`: Validates and mounts ISO, verifies it is an official Windows 11 ISO
|
||||
- `Invoke-WinUtilISOModify`: Launches modification in background runspace
|
||||
- `Invoke-WinUtilISOExport`: Handles ISO and USB export
|
||||
- `Invoke-WinUtilISOExport`: Builds bootable ISO via `oscdimg.exe`
|
||||
- `Invoke-WinUtilISOCheckExistingWork`: Recovers incomplete work sessions
|
||||
- `Invoke-WinUtilISOCleanAndReset`: Cleans up temp directories and resets UI
|
||||
- `Write-WinUtilISOLog`: Posts log messages to UI status box and session log
|
||||
- `Set-WinUtilISOStep`: Controls wizard navigation state
|
||||
- `Get-WinUtilEditionIdFromName`: Maps edition display names to setup edition IDs
|
||||
- `Invoke-WinUtilRobocopy`: Copies files with exit code verification
|
||||
- `Find-WinUtilOscdimg` / `Get-WinUtilOscdimgPath`: Locates or installs `oscdimg.exe`
|
||||
|
||||
- `Invoke-WinUtilISOScript.ps1`: Applies modifications to mounted install.wim
|
||||
- Removes provisioned AppX packages (40+ bloatware apps)
|
||||
- Injects drivers (optional) from the current system
|
||||
- Removes OneDrive setup files
|
||||
- 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
|
||||
- `Invoke-WinUtilISOUSB.ps1`: USB drive detection and formatting
|
||||
- `Invoke-WinUtilISORefreshUSBDrives`: Enumerates USB drives
|
||||
- `Get-WinUtilFreeDriveLetter`: Finds available drive letters
|
||||
- `Invoke-WinUtilISOWriteUSB`: Formats USB drive as GPT/FAT32, splits WIM if needed, and copies files
|
||||
|
||||
- `Invoke-WinUtilISOScript.ps1`: Prepares setup media and customizations
|
||||
- Stages AppX removal (19 bloatware packages) into `autounattend.xml` for first logon
|
||||
- Applies 50+ registry tweaks during Windows Setup and first logon; removes scheduled tasks at first logon
|
||||
- Triggers OneDrive uninstall during first logon
|
||||
- Stages setup script fallbacks to `sources\$OEM$\$$\Setup\Scripts\`
|
||||
- Pins selected edition in `autounattend.xml` and writes `sources\ei.cfg`
|
||||
- Injects eligible current system drivers into WIM images if enabled (WIM mount is only used for driver servicing)
|
||||
|
||||
### Win11 Creator Data Flow
|
||||
|
||||
@@ -170,36 +179,38 @@ User optionally enables the Driver Injection checkbox
|
||||
↓
|
||||
Invoke-WinUtilISOModify (runs in background runspace)
|
||||
├─ Create work directory: ~WinUtil_Win11ISO_[timestamp]
|
||||
├─ Copy ISO contents to disk (~5-6 GB)
|
||||
├─ Mount install.wim at selected edition/index
|
||||
├─ Copy ISO contents to disk via robocopy (~5-6 GB)
|
||||
├─ Invoke-WinUtilISOScript:
|
||||
│ ├─ Remove 40+ bloat AppX packages
|
||||
│ ├─ Export and inject drivers (if enabled)
|
||||
│ ├─ Remove OneDrive setup
|
||||
│ ├─ Load offline registry hives
|
||||
│ ├─ Apply 50+ registry tweaks (hardware bypass, privacy, telemetry, OOBE, etc.)
|
||||
│ ├─ 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)
|
||||
│ ├─ Generate autounattend.xml with Windows PE and specialize safeguards
|
||||
│ ├─ Add first-logon script (19 AppX removals, registry tweaks, OneDrive uninstall)
|
||||
│ ├─ Pin selected edition index in autounattend.xml (/IMAGE/INDEX)
|
||||
│ ├─ Stage setup script fallbacks to sources\$OEM$\$$\Setup\Scripts\
|
||||
│ ├─ Write sources\ei.cfg and remove stale sources\PID.txt
|
||||
│ └─ If driver injection enabled:
|
||||
│ ├─ Require install.wim; install.esd cannot accept driver injection
|
||||
│ ├─ Export current system drivers via DISM
|
||||
│ ├─ Exclude stale duplicate packages
|
||||
│ ├─ Inject storage drivers into boot.wim index 2 and eligible drivers into install.wim
|
||||
│ └─ Validate WIM metadata before and after injection
|
||||
├─ 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 (2.5-3.5 GB)
|
||||
│ └─ Output: Win11_Modified_[date].iso (close to the source ISO size)
|
||||
│
|
||||
└─ Option 2: Write to USB
|
||||
├─ Format USB as GPT
|
||||
├─ Create 512 MB EFI partition
|
||||
├─ Copy modified ISO contents
|
||||
├─ Create single FAT32 partition (capped at 32 GB)
|
||||
├─ Split install.wim into .swm files if > 3.8 GB
|
||||
├─ Reject install.esd files of 4 GB or more
|
||||
├─ Copy files via robocopy
|
||||
└─ Output: Bootable USB (minimum 8 GB)
|
||||
↓
|
||||
Invoke-WinUtilISOCleanAndReset (optional)
|
||||
└─ Delete temp working directory (~10-15 GB)
|
||||
├─ Dismount any open WIM mounts with discard
|
||||
├─ Delete temp working directory (~10-15 GB)
|
||||
└─ Reset UI to initial state
|
||||
```
|
||||
|
||||
@@ -211,20 +222,30 @@ Invoke-WinUtilISOCleanAndReset (optional)
|
||||
- Checks image metadata for "Windows 11" string
|
||||
- Rejects custom, modified, or non-Windows 11 ISOs
|
||||
|
||||
**WIM Metadata Validation**:
|
||||
- During driver injection, `Assert-WinUtilISOWimMetadata` validates critical fields (`Languages`, `Installation`, `Edition`, `ProductSuite`, `ProductType`) before and after WIM servicing
|
||||
- Driver injection stops before export if the required metadata is missing or changes
|
||||
- Without driver injection, WinUtil preserves the original installation image and skips WIM metadata validation
|
||||
|
||||
**Edition Pinning & Setup Fallback**:
|
||||
- Writes `sources\ei.cfg` and removes `sources\PID.txt` so setup does not use mismatched OEM product keys
|
||||
- Pins the selected edition index in `autounattend.xml` (`/IMAGE/INDEX`)
|
||||
- Stages fallback setup scripts under `sources\$OEM$\$$\Setup\Scripts\` with `UseConfigurationSet` enabled
|
||||
|
||||
**Work Session Recovery**:
|
||||
- Auto-detects incomplete work from previous sessions
|
||||
- Allows resuming Step 4 (export) without re-running Steps 1-3
|
||||
- Allows resuming the export step without re-running selection and modification
|
||||
- Prevents redundant modifications
|
||||
|
||||
**Modification Safety**:
|
||||
- All registry changes are documented in a script (reversible)
|
||||
- Windows PE and specialize set hardware bypass and setup safeguards; `WinUtil-PostInstall.ps1` applies additional registry changes at first logon
|
||||
- Original ISO never modified; only working copy
|
||||
- Logged to `WinUtil_Win11ISO.log` for debugging
|
||||
- DISM handles image dismount with automatic cleanup on error
|
||||
- Logged to the WinUtil session log and the live UI status panel
|
||||
- DISM handles image dismount with automatic cleanup and discard on error
|
||||
|
||||
### Win11 Creator Registry Tweaks
|
||||
|
||||
The `Invoke-WinUtilISOScript` function applies **50+ offline registry tweaks**:
|
||||
The `Invoke-WinUtilISOScript` function applies **50+ registry tweaks** during setup and first logon:
|
||||
|
||||
**Hardware Bypass**:
|
||||
- TPM 2.0 check bypass
|
||||
@@ -262,9 +283,9 @@ The `Invoke-WinUtilISOScript` function applies **50+ offline registry tweaks**:
|
||||
|
||||
### Driver Injection Feature
|
||||
|
||||
**Optional Enhancement**: When enabled, exports all drivers from the running system and injects them into both:
|
||||
- `install.wim` (main OS image)
|
||||
- `boot.wim` index 2 (Windows Setup PE environment)
|
||||
**Optional Enhancement**: When enabled, exports all drivers from the running system and injects them into:
|
||||
- `install.wim` (main OS image), excluding stale duplicates
|
||||
- `boot.wim` index 2 (Windows Setup PE environment), storage controllers only (`SCSIAdapter` / `HDC`)
|
||||
|
||||
**Use Case**: Enables offline installation on systems with missing drivers.
|
||||
|
||||
@@ -272,7 +293,7 @@ The `Invoke-WinUtilISOScript` function applies **50+ offline registry tweaks**:
|
||||
|
||||
- **Temporary working directory**: ~10-15 GB
|
||||
- **Original ISO**: 4-6 GB
|
||||
- **Modified ISO**: 2.5-3.5 GB
|
||||
- **Modified ISO**: close to the source ISO size
|
||||
- **Total needed**: ~25 GB for safe operation
|
||||
|
||||
## Data Flow
|
||||
@@ -389,26 +410,73 @@ 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
|
||||
|
||||
## PowerShell Runspace
|
||||
## Threading Model
|
||||
|
||||
Winutil uses PowerShell runspaces for the GUI to remain responsive:
|
||||
WinUtil runs on three kinds of thread, and each has one job:
|
||||
|
||||
| Thread | Runspace | Responsibility |
|
||||
| --- | --- | --- |
|
||||
| Main | The one the script started in | Start the interface, wait for it, surface its errors, clean up |
|
||||
| Interface | `$sync.UIRunspace`, a dedicated STA runspace | Own the window. Paint and dispatch, nothing else |
|
||||
| Workers | `$sync.runspace`, a shared pool | Run everything long: installs, tweaks, features, AppX, Win11 Creator |
|
||||
|
||||
All three are created from the same starting point, `New-WinUtilSessionState`, which carries
|
||||
`$sync`, the compiled script's globals, and every WinUtil function. That is what lets any
|
||||
thread call any helper without the caller injecting function definitions.
|
||||
|
||||
```powershell
|
||||
# Create runspace
|
||||
$sync.runspace = [runspacefactory]::CreateRunspace()
|
||||
$sync.runspace.Open()
|
||||
$sync.runspace.SessionStateProxy.SetVariable("sync", $sync)
|
||||
# main.ps1 - the interface gets its own thread
|
||||
$sync.UIRunspace = [runspacefactory]::CreateRunspace($Host, (New-WinUtilSessionState))
|
||||
$sync.UIRunspace.ApartmentState = "STA"
|
||||
$sync.UIRunspace.Open()
|
||||
|
||||
# Run code in background
|
||||
$powershell = [powershell]::Create().AddScript($scriptblock)
|
||||
$powershell.Runspace = $sync.runspace
|
||||
$handle = $powershell.BeginInvoke()
|
||||
$uiShell = [powershell]::Create()
|
||||
$uiShell.Runspace = $sync.UIRunspace
|
||||
[void]$uiShell.AddScript({ Start-WinUtilUserInterface })
|
||||
$uiHandle = $uiShell.BeginInvoke()
|
||||
$uiHandle.AsyncWaitHandle.WaitOne()
|
||||
```
|
||||
|
||||
**Why**: Prevents UI freezing during long-running operations.
|
||||
**Why**: the window never blocks on work, and a failure on the interface thread is reported
|
||||
instead of disappearing.
|
||||
|
||||
## Long-Running Work
|
||||
|
||||
Every long action goes through `Start-WinUtilJob`, which owns everything a running operation
|
||||
needs: refusing to start while another job runs, the busy flag (`$sync.ActiveJob`), the progress
|
||||
bar and taskbar item, the boxed console banner, a start/finish/failure line in the log, and
|
||||
restoring the interface in a `finally` whatever happens.
|
||||
|
||||
`Invoke-WPFButton` decides what counts as a long action. Anything that changes the system gets a
|
||||
job; anything that only changes what the interface is showing runs on the interface thread.
|
||||
That single classification is why no workflow arranges its own progress, banner or busy state.
|
||||
|
||||
```powershell
|
||||
Start-WinUtilJob -Name "Features" -Description "Installing Windows Features" -Parameters @{
|
||||
Features = @($sync.selectedFeatures)
|
||||
} -ScriptBlock {
|
||||
param($Features)
|
||||
|
||||
$total = @($Features).Count
|
||||
$completed = 0
|
||||
foreach ($feature in $Features) {
|
||||
$completed++
|
||||
Step-WinUtilJob -Status "Installing $feature ($completed/$total)" -Percent ([int](($completed / $total) * 100))
|
||||
Invoke-WinUtilFeatureInstall $feature
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The body only has to do the work and call `Step-WinUtilJob`. Anything it throws is
|
||||
caught, logged, and shown on the taskbar as a failure.
|
||||
|
||||
**Values, not closures**: the body is rebuilt inside the worker from its text, so it receives
|
||||
what it needs through `-Parameters` rather than capturing the caller's variables.
|
||||
|
||||
## WPF Event Handling
|
||||
|
||||
@@ -454,23 +522,21 @@ if (!(Get-Command choco -ErrorAction SilentlyContinue)) {
|
||||
choco install $app.choco -y
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
## Error Handling And Logging
|
||||
|
||||
Winutil uses PowerShell error handling:
|
||||
A job body does not need its own error handling. `Start-WinUtilJob` catches whatever the body
|
||||
throws, logs it, and marks the run as failed on the taskbar, so a failure can never leave the
|
||||
interface stuck busy. Only catch inside a body when you have something specific to do first,
|
||||
such as cleaning up a mounted image, and then rethrow.
|
||||
|
||||
```powershell
|
||||
try {
|
||||
# Attempt operation
|
||||
Invoke-SomeOperation
|
||||
}
|
||||
catch {
|
||||
Write-Host "Error: $_" -ForegroundColor Red
|
||||
# Log error
|
||||
Add-Content -Path $logfile -Value "ERROR: $_"
|
||||
}
|
||||
Write-WinUtilLog -Level "ERROR" -Component "Install" -Message "winget install failed: $($_.Exception.Message)"
|
||||
```
|
||||
|
||||
**Logging**: Errors and operations are logged for debugging.
|
||||
Entries and console diagnostics go to the same
|
||||
`%LocalAppData%\winutil\logs\winutil_<timestamp>.log` session file. While `Start-Transcript`
|
||||
owns that file, `Write-WinUtilLog` writes through the host so the transcript captures the entry
|
||||
without a competing direct file write.
|
||||
|
||||
## Configuration Loading
|
||||
|
||||
@@ -488,15 +554,23 @@ $sync.configs.features = Get-Content "config/feature.json" | ConvertFrom-Json
|
||||
|
||||
## UI Update Pattern
|
||||
|
||||
UI updates must happen on the UI thread:
|
||||
Controls may only be touched from the thread that owns the window, so background work reaches
|
||||
them through `Invoke-WPFUIThread`:
|
||||
|
||||
```powershell
|
||||
$sync.form.Dispatcher.Invoke([action]{
|
||||
$sync.WPFStatusLabel.Content = "Installing..."
|
||||
}, "Normal")
|
||||
Invoke-WPFUIThread -Parameters @{ Count = $installed.Count } -ScriptBlock {
|
||||
param($Count)
|
||||
$sync.WPFselectedAppsButton.Content = "Selected Apps: $Count"
|
||||
}
|
||||
```
|
||||
|
||||
**Why**: WPF requires UI updates on the main thread.
|
||||
Add `-Async` to post the update instead of waiting for it. `Step-WinUtilJob` and the
|
||||
Win11 Creator status log use that so a per-item update never stalls the worker.
|
||||
|
||||
**Values, not closures**: the body is rebuilt inside the interface runspace, so it takes what it
|
||||
needs through `-Parameters`. Handing over a scriptblock from a worker instead would keep that
|
||||
worker's session state, which loses the caller's variables on an async post and costs roughly
|
||||
twenty times as much per command - enough to turn a checkbox refresh into a visible freeze.
|
||||
|
||||
## Adding New Features
|
||||
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Legacy F8 Boot Recovery - Disable"
|
||||
description: "Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Legacy F8 Boot Recovery - Enable"
|
||||
description: "Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Registry Backup (Daily Task 12:30am) - Enable"
|
||||
description: "Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Hyper-V - Enable"
|
||||
description: "Hyper-V is a hardware virtualization product developed by Microsoft that allows users to create and manage virtual machines."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Legacy Media Components (WMP, DirectPlay) - Enable"
|
||||
description: "Enables legacy programs from previous versions of Windows."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Network File System (NFS) - Enable"
|
||||
description: "Network File System (NFS) is a mechanism for storing files on a network."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,15 +1,17 @@
|
||||
---
|
||||
title: "AutoLogon - Run"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/public/Invoke-WPFPanelAutologin.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFPanelAutologin.ps1). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
This page is generated from [`functions/public/Invoke-WPFPanelAutologin.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFPanelAutologin.ps1). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```powershell title="functions/public/Invoke-WPFPanelAutologin.ps1"
|
||||
function Invoke-WPFPanelAutologin {
|
||||
Invoke-WebRequest -Uri https://live.sysinternals.com/Autologon.exe -OutFile "$winutildir\autologin.exe"
|
||||
Start-Process -FilePath "$winutildir\autologin.exe" -ArgumentList /accepteula
|
||||
$autologonPath = Join-Path $sync.winutildir "autologin.exe"
|
||||
Invoke-WebRequest -Uri https://live.sysinternals.com/Autologon.exe -OutFile $autologonPath
|
||||
Start-Process -FilePath $autologonPath -ArgumentList /accepteula
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
@@ -20,11 +21,54 @@ function Invoke-WPFSystemRepair {
|
||||
3. DISM - Repair a corrupted Windows operating system image
|
||||
#>
|
||||
|
||||
Start-Process cmd.exe -ArgumentList "/c chkdsk /scan /perf" -NoNewWindow -Wait
|
||||
Start-Process cmd.exe -ArgumentList "/c sfc /scannow" -NoNewWindow -Wait
|
||||
Start-Process cmd.exe -ArgumentList "/c dism /online /cleanup-image /restorehealth" -NoNewWindow -Wait
|
||||
# SuccessCodes maps the non-zero exits a step treats as success to what they mean. The codes
|
||||
# are per step because the same number means different things: 1 and 2 are ordinary chkdsk
|
||||
# outcomes, while 1 from sfc is a failure, and 3010 is a repaired image from DISM only.
|
||||
$steps = @(
|
||||
@{
|
||||
Label = "Checking the disk for errors"
|
||||
Arguments = "/c chkdsk /scan /perf"
|
||||
# 3 is left out: the disk could not be checked, or has errors an online scan cannot
|
||||
# fix, and the steps after this one are not worth running on a disk in that state.
|
||||
SuccessCodes = @{
|
||||
1 = "errors were found and fixed"
|
||||
2 = "cleanup was performed, or was skipped because /f was not given"
|
||||
}
|
||||
},
|
||||
@{
|
||||
Label = "Scanning protected system files"
|
||||
Arguments = "/c sfc /scannow"
|
||||
SuccessCodes = @{}
|
||||
},
|
||||
@{
|
||||
Label = "Repairing the Windows image"
|
||||
Arguments = "/c dism /online /cleanup-image /restorehealth"
|
||||
SuccessCodes = @{
|
||||
3010 = "a restart is needed for the repair to take effect"
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
Write-Host "==> Finished System Repair"
|
||||
Set-WinUtilTaskbaritem -state "None" -overlay "checkmark"
|
||||
$completed = 0
|
||||
foreach ($step in $steps) {
|
||||
Step-WinUtilJob -Status "$($step.Label) ($($completed + 1)/$($steps.Count))" -Percent ([int](($completed / $steps.Count) * 100))
|
||||
Write-WinUtilLog -Component "SystemRepair" -Message $step.Label
|
||||
# Start-Process does not throw on a nonzero exit, so without this a failed chkdsk, sfc
|
||||
# or dism run would still be reported as a completed repair
|
||||
$process = Start-Process cmd.exe -ArgumentList $step.Arguments -NoNewWindow -Wait -PassThru
|
||||
$exitCode = $process.ExitCode
|
||||
|
||||
if ($exitCode -ne 0) {
|
||||
if ($step.SuccessCodes.ContainsKey($exitCode)) {
|
||||
# Start-WinUtilJob records WarningRecord output in both the session log and the
|
||||
# job result, so accepted nonzero outcomes cannot finish with a green checkmark.
|
||||
Write-Warning "$($step.Label) finished: $($step.SuccessCodes[$exitCode])."
|
||||
} else {
|
||||
throw "$($step.Label) failed with exit code $exitCode."
|
||||
}
|
||||
}
|
||||
|
||||
$completed++
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/public/Invoke-WPFFixesNTPPool.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesNTPPool.ps1). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
@@ -24,8 +25,5 @@ function Invoke-WPFFixesNTPPool {
|
||||
Restart-Service w32time
|
||||
w32tm /resync
|
||||
|
||||
Write-Host "================================="
|
||||
Write-Host "-- NTP Configuration Complete ---"
|
||||
Write-Host "================================="
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Network - Reset"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/public/Invoke-WPFFixesNetwork.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesNetwork.ps1). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
This page is generated from [`functions/public/Invoke-WPFFixesNetwork.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesNetwork.ps1). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```powershell title="functions/public/Invoke-WPFFixesNetwork.ps1"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
@@ -40,7 +41,7 @@ function Invoke-WPFFixesUpdate {
|
||||
param($Aggressive = $false)
|
||||
|
||||
Write-Progress -Id 0 -Activity "Repairing Windows Update" -PercentComplete 0
|
||||
Set-WinUtilTaskbaritem -state "Indeterminate" -overlay "logo"
|
||||
Step-WinUtilJob -State "Indeterminate"
|
||||
Write-Host "Starting Windows Update Repair..."
|
||||
# Wait for the first progress bar to show, otherwise the second one won't show
|
||||
Start-Sleep -Milliseconds 200
|
||||
@@ -124,9 +125,9 @@ function Invoke-WPFFixesUpdate {
|
||||
if (Test-Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate") {
|
||||
Write-Progress -Id 0 -Activity "Repairing Windows Update" -Status "Removing WSUS client settings..." -PercentComplete 60
|
||||
Write-Progress -Id 6 -ParentId 0 -Activity "Removing WSUS client settings" -PercentComplete 0
|
||||
Start-Process -NoNewWindow -FilePath "REG" -ArgumentList "DELETE", "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate", "/v", "AccountDomainSid", "/f" -RedirectStandardError "NUL"
|
||||
Start-Process -NoNewWindow -FilePath "REG" -ArgumentList "DELETE", "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate", "/v", "PingID", "/f" -RedirectStandardError "NUL"
|
||||
Start-Process -NoNewWindow -FilePath "REG" -ArgumentList "DELETE", "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate", "/v", "SusClientId", "/f" -RedirectStandardError "NUL"
|
||||
Remove-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate" -Name "AccountDomainSid" -ErrorAction SilentlyContinue
|
||||
Remove-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate" -Name "PingID" -ErrorAction SilentlyContinue
|
||||
Remove-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate" -Name "SusClientId" -ErrorAction SilentlyContinue
|
||||
Write-Progress -Id 6 -ParentId 0 -Activity "Removing WSUS client settings" -Status "Completed" -PercentComplete 100
|
||||
}
|
||||
|
||||
@@ -202,24 +203,14 @@ function Invoke-WPFFixesUpdate {
|
||||
try {
|
||||
(New-Object -ComObject Microsoft.Update.AutoUpdate).DetectNow()
|
||||
} catch {
|
||||
Set-WinUtilTaskbaritem -state "Error" -overlay "warning"
|
||||
Write-WinUtilLog -Level "ERROR" -Component "Updates" -Message "Failed to create Windows Update COM object: $_"
|
||||
Write-Warning "Failed to create Windows Update COM object: $_"
|
||||
}
|
||||
Start-Process -NoNewWindow -FilePath "wuauclt" -ArgumentList "/resetauthorization", "/detectnow"
|
||||
Write-Progress -Id 10 -ParentId 0 -Activity "Forcing discovery" -Status "Completed" -PercentComplete 100
|
||||
Write-Progress -Id 0 -Activity "Repairing Windows Update" -Status "Completed" -PercentComplete 100
|
||||
|
||||
Set-WinUtilTaskbaritem -state "None" -overlay "checkmark"
|
||||
|
||||
$ButtonType = [System.Windows.MessageBoxButton]::OK
|
||||
$MessageboxTitle = "Reset Windows Update "
|
||||
$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 "-- Reset All Windows Update Settings to Stock -"
|
||||
Write-Host "==============================================="
|
||||
Show-WinUtilMessage -Message "Stock settings loaded.`n Please reboot your computer" -Title "Reset Windows Update" -Button "OK" -Icon "Information" | Out-Null
|
||||
|
||||
# Remove the progress bars
|
||||
Write-Progress -Id 0 -Activity "Repairing Windows Update" -Completed
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
@@ -17,18 +18,8 @@ function Invoke-WPFFixesWinget {
|
||||
.DESCRIPTION
|
||||
BravoNorris for the fantastic idea of a button to reinstall WinGet
|
||||
#>
|
||||
# Install Choco if not already present
|
||||
try {
|
||||
Set-WinUtilTaskbaritem -state "Indeterminate" -overlay "logo"
|
||||
Write-Host "==> Starting WinGet Repair"
|
||||
Install-WinUtilWinget
|
||||
} catch {
|
||||
Write-Error "Failed to install WinGet: $_"
|
||||
Set-WinUtilTaskbaritem -state "Error" -overlay "warning"
|
||||
} finally {
|
||||
Write-Host "==> Finished WinGet Repair"
|
||||
Set-WinUtilTaskbaritem -state "None" -overlay "checkmark"
|
||||
}
|
||||
|
||||
Step-WinUtilJob -Status "Repairing WinGet" -State "Indeterminate"
|
||||
Install-WinUtilWinget -Force
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Windows Defender Firewall"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Mouse Properties"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Programs and Features"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Region"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Security and Maintenance"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,26 +1,80 @@
|
||||
---
|
||||
title: "CTT PowerShell Profile - Install"
|
||||
description: ""
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`functions/private/Invoke-WinUtilInstallPSProfile.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/private/Invoke-WinUtilInstallPSProfile.ps1). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
This page is generated from [`functions/private/Invoke-WinUtilInstallPSProfile.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/private/Invoke-WinUtilInstallPSProfile.ps1). Do not edit this page directly.
|
||||
:::
|
||||
|
||||
```powershell title="functions/private/Invoke-WinUtilInstallPSProfile.ps1"
|
||||
function Get-WinUtilPowerShell7Path {
|
||||
$command = Get-Command pwsh -CommandType Application -ErrorAction SilentlyContinue
|
||||
if ($command) { return $command.Source }
|
||||
|
||||
foreach ($candidate in @(
|
||||
"$env:ProgramFiles\PowerShell\7\pwsh.exe",
|
||||
"$env:LOCALAPPDATA\Microsoft\WindowsApps\pwsh.exe")) {
|
||||
if (Test-Path -LiteralPath $candidate) { return $candidate }
|
||||
}
|
||||
|
||||
return $null
|
||||
}
|
||||
|
||||
function Invoke-WinUtilInstallPSProfile {
|
||||
if (-not (Get-Command wt)) {
|
||||
Write-Host "Windows Terminal not found. Installing..."
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Installs the CTT PowerShell profile
|
||||
|
||||
.DESCRIPTION
|
||||
The profile targets PowerShell 7, so its setup script has to run under pwsh rather than
|
||||
the runspace this job is on. It runs as a child process with its output captured, so the
|
||||
job log records what happened instead of it scrolling past in a terminal nobody kept.
|
||||
#>
|
||||
|
||||
$pwshPath = Get-WinUtilPowerShell7Path
|
||||
if (-not $pwshPath) {
|
||||
Step-WinUtilJob -Status "Installing PowerShell 7" -State "Indeterminate"
|
||||
Write-WinUtilLog -Component "Feature" -Message "PowerShell 7 not found, installing it first."
|
||||
|
||||
Install-WinUtilWinget
|
||||
winget install Microsoft.WindowsTerminal --source winget --silent
|
||||
Install-WinUtilProgramWinget -Action Install -Programs @("Microsoft.PowerShell") | Out-Null
|
||||
|
||||
# WinGet updates the persisted PATH, not this already-running process. Resolve the
|
||||
# standard install locations as well as the current PATH before deciding it failed.
|
||||
$pwshPath = Get-WinUtilPowerShell7Path
|
||||
if (-not $pwshPath) {
|
||||
throw "PowerShell 7 could not be installed, so the profile cannot be set up."
|
||||
}
|
||||
}
|
||||
|
||||
if (-not (Get-Command pwsh)) {
|
||||
Write-Host "PowerShell 7 not found. Installing..."
|
||||
Install-WinUtilWinget
|
||||
winget install Microsoft.PowerShell --source winget --installer-type wix --silent
|
||||
Step-WinUtilJob -Status "Running the profile setup" -State "Indeterminate"
|
||||
|
||||
$setupUrl = "https://github.com/ChrisTitusTech/powershell-profile/raw/main/setup.ps1"
|
||||
# Stop in the child, so a setup failure is a nonzero exit rather than a logged error and a
|
||||
# exit code of zero
|
||||
$output = & $pwshPath -NoProfile -NonInteractive -Command "`$ErrorActionPreference = 'Stop'; irm '$setupUrl' | iex" 2>&1
|
||||
$exitCode = $LASTEXITCODE
|
||||
|
||||
$failures = 0
|
||||
foreach ($line in @($output)) {
|
||||
if ($line -is [System.Management.Automation.ErrorRecord]) {
|
||||
$failures++
|
||||
Write-WinUtilErrorRecord -ErrorRecord $line -Component "Feature" -Context "PowerShell profile setup"
|
||||
} elseif (-not [string]::IsNullOrWhiteSpace($line)) {
|
||||
Write-WinUtilLog -Component "Feature" -Message ([string]$line).Trim()
|
||||
}
|
||||
}
|
||||
|
||||
wt new-tab pwsh -NoExit -Command "irm https://github.com/ChrisTitusTech/powershell-profile/raw/main/setup.ps1 | iex"
|
||||
if ($exitCode -ne 0) {
|
||||
throw "The profile setup script exited with code $exitCode."
|
||||
}
|
||||
|
||||
if ($failures -gt 0) {
|
||||
throw "The profile setup script reported $failures error(s); see the log."
|
||||
}
|
||||
|
||||
Write-WinUtilLog -Component "Feature" -Message "CTT PowerShell profile installed. Open a new PowerShell 7 session to use it."
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,21 +1,48 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
function Invoke-WinUtilUninstallPSProfile {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Restores the PowerShell 7 profile the CTT profile replaced
|
||||
|
||||
if (Test-Path ($Profile + ".bak")) {
|
||||
Move-Item -Path ($Profile + ".bak") -Destination $Profile
|
||||
} else {
|
||||
Remove-Item -Path $Profile
|
||||
.DESCRIPTION
|
||||
The profile path has to come from pwsh itself. $PROFILE inside this job is the worker's
|
||||
own Windows PowerShell profile, which is not the file the install wrote.
|
||||
#>
|
||||
|
||||
$pwshPath = Get-WinUtilPowerShell7Path
|
||||
if (-not $pwshPath) {
|
||||
throw "PowerShell 7 is not installed, so there is no CTT profile to remove."
|
||||
}
|
||||
|
||||
Write-Host "Successfully uninstalled CTT PowerShell Profile." -ForegroundColor Green
|
||||
$profilePath = (& $pwshPath -NoProfile -NonInteractive -Command '$PROFILE' | Select-Object -First 1)
|
||||
if ([string]::IsNullOrWhiteSpace($profilePath)) {
|
||||
throw "Could not determine the PowerShell 7 profile path."
|
||||
}
|
||||
$profilePath = $profilePath.Trim()
|
||||
$backupPath = "$profilePath.bak"
|
||||
|
||||
if (Test-Path $backupPath) {
|
||||
Move-Item -Path $backupPath -Destination $profilePath -Force
|
||||
Write-WinUtilLog -Component "Feature" -Message "Restored the profile that was in place before: $profilePath"
|
||||
return
|
||||
}
|
||||
|
||||
if (Test-Path $profilePath) {
|
||||
Remove-Item -Path $profilePath -Force
|
||||
Write-WinUtilLog -Component "Feature" -Message "Removed the CTT PowerShell profile: $profilePath"
|
||||
return
|
||||
}
|
||||
|
||||
Write-WinUtilLog -Level "WARN" -Component "Feature" -Message "No PowerShell 7 profile found at $profilePath, nothing to remove."
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
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). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
@@ -12,17 +13,10 @@ function Invoke-WPFSSHServer {
|
||||
<#
|
||||
|
||||
.SYNOPSIS
|
||||
Invokes the OpenSSH Server install in a runspace
|
||||
Installs and starts the OpenSSH Server
|
||||
|
||||
#>
|
||||
|
||||
Invoke-WPFRunspace -ScriptBlock {
|
||||
|
||||
Invoke-WinUtilSSHServer
|
||||
|
||||
Write-Host "======================================="
|
||||
Write-Host "-- OpenSSH Server installed! ---"
|
||||
Write-Host "======================================="
|
||||
}
|
||||
Invoke-WinUtilSSHServer
|
||||
}
|
||||
```
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: Issue Triage Commands
|
||||
description: Commands trusted maintainers can use to label and close GitHub issues.
|
||||
---
|
||||
|
||||
Trusted repository members whose numeric GitHub user IDs are listed in the issue triage workflow can run the commands below. These commands work only on issues. Comments on pull requests are ignored, and the workflow token has no pull-request write permission.
|
||||
|
||||
## Commands
|
||||
|
||||
- `/triage` adds the `needs-triage` label.
|
||||
- `/triageoff` removes the `needs-triage` label when it is present.
|
||||
- `/np` closes the issue as not planned.
|
||||
- `/np wontfix` adds the `wontfix` label without replacing existing labels, then closes the issue as not planned.
|
||||
- `/np notrelated` adds the `not-related` label without replacing existing labels, then closes the issue as not planned.
|
||||
- `/np <reason>` closes the issue as not planned without adding a label for unrecognized reasons.
|
||||
- `/duplicate <issue number>` closes the issue as a duplicate of another issue. The positive issue number may optionally start with `#`; pull request numbers are rejected.
|
||||
|
||||
## Command handling
|
||||
|
||||
Put exactly one command in the comment. Leading and trailing whitespace is allowed, but text before or after the command is not. Command matching is case-insensitive, and malformed issue numbers are rejected.
|
||||
|
||||
After a command is handled, the workflow deletes the command comment and leaves an audit comment describing the result. A missing duplicate target or a request to duplicate an issue into itself is reported without closing the issue. Unexpected GitHub API failures stop the workflow and leave the command comment available for retry.
|
||||
|
||||
## Access
|
||||
|
||||
Access is granted by adding the trusted member's immutable numeric GitHub user ID to `.github/workflows/triage-tools.yaml` through a pull request. Abuse can result in removal from the allowlist or other repository moderation action.
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "System Tray Battery Percentage"
|
||||
description: "Shows numeric battery percentage next to the battery icon in the system tray."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Start Menu Bing Search"
|
||||
description: "Toggles Bing web search results in Windows Search."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Dark Theme for Windows"
|
||||
description: "Dark Mode for the system and applications."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "BSoD Verbose Mode"
|
||||
description: "Gives more information when you blue screen."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,14 +1,15 @@
|
||||
---
|
||||
title: "Lock Screen - Disable"
|
||||
description: "Skips the lock screen entirely and goes directly to the sign-in screen on boot and wake."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
"WPFTweaksDisableLockscreen": {
|
||||
"WPFToggleDisableLockscreen": {
|
||||
"Content": "Lock Screen - Disable",
|
||||
"Description": "Skips the lock screen entirely and goes directly to the sign-in screen on boot and wake.",
|
||||
"category": "Customize Preferences",
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Game Mode"
|
||||
description: "Toggles Windows prioritizes gaming performance by allocating system resources to games."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "File Explorer Hidden Files"
|
||||
description: "Reveals hidden files in Explorer."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Settings Home Page"
|
||||
description: "Toggles the Home Page in the Windows Settings app."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Logon Screen Acrylic Blur"
|
||||
description: "Toggles the acrylic blur effect on login screen background."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Enable Long Paths"
|
||||
description: "Toggles support for file paths longer than 260 characters in Explorer."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: "Mouse Acceleration"
|
||||
description: "Makes it so Cursor movement is affected by the speed of your physical mouse movements."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
|
||||
@@ -1,35 +1,48 @@
|
||||
---
|
||||
title: "Multiplane Overlay"
|
||||
description: "Multiplane Overlay compose multiple image layers, which can sometimes cause issues with graphics cards."
|
||||
description: "Multiplane Overlay composes multiple image layers, which can sometimes cause issues with graphics cards. Changes to this preference are applied immediately."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
"WPFToggleMultiplaneOverlay": {
|
||||
"WPFMultiplaneOverlay": {
|
||||
"Content": "Multiplane Overlay",
|
||||
"Description": "Multiplane Overlay compose multiple image layers, which can sometimes cause issues with graphics cards.",
|
||||
"Description": "Multiplane Overlay composes multiple image layers, which can sometimes cause issues with graphics cards. Changes to this preference are applied immediately.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
"Type": "Combobox",
|
||||
"ComboItems": "Enabled|Disabled (Compatibility)|Fully Disabled",
|
||||
"ComboDescriptions": {
|
||||
"Enabled": "Uses Windows' default overlay behavior.",
|
||||
"Disabled (Compatibility)": "Disables MPO using OverlayTestMode=5, the less aggressive compatibility method.",
|
||||
"Fully Disabled": "Disables MPO using OverlayTestMode=5 and DisableOverlays=1, the more aggressive method."
|
||||
},
|
||||
"registry": [
|
||||
{
|
||||
"Path": "HKLM:\\SOFTWARE\\Microsoft\\Windows\\Dwm",
|
||||
"Name": "OverlayTestMode",
|
||||
"Value": "0",
|
||||
"Type": "DWord",
|
||||
"OriginalValue": "5",
|
||||
"DefaultState": "true"
|
||||
"DefaultValue": "0",
|
||||
"Values": {
|
||||
"Enabled": "<RemoveEntry>",
|
||||
"Disabled (Compatibility)": "5",
|
||||
"Fully Disabled": "5"
|
||||
}
|
||||
},
|
||||
{
|
||||
"Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Control\\GraphicsDrivers",
|
||||
"Name": "DisableOverlays",
|
||||
"Value": "0",
|
||||
"Type": "DWord",
|
||||
"OriginalValue": "1",
|
||||
"DefaultState": "true"
|
||||
"DefaultValue": "0",
|
||||
"Values": {
|
||||
"Enabled": "<RemoveEntry>",
|
||||
"Disabled (Compatibility)": "<RemoveEntry>",
|
||||
"Fully Disabled": "1"
|
||||
}
|
||||
}
|
||||
],
|
||||
}
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
---
|
||||
title: "Microsoft Outlook New Version"
|
||||
description: "This will ensures the classic Outlook application is used."
|
||||
description: "This will ensure the new Outlook application is used."
|
||||
editUrl: false
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly.
|
||||
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"
|
||||
"WPFToggleNewOutlook": {
|
||||
"Content": "Microsoft Outlook New Version",
|
||||
"Description": "This will ensures the classic Outlook application is used.",
|
||||
"Description": "This will ensure the new Outlook application is used.",
|
||||
"category": "Customize Preferences",
|
||||
"panel": "2",
|
||||
"Type": "Toggle",
|
||||
|
||||