Awesome WSL - Windows Subsystem for Linux

An Awesome collection of Windows Subsystem for Linux (WSL) information, distributions, and tools.

Overview

1. Linux

Linux is a UNIX-like open-source operating system. The core of Linux is a kernel developed by Linus Torvalds. Linux also includes a wide array of applications built on top of the kernel, including web servers, compilers, and e-mail clients, developed and contributed to the Linux ecosystem by a worldwide community of programmers. These applications are then assembled together into Linux distributions by companies, communities, and individuals.

2. Linux Distributions

Unlike Windows or macOS there are many different Linux distributions, each of which is assembled with different approaches to the software selection and implementation. For example, the goal of the non-profit volunteer Debian Project community is to produce a universal free operating system, while the goal of the for-profit SUSE is to provide a stable enterprise platform. There are also Linux distributions based on other distributions. Ubuntu is a distribution based on Debian built by the company Canonical. Kali is a distribution based on Debian built with an emphasis on tools for network security testing. You can see the most popular distributions ranked at DistroWatch.

3. Windows

Windows is a family of proprietary operating systems, all of which are developed, marketed, and sold by Microsoft. Currently Windows 10 is Microsoft's flagship operating system. Windows 10 is available for Intel x86-based and arm64-based PCs. The Windows Subsystem for Linux first shipped in Windows 10 Anniversary Update, version number 1607, in August 2016. WSL can be enabled for free on all versions of Windows 10 after 1607, including Home, Professional, Enterprise, Server, LTSB, and Education. Originally only available for Intel x86-based PCs, Ubuntu 18.04 for arm64 was made available on the Microsoft store in May 2018.

4. WSL1

The original WSL is now known as WSL1. WSL1 is a compatibility layer for running Linux binary executables (ELF) natively on Windows 10. No re-compilation or 'porting' of applications is required. WSL1 provides a Linux-compatible kernel interface developed by Microsoft that allows a user to choose a Linux distribution to install from the Microsoft Store. WSL1 executes unmodified Linux ELF64 binaries by operating a Linux kernel interface on top of the Windows kernel in Windows 10. The WSL1 interface translates Linux system calls from the binaries into Windows system calls and then executes them at native speed. Linux applications run within the Linux distribution which provides the application's dependencies and package management in a container-like environment. WSL provides an interface to mount drives within WSL.

5. WSL2

WSL2 was announced at Microsoft Build 2019. WSL2 features a Linux kernel running inside Windows 10 and is built on the core technology of Hyper-V to provide better Linux application support and improved file performance. Transitioning to WSL2 is seamless. WSL2 is still in active development and is only available in Insider builds. These builds are not suitable for production devices and are not recommended for a user's primary machine. Instead, users can try WSL2 using Hyper-V or on a secondary machine.

Announcing WSL2 - Microsoft blog announcing WSL2
The new Windows subsystem for Linux architecture: a deep dive - WSL2 presentation at Microsoft Build 2019
WSL2-Linux-Kernel - The source for the Linux kernel used in Windows Subsystem for Linux 2.

6. Emulation

Windows Subsystem for Linux is not an emulator or virtualizer like VirtualBox. WSL1 is closer in its approach to Wine which is a compatibility layer to run Windows binaries on Linux by re-implementing Windows system and API calls in libraries.

7. Details

You want the gritty details? Here they are:

Windows Subsystem for Linux Overview at MSDN.
WSL File System Support at MSDN.
WSL System Calls at MSDN.
Windows and Ubuntu Interoperability at MSDN.
WSL Antivirus and Firewall Compatibility at MSDN.
WSL Release Notes from docs.microsoft.com.
Windows Subsystem for Linux Documentation from docs.microsoft.com.
Windows Subsystem for Linux - Update from Microsoft Developer YouTube channel.
Windows for Linux Nerds from Microsoft developer Jessie Frazelle.

8. Installation

