wsl-dashboard

# WSL Dashboard

A modern, high-performance, lightweight, and low-memory WSL (Windows Subsystem for Linux) instance management dashboard. Built with Rust and Slint for a premium native experience. --- ```diff Notice:​ - WSL Dashboard is not distributed through the Microsoft Store. - Any application listed there under the name "WSL Dashboard"​ is unauthorized and may be counterfeit. - Please do not download it to avoid potential scams. ``` ---

I18N : English | [简体中文](./manual/README_zh_CN.md) | [繁體中文](./manual/README_zh_TW.md) | [हिन्दी](./manual/README_hi.md) | [Español](./manual/README_es.md) | [Français](./manual/README_fr.md) | [العربية](./manual/README_ar.md) | [বাংলা](./manual/README_bn.md) | [Português](./manual/README_pt.md) | [Русский](./manual/README_ru.md) | [اردو](./manual/README_ur.md) | [Bahasa Indonesia](./manual/README_id.md) | [Deutsch](./manual/README_de.md) | [日本語](./manual/README_ja.md) | [Türkçe](./manual/README_tr.md) | [한국어](./manual/README_ko.md) | [Italiano](./manual/README_it.md) | [Nederlands](./manual/README_nl.md) | [Svenska](./manual/README_sv.md) | [Čeština](./manual/README_cs.md) | [Ελληνικά](./manual/README_el.md) | [Magyar](./manual/README_hu.md) | [עברית](./manual/README_he.md) | [Norsk](./manual/README_no.md) | [Dansk](./manual/README_da.md) | [Suomi](./manual/README_fi.md) | [Slovenčina](./manual/README_sk.md) | [Slovenščina](./manual/README_sl.md) | [Íslenska](./manual/README_is.md) | [Tiếng Việt](./manual/README_vi.md) | [తెలుగు](./manual/README_te.md) | [Basa Jawa](./manual/README_jv.md) | [ภาษาไทย](./manual/README_th.md) | [தமிழ்](./manual/README_ta.md) | [Filipino](./manual/README_fil.md) | [ਪੰਜਾਬੀ](./manual/README_pa.md) | [Bahasa Melayu](./manual/README_ms.md) | [Polski](./manual/README_pl.md) | [Українська](./manual/README_uk.md) | [فارسی](./manual/README_fa.md) | [ಕನ್ನಡ](./manual/README_kn.md) | [मराठी](./manual/README_mr.md) | [Hausa](./manual/README_ha.md) | [မြန်မာ](./manual/README_my.md) | [Oʻzbek](./manual/README_uz.md) | [Azərbaycan](./manual/README_az.md) | [Cebuano](./manual/README_ceb.md) | [മലയാളം](./manual/README_ml.md) | [سنڌي](./manual/README_sd.md) | [አማርኛ](./manual/README_am.md) --- ## Table of Contents - [ Language Support](#-language-support) - [ Key Features & Usage](#-key-features--usage) - [⚙️ Configuration & Logs](#️-configuration--logs) - [️ Screenshots](#️-screenshots) - [ Operation Demo](#-operation-demo) - [ System Requirements](#-system-requirements) - [ Installation](#-installation) - [️ Tech Stack & Performance](#️-tech-stack--performance) - [ Official Community Groups](#-official-community-groups) - [ Community Support](#-community-support) - [❤️ Support this project](#️-support-this-project) - [⭐️ Labor of love](#️-labor-of-love) - [ License](#-license) --- ## Language Support English, Simplified Chinese, Traditional Chinese, Hindi, Spanish, French, Arabic, Bengali, Portuguese, Russian, Urdu, Indonesian, German, Japanese, Turkish, Korean, Italian, Dutch, Swedish, Czech, Greek, Hungarian, Hebrew, Norwegian, Danish, Finnish, Slovak, Slovenian, Icelandic, Vietnamese, Telugu, Javanese, Thai, Tamil, Filipino, Punjabi, Malay, Polish, Ukrainian, Persian, Kannada, Marathi, Hausa, Burmese, Uzbek, Azerbaijani, Cebuano, Malayalam, Sindhi, Amharic

## Key Features & Usage - **Modern Native UI**: Intuitive GUI with Dark/Light mode support, smooth animations, and high-performance rendering powered by **Skia**. - **System Tray Integration**: Full support for system tray minimizing (~10MB RAM usage), double-click to toggle, and a functional right-click menu. - **Intelligent Startup**: Configure the dashboard to start with Windows, minimize to tray (silent mode with `/silent`), and auto-shutdown distributions on exit. - **Task Scheduler**: Flexible task scheduler management, supporting automatic execution of scripts and commands in WSL instances at specified times or intervals for automated operations. - **Comprehensive Instance Control**: One-click Start, Stop, Terminate, and Unregister. Real-time status monitoring and detailed insights into disk usage and file locations. - **Distro Management**: Set as default, migration (Move VHDX to other drives), and export/clone to `.tar` or `.tar.gz` archives. - **Disk Mount**: Directly mount and manage WSL instance VHDX virtual disks, supporting mount, unmount, and disk management operations, making it easy to transfer files between the host and WSL. - **Quick Integration**: Instant launch into Terminal, VS Code, or File Explorer with customizable working directories and startup script hooks. - **Distro Installation**: Install Linux distributions via Microsoft Store, GitHub, local files (RootFS/VHDX), or Online Mirrors (with auto speed-test to pick the fastest mirror and built-in RootFS download helper). - **Global Safety**: Mutex locks for safe concurrent migration/backup operations and automatic Appx cleanup on removal. - **Ultra-Low Memory Footprint**: Highly optimized for efficiency. Silent startup (system tray) uses only **~10MB** RAM. Windowed mode usage varies by font complexity: **~18MB** for standard languages (English, German, Spanish, etc.) and **~38MB** for large font languages (Chinese, Japanese, Korean, etc.). - **Advanced Networking**: Seamless port forwarding management (with automatic firewall rule creation) and global HTTP proxy configuration for unified connectivity. - **USB Device Management**: Full integration with `usbipd-win` for effortless binding, attaching, and managing of local USB devices across your WSL instances directly from the dashboard UI. ## ⚙️ Configuration & Logs All configuration is managed through the Settings view: - Choose the default installation directory for new WSL instances. - Configure the log directory and log level (Error / Warn / Info / Debug / Trace). - Pick the UI language or let it follow the system language. - Toggle dark mode and whether the app can auto-shutdown WSL after operations. - Configure how often the app checks for updates (daily, weekly, biweekly, monthly). - Enable automatic startup on system boot (with automatic path repair). - Set the app to minimize to the system tray on startup for a distraction-free experience. - Configure the close button to minimize to the system tray instead of exiting. - Customize the sidebar by toggling the visibility of specific feature tabs. Log files are written to the configured log directory and can be attached when reporting issues. ## ️ Screenshots ### Home (Light & Dark Mode)

