An open API service indexing awesome lists of open source software.

https://github.com/lessup/dig-your-windows


https://github.com/lessup/dig-your-windows

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

          

# DigYourWindows

[![CI](https://github.com/LessUp/dig-your-windows/actions/workflows/ci.yml/badge.svg)](https://github.com/LessUp/dig-your-windows/actions/workflows/ci.yml)
[![Docs](https://github.com/LessUp/dig-your-windows/actions/workflows/pages.yml/badge.svg)](https://github.com/LessUp/dig-your-windows/actions/workflows/pages.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Release](https://img.shields.io/github/v/release/LessUp/dig-your-windows)](https://github.com/LessUp/dig-your-windows/releases)
[![Downloads](https://img.shields.io/github/downloads/LessUp/dig-your-windows/total)](https://github.com/LessUp/dig-your-windows/releases)

English | [็ฎ€ไฝ“ไธญๆ–‡](README.zh-CN.md)

> ๐Ÿ“– **Documentation**: [https://lessup.github.io/dig-your-windows/](https://lessup.github.io/dig-your-windows/)

**Windows Deep Diagnostics Tool** โ€” One-click hardware information collection, event log analysis, reliability records, system health scoring, and optimization recommendations.

## ๐Ÿ“ธ Screenshots

![DigYourWindows Overview](docs/public/screenshot-overview.png)

## โœจ Features

| Feature | Description |
|---------|-------------|
| ๐Ÿ” **Hardware Detection** | Collect CPU, GPU, RAM, Disk (with SMART), Network adapters, USB devices |
| ๐Ÿ“Š **Real-Time Monitoring** | CPU temp/load/frequency, GPU temp/load/VRAM, network traffic |
| ๐Ÿ“‹ **Event Log Analysis** | Auto-extract System/Application errors and warnings |
| ๐Ÿ“ˆ **Reliability Records** | Windows Reliability Monitor data with trend visualization |
| โœ… **Health Scoring** | Comprehensive stability, performance, memory, disk assessment |
| ๐Ÿ’ก **Smart Recommendations** | AI-generated targeted optimization suggestions |
| ๐Ÿ“„ **Report Export** | HTML and JSON formats with offline viewing |
| ๐ŸŽจ **Theme Support** | Dark/Light theme instant toggle |

## ๐Ÿš€ Quick Start

### Prerequisites

- Windows 10/11 (Build 19041+)
- [.NET 10.0 SDK](https://dotnet.microsoft.com/download) (for building)

### Installation

#### Option 1: Download Release (Recommended)

Download the latest installer from [Releases](https://github.com/LessUp/dig-your-windows/releases):

| Version | Size | Requirements |
|---------|------|--------------|
| `DigYourWindows_Setup.exe` | ~5MB | Downloads .NET if needed |
| FDD (Framework-Dependent) | ~60MB | Requires .NET 10 Runtime |
| SCD (Self-Contained) | ~180MB | No dependencies |

#### Option 2: Build from Source

```powershell
# Clone repository
git clone https://github.com/LessUp/dig-your-windows.git
cd dig-your-windows

# Build and run
dotnet restore
dotnet run --project src/DigYourWindows.UI/DigYourWindows.UI.csproj
```

> โš ๏ธ **Note**: Some features (GPU monitoring, SMART data) require administrator privileges.

### First Run

1. Launch `DigYourWindows.UI.exe` (or run via `dotnet run`)
2. Click "Run Diagnostics" to collect system information
3. View real-time hardware monitoring on the dashboard
4. Export reports via JSON or HTML format

## ๐Ÿ—๏ธ Tech Stack

| Component | Technology | Version | Purpose |
|-----------|------------|---------|---------|
| Runtime | .NET + WPF | 10.0 | Desktop application framework |
| UI Library | WPF-UI | 4.0 | Fluent Design components |
| MVVM | CommunityToolkit.Mvvm | 8.4 | Data binding & commands |
| Charts | ScottPlot | 5.1 | Performance visualization |
| Hardware | LibreHardwareMonitor | 0.9 | CPU/GPU temp, load, frequency |
| Testing | xUnit + FsCheck | 2.9 / 2.16 | Unit & property-based tests |

## ๐Ÿ“ Project Structure

```
dig-your-windows/
โ”œโ”€โ”€ src/
โ”‚ โ”œโ”€โ”€ DigYourWindows.Core/ # Core business logic
โ”‚ โ””โ”€โ”€ DigYourWindows.UI/ # WPF user interface
โ”œโ”€โ”€ tests/
โ”‚ โ””โ”€โ”€ DigYourWindows.Tests/ # Unit & property tests
โ”œโ”€โ”€ docs/ # VitePress documentation (bilingual)
โ”œโ”€โ”€ installer/ # Inno Setup scripts
โ”œโ”€โ”€ scripts/ # Build & release scripts
โ””โ”€โ”€ changelog/ # Detailed changelogs
```

## ๐Ÿงช Testing

```powershell
# Run all tests
dotnet test DigYourWindows.slnx

# Run with coverage
dotnet test --collect:"XPlat Code Coverage"

# Filter specific tests
dotnet test --filter "FullyQualifiedName~ReportServiceTests"
```

## ๐Ÿ“š Documentation

- [๐Ÿ“– Getting Started Guide](https://lessup.github.io/dig-your-windows/guide/getting-started)
- [๐Ÿ—๏ธ Architecture Documentation](https://lessup.github.io/dig-your-windows/guide/architecture)
- [๐Ÿงช Testing Guide](https://lessup.github.io/dig-your-windows/guide/testing)
- [๐Ÿ“Š Data Schema Reference](https://lessup.github.io/dig-your-windows/reference/data-schema)
- [โ“ FAQ](https://lessup.github.io/dig-your-windows/guide/faq)

Documentation is available in **English** and **็ฎ€ไฝ“ไธญๆ–‡**.

## ๐Ÿค Contributing

We welcome contributions! Please see our [Contributing Guide](https://lessup.github.io/dig-your-windows/guide/contributing) for details.

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit changes (`git commit -m 'feat: add amazing feature'`)
4. Push to branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## ๐Ÿ“ฆ Release Process

Push a `v*` tag to trigger automatic release:

```powershell
git tag v1.1.0
git push origin v1.1.0
```

GitHub Actions will automatically build and publish the release with bilingual release notes.

## ๐Ÿ”’ Security

This tool:
- โœ… Runs entirely offline
- โœ… Does not upload any data to external servers
- โœ… Uses local file system for all operations
- โœ… Is open source and auditable

## ๐Ÿ“„ License

[MIT License](LICENSE) - Copyright ยฉ 2025-2026 LessUp

---


Made with โค๏ธ by LessUp