WSL1 Installation Guide - Microsoft's official guide for WSL1.
WSL2 Installation Guide - Microsoft's official guide for WSL2.
Windows Server Installation Guide - Microsoft's official guide for Windows Server.
Windows-Subsystem-For-Linux-Setup - A basic guide for how to get setup with the WSL feature that is included with Windows 10.

9. Use Cases

WSL is undoubtedly a tool for power-users, developers, and *NIX/Linux geeks who want to run Windows. Most of the things you can do with WSL are going to be related to programming, the console, sysadmin, automation, AI/data science, and other geeky things.

10. GUI Apps

Yes, a suprising number of Linux GUI apps can run on WSL even though this is not officially supported by Microsoft. Running a GUI app on Linux though means running an X server on Windows. This must be downloaded, installed, and running for your GUI app to open from WSL. Otherwise it will complain of not finding a display. X servers for Windows include X410 💰 ($5 but very highly recommended), VcXsrv, or Xming on Windows 10.

Using WSL

The WSL Shell

Everything You Can Do With Windows 10’s New Bash Shell
The Unix Workbench - A book for anyone to get started with Unix/Linux environments.
The Art of Command Line - Master the command line in one page.
The Bash Academy - The Bash Academy is an initiative to promote the bash shell language and educate people on its use.
Awesome Command Line Apps

Programming on WSL

Every developer has a unique workflow. Windows and WSL enable developers to carefully customize their setup for their unique workflow. The following are different developers' approaches to creating their development environments using WSL and instructions on how to do the same:

Epic Development Environment Using Windows Subsystem for Linux - One developer's approach to their development environment using WSL.
Setting Up a Programming Environment via Windows 10 Bash - From the computer science department at Old Dominion University.
WSL as a Development Environment - From the computer science department at University of Utah.
Using WSL and MobaXterm to Create a Linux Dev Environment on Windows - Another developer's approach using the third-party terminal MobaXterm.
Setting up my WSL Environment - Azure CLI, Docker and .NET
ubuntu-win-boostrap - A very simple bootstrap script to install some development basic tools on Debian/Ubuntu on WSL.
Castle-Winbuntu - Another developer's progress on their development environment using WSL.
Badass Terminal

For more about learning programming generally, visit curated-programming-resources.

Microsoft makes free development tools available, publishes programming guides through MSDN, and offers courses through edX and Microsoft Virtual Academy.

Web Development on WSL

Because WSL allows developers to run a variety of Linux server applications locally on their Windows machine, WSL is uniquely useful for web, cloud, and other server-side development tasks. The following are different developers' approaches to creating their web development environment using WSL and instructions on how to do the same:

We put Linux in your Windows - YouTube talk by Windows kernel team member Sarah Cooley on WSL for Windows.
Setting Up Windows for Web Development.
How to Install LAMP Stack Server on Windows Subsystem Linux.

Other WSL Uses

Arduino setup checklist - Checklist to connect Arduino board from WSL 1.
Learning programming, computer science, and system administration generally.
Building applications for Azure, Microsoft's cloud platform.
Leveraging the power of the shell and scripting to automate your personal workflow, like OCRing and sorting PDFs into folders using Python.
Replacing Windows shell with Xfce, Gnome, KDE, or i3..
Running Linux-based server applications like OpenFOAM and Wordpress locally for testing purposes.
Managing your companies' CentOS servers using Ansible.
pWSLinux+K8S: The Interop way
Vagrant and Windows Subsystem for Linux

Supported Distributions

Ubuntu

Ubuntu is a Linux distribution based on Debian that is produced by Canonical Ltd.. Ubuntu 16.04 and the more recent Ubuntu 18.04 are both available for WSL from the Microsoft Store.

Windows Store Link for Ubuntu 16.04. Supported through April 2021. Very stable but some packages and libraries may be older.
Windows Store Link for Ubuntu 18.04. Most recent update. Newer packages but more likely to encounter bugs. Supported through April 2023.
Installing Software guide to using apt from Ubuntu.
Ubuntu Server Guide from Ubuntu.
Because Ubuntu is based on Debian, many Debian tutorials also apply to Ubuntu.