### USB & Collapse menu

### Network

### Add Instance & Settings

### About & Donate

### Disk Mount

### Task Scheduler

## Operation Demo [Help us improve! Watch our intro video and share your thoughts.](https://github.com/owu/wsl-dashboard/discussions/9) ## System Requirements - Windows 10 or Windows 11 with WSL enabled (WSL 2 recommended). - At least one WSL distribution installed, or permission to install new ones. - 64-bit CPU; 4 GB RAM or more recommended for smooth multi-distro usage. ## Installation ### Option 1: Visit the project website (Recommended) We recommend visiting the official website to download, as it offers multiple mirror links for a smoother experience: Go to the [Download page](https://www.wslui.com/download/) and choose the mirror suitable for your region. ### Option 2: Install via winget You can install WSLDashboard directly from the Windows Package Manager (winget), using either the moniker or the full package identifier: ```powershell # Search (case-insensitive) winget search wsl-dashboard # or winget search WSLDashboard # Install (pick one) winget install wsl-dashboard # or winget install Owu.WSLDashboard ``` > The winget package identifier is `Owu.WSLDashboard` and the moniker is `wsl-dashboard` (case-insensitive). Either works. For more information, visit the [WinGet community repository](https://github.com/microsoft/winget-pkgs/tree/master/manifests/o/Owu/WSLDashboard). ### Option 3: Download prebuilt binary You can also download the precompiled release directly: 1. Go to the [GitHub Releases](https://github.com/owu/wsl-dashboard/releases) page. 2. Download the latest `wsldashboard` executable for Windows. 3. Extract (if packaged) and run `wsldashboard.exe`. No installer is required; the app is a single portable binary. ### Option 4: Build from source Ensure you have the Rust toolchain (Rust 1.92+ or newer) installed. 1. Clone the repository: ```powershell git clone https://github.com/owu/wsl-dashboard.git cd wsl-dashboard ``` 2. Build and run: - For development: ```powershell cargo run ``` - Optimized release build, using the build script: > The build script requires the `x86_64-pc-windows-msvc` toolchain. ```powershell .\build\portable\build.ps1 ``` ## ️ Tech Stack & Performance - **Core**: Implemented in Rust for memory safety and zero-cost abstractions. - **UI Framework**: Slint with high-performance **Skia** rendering backend. - **Async Runtime**: Tokio for non-blocking system commands and I/O. - **Performance Highlights**: - **Responsiveness**: Near-instant startup and real-time WSL status monitoring. - **Efficiency**: Ultra-low resource usage (see [Key Features](#-key-features--usage) for details). - **Portability**: Optimized release build produces a single compact executable. ## Official Community Groups Welcome to the official WSL UI community groups! Join our channels to discuss usage tips, report issues, get the latest updates, and connect with the developers and other users. | Global Group (Telegram) | Chinese Group (WeChat) | | :---: | :---: | | | | | Scan to join | Scan to join | --- ## Community Support A big thank you to the following communities for their support: - [Rust Programming Language](https://www.rust-lang.org) - For the powerful and safe programming language - [Slint | Declarative GUI for Rust, C++, JavaScript & Python](https://slint.dev) - For the modern UI framework - [WSL: Windows Subsystem for Linux](https://github.com/microsoft/WSL) - For the amazing Windows Subsystem for Linux - [Tokio - An asynchronous Rust runtime](https://tokio.rs) - For the efficient async runtime - [Windows Developer Community](https://developer.microsoft.com/en-us/windows/community) - For continuous platform improvements - [Reddit](https://www.reddit.com) - For global community discussions and support - [Hacker News](https://news.ycombinator.com) - For global community discussions and support - [Linux.do](https://linux.do) - For popular community for IT professionals - [V2EX](https://www.v2ex.com) - For Chinese tech community discussions Your contributions and feedback make this project possible! ## ❤️ Support this project - This project is licensed under GPL-3.0 and is free for all users. - From feature development and daily testing to bug fixes, all work is done in spare time. The road of open source is not easy alone — your recognition and support give the project the confidence to keep going. - If this tool has genuinely helped you, consider lending a hand. All donations