Explore the Official Documentation & Guides »

Quickstart Guide · Supported Sensors · Customization Guide · Discord Server · Report Bug

---

Key Features

• 🪟 Live Taskbar Overlay: Embeds real-time system telemetry directly into the Windows 11 taskbar with sharp DPI scaling and zero desktop clutter.
• ⚡ Deep Hardware Telemetry: Monitors CPU clocks, wattage, and thermals via kernel MSR registers alongside GPU, RAM, NVMe/SATA disks, and battery rates.
• 🌐 Continuous Bandwidth Tracking: Measures live download and upload speeds, backfilling offline data via Windows SRUM so no usage is missed.
• 🎨 Adaptive OEM Brand Themes: Detects installed hardware vendors (Intel, AMD, NVIDIA, Samsung, Corsair) and applies authentic manufacturer color palettes.
• 🔔 Game-Safe Alerts: Delivers custom threshold warnings via background toasts that never steal keyboard focus or minimize full-screen games.
• 🔒 Private & Offline Logging: Stores bandwidth history locally in lightweight JSON Lines (internet_usage.jsonl) with 100% offline privacy and zero telemetry.
• 🛡️ Verified Supply-Chain Security: Ships with cryptographic SLSA provenance attestations, clean Windows Defender scans, and zero adware.

---

System Requirements

Requirement	Minimum Specification	Recommended Specification
Operating System	Windows 10 (64-bit, v2004+ / build 19041)	Windows 11 (64-bit, v22H2+)
Architecture	x86-64 / AMD64 (Intel / AMD)	x86-64 / AMD64
Permissions	Administrator (UAC) (For hardware sensor drivers)	Administrator (UAC)
RAM	2 GB	4 GB or higher
Disk Space	200 MB free space	200 MB
Runtime	WebView2 Runtime	WebView2 Runtime (Pre-installed on Win 11)

Note: 32-bit (x86) Windows versions and ARM processors are currently not supported.

---

Download & Installation

Option 1: Standard Installer (Recommended)

1. Download the latest LocalTelemetrySetup.exe from GitHub Releases.
2. Run the installer and follow the quick setup wizard.
3. LocalTelemetry will launch automatically after installation.

Important

Internet Connection for First-Time Setup: The installer automatically checks for the .NET 10 Desktop Runtime. If absent, Setup downloads and installs Microsoft's official runtime package (~55 MB) with a progress bar. The bundled PawnIO kernel sensor driver (~3.4 MB) installs silently offline without external downloads. Subsequent application launches run 100% offline.

Administrator Permissions Note: LocalTelemetry requires Administrator privileges to read low-level hardware sensors (PawnIO driver for CPU MSR/SMU registers and disk IOCTLs). Manual launches will show a standard Windows UAC prompt. Enabling Start with Windows runs the app via a Windows Task Scheduler task with elevated privileges, allowing it to start silently at boot without prompting. For portable installations, Uninstall.bat provides a complete administrative driver and registry cleanup.

Option 2: Chocolatey

Install via Chocolatey:

choco install localtelemetry

For pre-release versions (RC/Beta):

choco install localtelemetry --pre

Option 3: Scoop

Install via Scoop:

# Standard install (if the official extras bucket is already enabled)
scoop install localtelemetry

# First-time Scoop GUI install (if extras is not yet added)
scoop bucket add extras
scoop install localtelemetry

# Direct install from the project-hosted repository bucket
scoop bucket add localtelemetry https://github.com/Nicconike/LocalTelemetry
scoop install localtelemetry

Option 4: Portable ZIP

1. Download LocalTelemetry-win-x64.zip from GitHub Releases.
2. Extract the folder to any location on your PC.
3. Run LocalTelemetry.exe.

Verifying Your Download

Every release ships with a checksums.txt and SLSA build attestations. You can verify your download before running it:

# 1. Compare the SHA-256 hashes against checksums.txt
Get-FileHash .\LocalTelemetrySetup.exe, .\LocalTelemetry-win-x64.zip -Algorithm SHA256

# 2. Verify the SLSA attestation (proves the file was built by the release workflow)
gh attestation verify .\LocalTelemetrySetup.exe --repo Nicconike/LocalTelemetry
gh attestation verify .\LocalTelemetry-win-x64.zip --repo Nicconike/LocalTelemetry

The attestation confirms the binary was produced by the official Release workflow and has not been tampered with.

---

Quick Start

1. Taskbar Overlay

After launch, LocalTelemetry displays a live hardware telemetry overlay on the Windows taskbar:

2. System Tray Controls

Right-click the LocalTelemetry icon in the system tray (near the clock) to control the app:

• Show / Hide Taskbar Overlay: Toggle the overlay visibility
• Open Settings: Launch the settings panel
• Quit: Exit LocalTelemetry

3. Settings & Customization

Double-click the tray icon to open the dark-mode settings panel:

General - autostart with Windows, launch minimized, polling interval and temperature units:

Taskbar Layout - reorder metrics by drag-and-drop to control exactly what appears in the overlay:

Monitoring - toggle individual hardware components and enable metrics logging:

Traffic & Network History - daily bandwidth calendar with per-interface breakdown:

4. Threshold Alerts

Set per-metric warning limits - e.g. CPU at 90°C or GPU at 88°C. When a threshold is crossed, the metric flashes on the overlay and a desktop toast notification pops up without stealing focus:

---

Getting Help & Support

Need help, found a bug or have a feature suggestion?

• 📖 Documentation: Browse the full User & Developer Guides.
• 💬 Discord Server: Join the Discord Community to chat live with the developer and get real-time support.
• 💡 Community Discussions: Ask questions or share ideas on GitHub Discussions.
• 🐛 Report an Issue: Open a bug report via the Issue Tracker.
• 🛠️ Developers & Contributors: See CONTRIBUTING.md for build instructions and code guidelines.

---

License

LocalTelemetry is free and open-source software licensed under the GNU General Public License v3.0. See LICENSE for details.