Debian

Debian is a Linux distribution assembled by volunteers with the community Debian Project.

Windows Store Link for Debian Stretch.
Debian Reference post-installation guide for Debian users with a focus on the command line from Debian.
Package Management guide to using apt from Debian.
WSL Wiki page from Debian.

OpenSUSE / SUSE Enterprise Linux

OpenSUSE and SUSE Enterprise Linux are Linux distributions produced by SUSE Linux GmbH and other companies. Leap is a community-oriented distribution with recent software. SUSE Enterprise Linux is an enterprise-grade commercial distribution with older tested software.

Windows Store Link for OpenSUSE Leap 15.
Windows Store Link for SUSE Enterprise Linux 15.
Managing Software with Command Line Tools from OpenSUSE.
OpenSUSE Reference.
SUSE Linux Enterprise Documentation from SUSE.

Kali Linux

Kali Linux is a Linux distribution focused on penetration testing based on Debian that is produced by Offensive Security.

Windows Store Link.
Kali Linux Official Documentation.
Because Kali is based on Debian, most Debian and Ubuntu documentation also applies to Kali.

Fedora Remix for WSL

Fedora Remix for WSL is a Linux distribution derived from the Fedora distribution.

Pengwin

Pengwin (formerly WLinux) is a Linux distribution based on Debian that is designed for WSL users by independent open source developers at Whitewater Foundry.

Windows Store Link 💰
Pengwin GitHub
Because Pengwin is based on Debian, most Debian and Ubuntu documentation also applies to Pengwin.

Pengwin Enterprise

Pengwin Enterprise is a custom WSL solution available to enterprise customers from Whitewater Foundry. Pengwin Enterprise supports Red Hat Enterprise Linux, CentOS, and Scientific Linux. A demo of Pengwin Enterprise built with Scientific Linux is available on the Microsoft Store.

Unofficial Distributions

Unofficial distributions must be installed manually or with tools listed below. They are not available in the Windows Store.

miniwsl - A mini Linux distribution for WSL powered by busybox.
ArchWSL - ArchLinux in WSL.
AlpineWSL - Alpine in WSL.
windows-subsystem-linux-fedora - Fedora in WSL.
WSLInstall - Install any GNU/Linux distribution userspace in Windows Subsystem for Linux (WSL) with compressed RootFS tarballs, Docker containers, or ISO files.
wsldl - General purpose WSL installer and launcher.
WSL-Distribution-Switcher - Scripts to replace the distribution behind WSL with any other Linux distribution published on Docker Hub. Includes alpine, CentOS, Fedora, Clear, and others.
acme-wsl - Install acme / plan9port on Debian, Ubuntu, or Kali Linux distributions on WSL.
CentWSL - CentOS as a WSL distro.
RHWSL - Red Hat Universal Base Image as a WSL distro. If you have a Red Hat Subscription, you can register and subscribe the system and use it as RHEL.
FedoraWSL - Fedora as a WSL distro.
AmazonWSL - Amazon Linux as a WSL distro.

WSL Tools

X Servers

An X server running on Windows is required for running Linux GUI apps on Windows. See FAQ #9 above.

X410 - X server for Windows 10 on the Microsoft Store. 💰
VcXsrv - X server for Windows with hardware acceleration compiled with Visual Studio.
Xmanager - X server for Windows from NetSarang. 💰
Xming - An older X server for Windows. Has not been updated since 2016.
Cygwin/X - Cygwin/X is a port of the X Window System to the Cygwin API layer for Windows.

Terminals

Windows Terminal - The new open-source Windows Terminal.
wsltty - Mintty as a terminal for WSL.
wsl-terminal - A terminal emulator for WSL, based on mintty, fatty and wslbridge.
Terminus - A terminal for a more modern age.
ConEmu - ConEmu aims to be handy, comprehensive, fast and reliable terminal where you may host any console application for the Windows command line, PowerShell, or WSL.
MobaXterm - Enhanced terminal for Windows with X11 server, tabbed SSH client, network tools and much more.
extraterm - Open source project to build a terminal emulator and expand it with new features to support modern workflows.
Hyper - A terminal built on web technologies.
Terminator - Feature-rich tabbed terminal. Requires X server.

