|
1 | | -<div align="center"> |
2 | | - |
3 | | -# ThreadPilot ✈️ |
4 | | - |
5 | | -**A free and open-source Windows process and power plan manager for deterministic performance workflows.** |
6 | | - |
7 | | -[](https://github.com/PrimeBuild-pc/ThreadPilot/actions/workflows/ci-devsecops.yml) |
8 | | -[](https://github.com/PrimeBuild-pc/ThreadPilot/releases) |
9 | | -[](https://github.com/microsoft/winget-pkgs/tree/master/manifests/p/PrimeBuild/ThreadPilot) |
10 | | -[](https://www.microsoft.com/windows) |
11 | | -[](https://dotnet.microsoft.com/) |
12 | | -[](LICENSE) |
13 | | -[](https://github.com/PrimeBuild-pc/ThreadPilot/issues) |
14 | | -[](https://github.com/PrimeBuild-pc/ThreadPilot/discussions) |
15 | | - |
16 | | -[Install](#-install) • [Features](#-features) • [Screenshots](#-screenshots) • [Build](#-build-from-source) • [Support](#-support-the-project) |
17 | | - |
18 | | -</div> |
19 | | - |
20 | | -<img width="1672" height="941" alt="cover" src="https://github.com/user-attachments/assets/858ec350-b997-4683-9df1-cc196307ede8" /> |
21 | | - |
22 | | -## What is ThreadPilot? |
23 | | - |
24 | | -ThreadPilot is a modern Windows desktop application for users who want predictable control over process behavior, CPU affinity, priority, power plans, and rule-driven performance workflows. |
25 | | - |
26 | | -It is designed as an open-source alternative for power users who need Process Lasso-style capabilities, automation support, system tray controls, and a Windows 11-first experience. |
27 | | - |
28 | | -## ✨ Features |
29 | | - |
30 | | -- Live process management with refresh, filtering, and high-volume process handling. |
31 | | -- CPU affinity and priority controls with topology-aware logic. |
32 | | -- I/O and scheduler-related tuning utilities. |
33 | | -- Rule-based automation for power plan switching when selected processes start or stop. |
34 | | -- Conditional profiles, tray controls, Live Metrics, and dashboard views. |
35 | | -- Administrator-aware Windows desktop workflow. |
36 | | -- CI-backed release artifacts and package-manager distribution. |
37 | | - |
38 | | -## 📦 Install |
39 | | - |
40 | | -### Install with WinGet |
41 | | - |
42 | | -ThreadPilot is available on WinGet as `PrimeBuild.ThreadPilot`. |
43 | | - |
44 | | -From **Command Prompt** or **PowerShell**: |
45 | | - |
46 | | -```cmd |
47 | | -winget install --id PrimeBuild.ThreadPilot -e |
48 | | -``` |
49 | | - |
50 | | -To refresh your local WinGet source first: |
51 | | - |
52 | | -```cmd |
53 | | -winget source update |
54 | | -winget search ThreadPilot |
55 | | -``` |
56 | | - |
57 | | -### Download from GitHub Releases |
58 | | - |
59 | | -[](https://github.com/PrimeBuild-pc/ThreadPilot/releases/latest) |
60 | | -[](https://github.com/PrimeBuild-pc/ThreadPilot/releases/latest) |
61 | | - |
62 | | -| Package | Recommended use | |
63 | | -|---|---| |
64 | | -| `ThreadPilot_v<version>_Setup.exe` | Standard Windows installer for most users | |
65 | | -| `ThreadPilot_v<version>_singlefile_win-x64.zip` | Portable/no-install deployment | |
66 | | - |
67 | | -Optional checksum verification: |
68 | | - |
69 | | -```powershell |
70 | | -Get-FileHash .\ThreadPilot_v<version>_Setup.exe -Algorithm SHA256 |
71 | | -Get-FileHash .\ThreadPilot_v<version>_singlefile_win-x64.zip -Algorithm SHA256 |
72 | | -``` |
73 | | - |
74 | | -Compare the result with `SHA256SUMS.txt` from the same release. |
75 | | - |
76 | | -## 🖼️ Screenshots |
77 | | - |
78 | | -<img width="1672" height="941" alt="banner" src="https://github.com/user-attachments/assets/b8504579-8cff-439d-a6a6-fcc73cfa2994" /> |
79 | | - |
80 | | -## ⚙️ Requirements |
81 | | - |
82 | | -- Windows 11, build 22000 or newer. |
83 | | -- Administrator privileges to launch and manage system-level process settings. |
84 | | -- .NET 8 SDK only if you want to build from source. |
85 | | - |
86 | | -## 🚀 Usage Notes |
87 | | - |
88 | | -ThreadPilot uses an administrator-required manifest and requests elevation at startup. If UAC elevation is declined, the application exits instead of continuing in a limited mode. |
89 | | - |
90 | | -Useful startup arguments: |
91 | | - |
92 | | -```text |
93 | | ---start-minimized |
94 | | ---autostart |
95 | | ---test |
96 | | ---smoke-test |
97 | | -``` |
98 | | - |
99 | | -In `Power Plans > Custom Power Plans`, use `Add .pow File` to import custom power plans directly from the app. |
100 | | - |
101 | | -## 🧱 Build from Source |
102 | | - |
103 | | -```powershell |
104 | | -git clone https://github.com/PrimeBuild-pc/ThreadPilot.git |
105 | | -cd ThreadPilot |
106 | | -dotnet restore ThreadPilot_1.sln |
107 | | -dotnet build ThreadPilot_1.sln --configuration Release |
108 | | -dotnet run --project ThreadPilot.csproj --configuration Release |
109 | | -``` |
110 | | - |
111 | | -Run integrated runtime tests: |
112 | | - |
113 | | -```powershell |
114 | | -dotnet run --project ThreadPilot.csproj --configuration Release -- --test |
115 | | -``` |
116 | | - |
117 | | -Publish a self-contained Windows build: |
118 | | - |
119 | | -```powershell |
120 | | -dotnet publish ThreadPilot.csproj --configuration Release --runtime win-x64 --self-contained true |
121 | | -``` |
122 | | - |
123 | | -Build release artifacts with the project script: |
124 | | - |
125 | | -```powershell |
126 | | -./build/build-release.ps1 |
127 | | -``` |
128 | | - |
129 | | -## 🔐 Quality and Security |
130 | | - |
131 | | -- CI validates build, formatting, analyzers, vulnerability checks, and secret scanning. |
132 | | -- Security disclosures are handled through private GitHub advisories. See [`docs/SECURITY.md`](docs/SECURITY.md). |
133 | | -- Change history is tracked in [`docs/CHANGELOG.md`](docs/CHANGELOG.md). |
134 | | -- Coverage focuses on business/application code and excludes generated build artifacts. |
135 | | - |
136 | | -## 🧭 Project Documentation |
137 | | - |
138 | | -- [`docs/README.md`](docs/README.md) |
139 | | -- [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md) |
140 | | -- [`docs/CODE_OF_CONDUCT.md`](docs/CODE_OF_CONDUCT.md) |
141 | | -- [`docs/RELEASE_SIGNING.md`](docs/RELEASE_SIGNING.md) |
142 | | -- [`docs/release/PACKAGING.md`](docs/release/PACKAGING.md) |
143 | | -- [`docs/reference/ARCHITECTURE_GUIDE.md`](docs/reference/ARCHITECTURE_GUIDE.md) |
144 | | -- [`docs/reference/DEVELOPER_GUIDE.md`](docs/reference/DEVELOPER_GUIDE.md) |
145 | | -- [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) |
146 | | -- [`docs/reference/PROJECT_STRUCTURE.md`](docs/reference/PROJECT_STRUCTURE.md) |
147 | | -- [`docs/reference/UI_STYLE_GUIDE.md`](docs/reference/UI_STYLE_GUIDE.md) |
148 | | - |
149 | | -## 🗺️ Roadmap |
150 | | - |
151 | | -- Expand unit and integration coverage for core services. |
152 | | -- Continue async reliability refactoring for long-running monitoring paths. |
153 | | -- Improve accessibility and localization readiness across major views. |
154 | | -- Formalize release signing and distribution hardening. |
155 | | - |
156 | | -## 🤝 Contributing |
157 | | - |
158 | | -Contributions are welcome. Before opening a pull request, please read [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md) and [`docs/CODE_OF_CONDUCT.md`](docs/CODE_OF_CONDUCT.md). |
159 | | - |
160 | | -For bugs, feature requests, or packaging issues, open a GitHub issue with reproduction steps and your Windows version. |
161 | | - |
162 | | -## 📄 License |
163 | | - |
164 | | -ThreadPilot is licensed under the **GNU Affero General Public License v3.0**. See [`LICENSE`](LICENSE). |
165 | | - |
166 | | -## 💬 Support the Project |
167 | | - |
168 | | -<div align="center"> |
169 | | - |
170 | | -**Built with care for Windows power users.** |
171 | | - |
172 | | -[](https://github.com/PrimeBuild-pc/ThreadPilot/issues) |
173 | | -[](https://github.com/PrimeBuild-pc/ThreadPilot/discussions) |
174 | | -[](https://paypal.me/PrimeBuildOfficial?country.x=IT&locale.x=it_IT) |
175 | | - |
176 | | -If ThreadPilot is useful to you, consider starring the repository, opening thoughtful issues, sharing feedback, or supporting development with a small donation. |
177 | | - |
178 | | -</div> |
| 1 | +<div align="center"> |
| 2 | + |
| 3 | +# ThreadPilot ✈️ |
| 4 | + |
| 5 | +**A free and open-source Windows process and power plan manager for deterministic performance workflows.** |
| 6 | + |
| 7 | +[](https://github.com/PrimeBuild-pc/ThreadPilot/actions/workflows/ci-devsecops.yml) |
| 8 | +[](https://github.com/PrimeBuild-pc/ThreadPilot/releases) |
| 9 | +[](https://github.com/microsoft/winget-pkgs/tree/master/manifests/p/PrimeBuild/ThreadPilot) |
| 10 | +[](https://www.microsoft.com/windows) |
| 11 | +[](https://dotnet.microsoft.com/) |
| 12 | +[](LICENSE) |
| 13 | +[](https://github.com/PrimeBuild-pc/ThreadPilot/issues) |
| 14 | +[](https://github.com/PrimeBuild-pc/ThreadPilot/discussions) |
| 15 | + |
| 16 | +[Install](#-install) • [Features](#-features) • [Screenshots](#-screenshots) • [Build](#-build-from-source) • [Support](#-support-the-project) |
| 17 | + |
| 18 | +</div> |
| 19 | + |
| 20 | +<img width="1672" height="941" alt="cover" src="https://github.com/user-attachments/assets/858ec350-b997-4683-9df1-cc196307ede8" /> |
| 21 | + |
| 22 | +## What is ThreadPilot? |
| 23 | + |
| 24 | +ThreadPilot is a modern Windows desktop application for users who want predictable control over process behavior, CPU affinity, priority, power plans, and rule-driven performance workflows. |
| 25 | + |
| 26 | +It is designed as an open-source alternative for power users who need Process Lasso-style capabilities, automation support, system tray controls, and a Windows 11-first experience. |
| 27 | + |
| 28 | +## ✨ Features |
| 29 | + |
| 30 | +- Live process management with refresh, filtering, and high-volume process handling. |
| 31 | +- CPU affinity and priority controls with topology-aware logic. |
| 32 | +- I/O and scheduler-related tuning utilities. |
| 33 | +- Rule-based automation for power plan switching when selected processes start or stop. |
| 34 | +- Conditional profiles, tray controls, Live Metrics, and dashboard views. |
| 35 | +- Administrator-aware Windows desktop workflow. |
| 36 | +- CI-backed release artifacts and package-manager distribution. |
| 37 | +- Windows 11 native visual refresh with neutral Fluent surfaces and refined card-based layouts. |
| 38 | + |
| 39 | +## 📦 Install |
| 40 | + |
| 41 | +### Install with WinGet |
| 42 | + |
| 43 | +ThreadPilot is available on WinGet as `PrimeBuild.ThreadPilot`. |
| 44 | + |
| 45 | +From **Command Prompt** or **PowerShell**: |
| 46 | + |
| 47 | +```cmd |
| 48 | +winget install --id PrimeBuild.ThreadPilot -e |
| 49 | +``` |
| 50 | + |
| 51 | +To refresh your local WinGet source first: |
| 52 | + |
| 53 | +```cmd |
| 54 | +winget source update |
| 55 | +winget search ThreadPilot |
| 56 | +``` |
| 57 | + |
| 58 | +### Download from GitHub Releases |
| 59 | + |
| 60 | +[](https://github.com/PrimeBuild-pc/ThreadPilot/releases/latest) |
| 61 | +[](https://github.com/PrimeBuild-pc/ThreadPilot/releases/latest) |
| 62 | + |
| 63 | +| Package | Recommended use | |
| 64 | +|---|---| |
| 65 | +| `ThreadPilot_v<version>_Setup.exe` | Standard Windows installer for most users | |
| 66 | +| `ThreadPilot_v<version>_singlefile_win-x64.zip` | Portable/no-install deployment | |
| 67 | + |
| 68 | +Optional checksum verification: |
| 69 | + |
| 70 | +```powershell |
| 71 | +Get-FileHash .\ThreadPilot_v<version>_Setup.exe -Algorithm SHA256 |
| 72 | +Get-FileHash .\ThreadPilot_v<version>_singlefile_win-x64.zip -Algorithm SHA256 |
| 73 | +``` |
| 74 | + |
| 75 | +Compare the result with `SHA256SUMS.txt` from the same release. |
| 76 | + |
| 77 | +## 🖼️ Screenshots |
| 78 | + |
| 79 | +<img width="1672" height="941" alt="banner" src="https://github.com/user-attachments/assets/b8504579-8cff-439d-a6a6-fcc73cfa2994" /> |
| 80 | + |
| 81 | +## ⚙️ Requirements |
| 82 | + |
| 83 | +- Windows 11, build 22000 or newer. |
| 84 | +- Administrator privileges to launch and manage system-level process settings. |
| 85 | +- .NET 8 SDK only if you want to build from source. |
| 86 | + |
| 87 | +## 🚀 Usage Notes |
| 88 | + |
| 89 | +ThreadPilot uses an administrator-required manifest and requests elevation at startup. If UAC elevation is declined, the application exits instead of continuing in a limited mode. |
| 90 | + |
| 91 | +Useful startup arguments: |
| 92 | + |
| 93 | +```text |
| 94 | +--start-minimized |
| 95 | +--autostart |
| 96 | +--test |
| 97 | +--smoke-test |
| 98 | +``` |
| 99 | + |
| 100 | +In `Power Plans > Custom Power Plans`, use `Add .pow File` to import custom power plans directly from the app. |
| 101 | + |
| 102 | +## 🧱 Build from Source |
| 103 | + |
| 104 | +```powershell |
| 105 | +git clone https://github.com/PrimeBuild-pc/ThreadPilot.git |
| 106 | +cd ThreadPilot |
| 107 | +dotnet restore ThreadPilot_1.sln |
| 108 | +dotnet build ThreadPilot_1.sln --configuration Release |
| 109 | +dotnet run --project ThreadPilot.csproj --configuration Release |
| 110 | +``` |
| 111 | + |
| 112 | +Run integrated runtime tests: |
| 113 | + |
| 114 | +```powershell |
| 115 | +dotnet run --project ThreadPilot.csproj --configuration Release -- --test |
| 116 | +``` |
| 117 | + |
| 118 | +Publish a self-contained Windows build: |
| 119 | + |
| 120 | +```powershell |
| 121 | +dotnet publish ThreadPilot.csproj --configuration Release --runtime win-x64 --self-contained true |
| 122 | +``` |
| 123 | + |
| 124 | +Build release artifacts with the project script: |
| 125 | + |
| 126 | +```powershell |
| 127 | +./build/build-release.ps1 |
| 128 | +``` |
| 129 | + |
| 130 | +## 🔐 Quality and Security |
| 131 | + |
| 132 | +- CI validates build, formatting, analyzers, vulnerability checks, and secret scanning. |
| 133 | +- Security disclosures are handled through private GitHub advisories. See [`docs/SECURITY.md`](docs/SECURITY.md). |
| 134 | +- Change history is tracked in [`docs/CHANGELOG.md`](docs/CHANGELOG.md). |
| 135 | +- Coverage focuses on business/application code and excludes generated build artifacts. |
| 136 | + |
| 137 | +## 🧭 Project Documentation |
| 138 | + |
| 139 | +- [`docs/README.md`](docs/README.md) |
| 140 | +- [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md) |
| 141 | +- [`docs/CODE_OF_CONDUCT.md`](docs/CODE_OF_CONDUCT.md) |
| 142 | +- [`docs/RELEASE_SIGNING.md`](docs/RELEASE_SIGNING.md) |
| 143 | +- [`docs/release/PACKAGING.md`](docs/release/PACKAGING.md) |
| 144 | +- [`docs/reference/ARCHITECTURE_GUIDE.md`](docs/reference/ARCHITECTURE_GUIDE.md) |
| 145 | +- [`docs/reference/DEVELOPER_GUIDE.md`](docs/reference/DEVELOPER_GUIDE.md) |
| 146 | +- [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) |
| 147 | +- [`docs/reference/PROJECT_STRUCTURE.md`](docs/reference/PROJECT_STRUCTURE.md) |
| 148 | +- [`docs/reference/UI_STYLE_GUIDE.md`](docs/reference/UI_STYLE_GUIDE.md) |
| 149 | + |
| 150 | +## 🗺️ Roadmap |
| 151 | + |
| 152 | +- Expand unit and integration coverage for core services. |
| 153 | +- Continue async reliability refactoring for long-running monitoring paths. |
| 154 | +- Improve accessibility and localization readiness across major views. |
| 155 | +- Formalize release signing and distribution hardening. |
| 156 | + |
| 157 | +## 🤝 Contributing |
| 158 | + |
| 159 | +Contributions are welcome. Before opening a pull request, please read [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md) and [`docs/CODE_OF_CONDUCT.md`](docs/CODE_OF_CONDUCT.md). |
| 160 | + |
| 161 | +For bugs, feature requests, or packaging issues, open a GitHub issue with reproduction steps and your Windows version. |
| 162 | + |
| 163 | +## 📄 License |
| 164 | + |
| 165 | +ThreadPilot is licensed under the **GNU Affero General Public License v3.0**. See [`LICENSE`](LICENSE). |
| 166 | + |
| 167 | +## 💬 Support the Project |
| 168 | + |
| 169 | +<div align="center"> |
| 170 | + |
| 171 | +**Built with care for Windows power users.** |
| 172 | + |
| 173 | +[](https://github.com/PrimeBuild-pc/ThreadPilot/issues) |
| 174 | +[](https://github.com/PrimeBuild-pc/ThreadPilot/discussions) |
| 175 | +[](https://paypal.me/PrimeBuildOfficial?country.x=IT&locale.x=it_IT) |
| 176 | + |
| 177 | +If ThreadPilot is useful to you, consider starring the repository, opening thoughtful issues, sharing feedback, or supporting development with a small donation. |
| 178 | + |
| 179 | +</div> |
0 commit comments