Skip to content

Installation

Release Types

WSL Dashboard is available in three distribution formats to suit different use cases:

TypeExample FilenameDescription
Portable (EXE)WSLDashboard.vX.Y.Z.Portable.x64.exeRecommended. Single-file, no installation required — just run it. Config is saved to ~\.wsldashboard.
Portable (ZIP)WSLDashboard.vX.Y.Z.Portable.x64.zipCompressed portable version, ideal for manual deployment or integration with other toolchains.
Setup (EXE)WSLDashboard.vX.Y.Z.Setup.x64.exeStandard installer. Creates a Start Menu shortcut, desktop icon, and registers an uninstall entry.

TIP

Which one should I choose?

  • For simplicity and speed, choose the Portable (EXE).
  • If you want it to appear in the Start Menu like a regular application, choose the Setup (EXE).

Using the Portable Version

Building from Source

If you prefer to compile the application yourself, ensure your development environment meets the following requirements:

  • Rust toolchain: Version 1.92 or later.
  • Build target: x86_64-pc-windows-msvc.

Build Steps

  1. Clone the repository:

    bash
    git clone https://github.com/owu/wsl-dashboard.git
    cd wsl-dashboard
  2. Run in development mode:

    bash
    cargo run .
  3. Production build (using the provided script):

    powershell
    .\build\portable\build.ps1

The compiled output will be located in the target/release directory.