For Managing WSL Installations

LxRunOffline - A full-featured utility for managing WSL.
wslu - A collection of utilities for Windows 10 Linux Subsystem, such as enabling sound in WSL and creating your favorite linux GUI application shortcuts on Windows 10.
Ansible-WSL - Provision WSL using Ansible.

WSL Utilities

wslgit - Use git installed on WSL from Visual Studio Code on Windows.
pinentry-wsl-ps1 - Store passwords for gpg-agent in Windows Credential Manager
wslexec - Execute Linux executables as .exe files on Windows.
wsl-proxy - A collection of 'proxy' batch files that can be used to route requests to the WSL version of a command.
wslpath - Easily convert Windows to WSL path names and vice-versa.
wsl-open - Open files with xdg-open in WSL from Windows applications.
is-wsl for Node - Check if the current process is running inside Windows Subsystem for Linux, useful for scripting.
is_wsl for Python - Check if the current process is running inside Windows Subsystem for Linux, useful for scripting.
wsl-gui-bins - Start common GUI applications under WSL as under Linux.
xclip-xsel-WSL - Make xclip and xsel in WSL read and write on the Windows instead of the Linux clipboard. .
WslShortcut - Run WSL commands directly in Windows. Also allows to use WSL git/node/etc. in Visual Studio Code or another software. Combines functionality of utilities like wslgit, wslnodejs, wslexec etc. with simpler usage.

WSL-Specific Development Tools

wsl-docker-git-setup - Shell script to configure WSL to use docker and docker-compose as well as a git-enabled prompt.
ghc - A version of the Glasgow Haskell Compiler built and optimized for WSL and hosted in a PPA for Debian and Ubuntu-based WSL distros.

Miscellaneous Tools

BootShellCredentialProvider - BSCP lets you boot Windows directly into a Linux desktop experience such as xfce4 using Windows native login and a combination of Xming & WSL upon login.
wsl-dotfiles - Configuration files and scripts for creating an i3-based environment inside WSL.
EnumWSL - Enumerates installed WSL packages.
WSL-DistroLauncher - Reference launcher app for developing your own WSL distribution Microsoft Store package.
WSL_Reverse - Reveal hidden COM interface between WSL and Lxss Manager Service.
wslbridge - wslbridge is a Cygwin program that allows connecting to the WSL command-line environment over TCP sockets, as with ssh, but without the overhead of configuring an SSH server.
WSLInstall - Install any Linux distribution userspace in WSL with compressed RootFS tarballs (tar.gz) or with Docker containers or with ISO files.
cmd-colors-solarized - This is a solarized color scheme for the Windows command prompt that works in WSL.
weasel-pageant - An ssh-agent compatible helper for interacting with Pageant from processes running on the Windows Subsystem for Linux.
wsl2-ssh-pageant - A bridge between Windows Pageant and WSL2.
WinCryptSSHAgent - Using a Yubikey for SSH Authentication on Windows Seamlessly. Supports WSL and WSL2.

Books

Windows Subsystem for Linux: Tactics, Mindset and Tips
Windows Subsystem for Linux (WSL) - In-progress book available on the lean publishing platform leanpub.com.

Additional Resources

Microsoft WSL Official Documentation
Microsoft WSL Blog
Microsoft Console Blog
WSL-Programs - A community powered list of programs that work on the Windows Subsystem for Linux.
/r/bashonubuntuonwindows - Reddit subreddit.
##windows-wsl - IRC channel on Freenode.net.
#debian-wsl - IRC channel on OFTC.net.
WSL on GitHub - For reporting issues with WSL.
The Windows Subsystem for Linux Guide - Third-party WSL resource.
Microsoft User Voice - Send Microsoft feedback on WSL.
Microsoft Developer Feedback - For developers to send Microsoft feeback on WSL.
Portable Node.js guide - Practical guide on how to write portable/cross-platform Node.js code
Stack Overflow: WSL - Programming question and answer site.

Related Projects

Bash - Bash is the GNU Project's shell. Bash is the Bourne Again SHell. Bash is an sh-compatible shell that incorporates useful features from the Korn shell (ksh) and C shell (csh).
Cygwin - Cygwin is a Unix-like environment and command-line interface for Microsoft Windows.
Cmder - A very nice console emulator built on ConEmu.
PuTTY - PuTTY is an SSH and telnet client, developed originally by Simon Tatham for the Windows platform.
PowerShell - PowerShell is a task automation and configuration management framework from Microsoft, consisting of a command-line shell and associated scripting language.
Visual Studio Code - Visual Studio Code ("vscode") is a source code editor developed by Microsoft for Windows, Linux, and macOS. It includes support for debugging, embedded Git control, syntax highlighting, intelligent code completion, snippets, and code refactoring.
Visual Studio 2017 - Visual Studio is an IDE from Microsoft. It is used to develop computer programs, as well as web sites, web apps, web services and mobile apps. Visual Studio uses Microsoft software development platforms such as Windows API, Windows Forms, Windows Presentation Foundation, Windows Store, and Microsoft Silverlight.
Windows Services for UNIX - SFU is a discontinued software package produced by Microsoft which provided a Unix environment on Windows NT and some of its immediate successor operating-systems. TechNet documentation.

More Awesome

More lists.

Thanks

The Windows 10, WSL, and kernel teams at Microsoft, including but not limited to Tara Raj, Rich Turner, Jessie Frazelle, Jack Hammons, Sarah Cooley, Ben Hillis, Allen Sudbring, Brandon Wilson, John Starks, Russ Alexander, Yosef Durr, Sven Groot, Sunil Muthuswamy, Palkesh Soni, John Starks, Craig Wilhite.
Canonical, Debian, SUSE, and Offensive Software.
The Awesome community on GitHub.

Intellectual Property Notices

Linux® is a registered trademark of Linus Torvalds in the United States and/or other countries. *
Windows®, Windows Server®, Windows 10®, Microsoft®, Microsoft Virtual Academy®, Visual Studio®, Azure®, PowerShell®, and MSDN® are trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries. * **
Ubuntu® and Canonical® are registered trademark of Canonical Limited in the United States and/or other countries. *
SUSE® and SUSE Linux Enterprise® are registered trademarks of SUSE in the United States and/or other countries. *
Red Hat®, CentOS®, and Red Hat Enterprise Linux® are trademarks or registered trademarks of Red Hat, Inc. in the United States and/or other countries. *
UNIX® is a trademark of The Open Group. Use of The Open Group trademarks are authorized by The Open Group Trademark Guidelines as "Editorial or Articles, but not Advertising" and/or permitted by trademark fair use under United States law. *
Debian® is a registered trademark of Software in the Public Interest, Inc. in the United States and/or other countries. *
Kali Linux® and Offensive Security® are registered trademarks of OffSec Services, Ltd. *
Docker® and Docker Hub® are registered trademarks of Docker, Inc. *
YouTube® is a registered trademark of Google, LLC. *
macOS® is a registered trademark of Apple, Inc. *
GitHub® and githublogo are a registered trademarks of GitHub, Inc. *
Oracle and Oracle Linux are trademarks or registered tracemarks of Oracle, Inc. *

All other trademarks mentioned herein are the property of their respective owners and may be registered in the United States and/or other countries.

The author of this project has no connection with Microsoft, Inc.

Portions of the descriptions above are from Wikipedia and used under CC BY-SA 4.0 license. Portions of the descriptions above are from Awesome-UNIX and used under CC BY-SA 4.0 license.

This document is licensed under CC BY-SA 4.0 license.

meteoritt/Awesome-WSL