The Windows Subsystem for Linux (WSL) is a great solution for developers to natively work within Linux right on their Windows 10 desktop.  Let's go deep in this ultimate guide on how to get started with WSL on Windows 10 in this Ultimate Guide!

If you've spent way too much time partitioning hard drives to have several Linux distros installed with Windows, you're in luck with this article. The fairy code-mother at Microsoft has decided to give you another option: The Windows Subsystem for Linux (WSL). WSL makes running a Linux distribution alongside Windows so much easier, and more flexible.

In this tutorial, you'll learn how to get started with WSL. You'll learn from how to get started all the way to learning how to use some nifty tools making it even more versatile than using bash or PowerShell on their own.

WSL: Linux as a Windows App

WSL or C:\Windows\System32\wsl.exe is a Windows tool that allows you to install a Linux distribution as an app from the Windows store.

Since WSL is a simple Windows executable, you can call it from a cmd command prompt or PowerShell terminal. We'll go deeper into that topic later. For now, it's important to understand a little more about what WSL is doing under the hood.

wsl.exe

WSL vs WSL2

There are two different versions of Windows Subsystem for Linux, WSL and WSL2. If you have the Windows 10 build 18917 or higher, you should run WSL2. Even if you don't, everything else in this post will work for either version.

The main difference between them comes down to system call (syscall); a programmatic way an operating system calls a service.

Syscall can get complicated quickly. I won't go into syscall here, but if you'd like to read more about it check out MSDN article here.

At a high level, when you run a command through WSL, syscall uses a driver to interpret that on the Windows kernel. WSL2 then uses a virtualized Linux kernel that's running in the background and gets updated through Windows update.

WSL2 works a lot more like a traditional virtual machine (VM) where Windows would be the host and the WSL distro is the VM guest.

Here is a high-level summary of how these changes affect calling resources in WSL:

System WSL1 WSL2
Kernel There is no Linux Kernel, calls are translated through a driver written for WSL There is a Linux kernel that installs with WSL
Filesystem The entire directory structure is part of the Windows Filesystem The WSL files are kept in a virtual hard disk
Devices Devices are the same ones your Windows OS uses, calls are ran through a pico driver to interpret them Devices are virtualized through Hyper-V
Network Packets are sent through the same interfaces Windows uses Interfaces are virtualized and packets are routed through a NAT gateway on Windows
Note that at the time of this writing, WSL2 is still not generally available. As such, you might run into problems. To replicate everything in this post, you’ll need a Windows Insiders build and to dig through Microsoft’s Github issues list to get WSL2 to work. Depending on your urgency, you may be better off waiting until WSL2 goes GA. You've been warned!

Setting up WSL

Setting up Windows Subsystem for Linux involves installing a Linux distribution alongside Windows 10. But in a way that allows the two different operating systems to interact with each other.

To install Windows Subsystem for Linux on Windows, the only requirement is that you have a 64-bit Windows 10 device. Different versions of WSL require different builds of Windows, but they can run alongside each other. WSL and WSL2 can be used interchangeably in this post.

If you're going to follow along be sure you have:

  • Windows 10 build 16215 or later (WSL1)
  • Windows build 18917 or later (WSL2)
Note: As WSL is still in active development at the time of writing, some of these features may require builds higher than 16215. As you're following along, pay attention to which build you need for which feature. You may have to check the versions yourself to figure out what if any Windows updates are necessary.

Setting up WSL via Training Video

You'll going to learn below how to set up WSL but if you're more of a visual learner, feel free to watch this TechSnips video on how to get WSL up and running.

If you don't prefer the learn via video on how to set up WSL, read on.

Checking your Windows 10 Build

As mentioned earlier, certain builds of Windows 10 are required for using WSL. To make sure you can use any given version of WSL, first check which build of Windows you are running. There are a few different ways to do this, but the easiest two are from cmd or PowerShell.

Finding Window 10 Build with Cmd

In a command prompt, run systeminfo. Here you will see your Windows 10 operating system version near the top of the results as shown below.

systeminfo

Finding Windows 10 Build with PowerShell

In PowerShell, you can check the Windows registry to find your Windows 10 build. Below is a code snippet you can use for this purpose.

Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion" | Select CurrentBuild

Once you’ve confirmed that you are running a compatible Windows 10 build, you can now download a WSL Linux distro from the Microsoft store. You can install as many distributions of Linux as your device will support and use them with your Windows installation.

Enable the Windows Subsystem for Linux Windows Feature

In an administrative PowerShell console session, run Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux and reboot. This will install the Microsoft Windows Subsystem for Linux Windows feature.

Download the Linux Distro of Choice

Once Windows 10 comes back up, go to the Microsoft store and download a distro of Linux by searching for 'WSL'. Windows Subsystem for Linux does not install distributions by itself, it only allows you to install them after it’s been set up.

The rest of the article will reference a Ubuntu 18.04 distribution But, at the time of this writing, there are other available as well such as:

  • Ubuntu 16.04 LTS
  • Ubuntu 18.04 LTS
  • OpenSUSE Leap 15
  • OpenSUSE Leap 42
  • SUSE Linux Enterprise Server 12
  • SUSE Linux Enterprise Server 15
  • Kali Linux
  • Debian GNU/Linux
  • Fedora Remix for WSL
  • Pengwin
  • Alpine WSL

Updating to WSL2

At the 2019 MS Build conference, Microsoft announced a new version of WSL (WSL2). To the end user, WSL2 was mostly the same as WSL1 with one big difference: WSL2 runs a full Linux kernel instead of emulating system calls to one.

WSL2 is also faster and more compatible with Linux-native applications (or applications that were designed to run only on Linux).

If you are running Windows build 18917 or later and you have WSL already installed, you can update to WSL2 by running Enable-WindowsOptionalFeature -Online -FeatureName VirtualMachinePlatform in a PowerShell terminal with Administrator privileges, then reboot.

Configuring Linux Distros to Work with WSL2

Once your device starts back up, you can start using WSL2 on your existing installed distros. Below you'll see a few steps to run through to configuring your existing Linux distros for WSL2.

  1. Open PowerShell and list which versions of Linux you have installed by running wsl -l or wsl --list.
  2. Once you have the list, copy the name of the distro you want to run with WSL2 and run wsl --set-version <Distro> 2, replacing <Distro> with the name you copied earlier.
  3. Confirm the command was successful by running wsl -l -v or wsl --list --verbose. This command will return a full list of WSL distros and the version each distro is using.
Setting WSL Linux distro
Note that you can also set your default WSL version for any distros you install in the future to WSL2 by running wsl --set-default-version 2

Reverting Linux Distros from WSL2 to WSL1

If you want to revert a distro from WSL2 back to WSL1, run wsl --set-version <Distro> 1, replacing <Distro> with that distro’s name.

Starting up WSL

To start using WSL, open up a PowerShell terminal and type wsl. If you've set up WSL correctly, you’ll enter a bash terminal running on the WSL distro of choice. From here, you can run any Linux commands you wish.

Below you will find a reference to all of the options the wsl.exe provides when starting up.

Arguments for running Linux binaries

Command Explanation Example
exec, -e Will run command using without using default shell wsl -e curl google.com
-- Passes anything after this parameter to default shell. Leaving the operator out will also work. wsl -- curl google.com, wsl curl google.com
distribution, -d Opens a terminal in the specified distribution’s shell wsl -d Ubuntu-18.04
user, -u Runs WSL command as the specified user as long as user exists on that distro wsl -d Ubuntu-18.04 -u tux_user
export Exports the specified distribution to a tar file on your local system. wsl --export Ubuntu ./Test-Ubuntu.tar
import [--version] Imports a tar file as a new WSL distribution. Can specify WSL version with the --version option wsl --import Test-Ubuntu C:\data\Test-Ubuntu .\Test-Ubuntu.tar
list, -l [Options] wsl --list
all List all installed WSL distributions wsl -l --all
running List only WSL distributions that are currently running wsl -l --running
quiet, -q Only show WSL distribution names wsl -l -q
verbose, -v Show detailed information about all WSL distributions wsl -l -v
set-default, -s Sets the specified WSL distribution as the default distribution for WSL commands. wsl -s Test-Ubuntu
set-default-version Changes the default WSL version for all new distributions installed to that system wsl --set-default-version 2
set-version Changes the WSL version of the specified distribution wsl --set-version Test-Ubuntu 2
shutdown Immediately terminates all running WSL distributions wsl --shutdown
terminate, -t Terminates the specified WSL distribution wsl -t Test-Ubuntu
unregister Unregisters the specified WSL distribution wsl --unregister Test-Ubuntu
help Display information about using WSL wsl --help

Once you get comfortable using these switches, you’ll find that running and managing applications through WSL is much easier than managing Linux virtual machines on your own.

Quick tip: Discover all flags and arguments for to WSL by running wsl --help.

When you're finished, type exit to go back back to the PowerShell terminal.

Sharing Windows/Linux Resources via WSL

One of the best parts of WSL is that it allows you to seamlessly share Windows and Linux resources with each other. At this time, you can share file systems, environment variables, network resources and command line interpreters like cmd and PowerShell.

All examples you will see in this section are via the WSL Ubuntu Linux distro. Your mileage may vary if you've chosen to download a different distro.

Sharing File Systems

The file system is one of the most useful things to share with WSL. WSL allows you to work with both file systems as if they were one.

You will find that your Windows 10 file system is mounted as a directory in Linux while your Linux file system will be mounted as a folder in Windows.

Finding the Linux File System from Windows with Environment Variables

When you install a Linux distro with WSL, it will sometimes add a Windows environment variable. In the case of the WSL Ubuntu Linux distro, it will create an environment variable called UBUNTU_HOME. This environment variable points to the Linux /home/ubuntu directory from both Windows and WSL Ubuntu.

The path defined in UBUNTU_HOME can be used to run scripts that use resources across them, or set a default location for the Windows terminal (covered later).

Inspecting the WSL UBUNTU_HOME environment variable

Other distros may define a similar environment variable. It's worth inspecting your Windows environment variables with the PowerShell command Get-ChildItem -Path $Env:\ after installing a new Linux distro to see if any may have been added.

This environment variable shortcut is handy if you want to put everything in the /home/ubuntu directory. But let’s dig a little deeper into how it got there and how else you can reach it.

Finding the Linux File System from Windows via the Microsoft Store Packages Folder

Not every WSL distro is guaranteed to come with an easy way to reference it. It’s important that you learn how to find the Linux file system an alternative way.

Since you will install most WSL Linux distributions from the Microsoft store, you can look for the Linux file system in the same place as other Windows store apps. Navigate to %USERPROFILE%\AppData\Local\Packages\ to find the directory where your Windows store apps go. Then assume control of the folder as this is usually protected by default.

You will see many subfolders in the packages folder where your Linux distrubution file system may be presented. The WSL Ubuntu distro, for example, was under the CanonicalGroupLimited.Ubuntu18.04onWindows_79rhkp1fndgsc folder for me.

If you navigate into the package folder, you will find the Linux file system. For WSL Ubuntu, it's located in the LocalState\rootfs folder. This is the root directory of your Linux distro.

Linux filesystem under %USERPROFILE%/AppData/Local/Packages/

Finding the Windows File System from Linux

To find the Windows 10 file system from Linux, open up WSL in Windows. WSL will then bring up a bash terminal. This bash terminal will start in your UBUNTU_HOME directory by default.

You can also find the root of your Windows storage volumes as well. Each of your Windows letter drives (C, D, E, etc) is treated as a mounted drive from the WSL Linux file system. You'll find each volume mounted as /mnt/c, /mnt/d, etc as long as you have root privileges.

Bash equivalent of running Get-ChildItem C:\Windows\System32 | Select-Object -First 5 running on WSL

The WSL2 Filesystem

Navigating the WSL filesystem is fairly straightforward. Anyone not familiar with a Linux file system structure will appreciate being able to navigate it with the Windows Explorer. Bu if you want to switch to WSL2, it’s going to be a little more complicated.

WSL2 changes how everything works under the hood for sharing file systems. For starters, the filesystem is now a virtual hard disk in vhdx format instead of a directory. You can find the vhdx file under %USERPROFILE%\AppData\Local\Packages\CanonicalGroupLimited.Ubuntu18.04onWindows_79rhkp1fndgsc\LocalState for an WSL Ubuntu distro. Unfortunately though, the rootfs folder is gone unlike WSL1.

Windows Explorer File Navigating not Possible (For Now)

At the time of writing, there is no way to navigate the Windows file system via WSL Linux file system outside of the cp or Copy-Item commands from the terminal.

You'll find that VHDX files can be mounted in Windows with the Disk Manager tool. But, the virtual disks cannot be mounted while the WSL distro is registered.

Sharing Environment Variables

Environment variables are a crucial part of any operating system, making it easy to reference binaries and executables anywhere in your applications.

Before Windows 10 build 17063, the only environment variable shared between Windows 10 and WSL Linux was the PATH variable. Since then it is possible to share environment variables by using WSLENV the environment variable.

Using the WSLENV environment variable to share other environment variables can feel a little meta. To share environment variables across platforms, you actually have to set environment variables inside of another environment variable.

Overview

Sharing environment variables is a three-step process below. The only major difference when sharing across Windows/Linux is the switch argument used (full reference below).

  1. Define environment variable in Windows or Linux.
  2. Set the WSLENV environment variable equal to the previously defined environment variable followed by a switch argument (for path translation).
  3. Read the environment variable in Windows or Linux.

Sharing Options

You can make variables available four different ways depending on which platform you'd like the environment variable to show up on using switches (table shown below).

  • A path in the Windows filesystem to only be available from Windows
  • A path in the WSL filesystem to only be available from WSL
  • A path in the WSL filesystem be available on both WSL Linux and Windows
  • A path in the Windows filesystem be available on both WSL Linux and Windows
Flag Explanation
/p Single path. A variable set with this will be translated between the Windows and WSL Linux and made available to both.
/l List of paths. Similar to /p, except it can accept more than one path. On Windows, this list will be delimited by semicolons while on WSL Linux it will be delimited by colons.
/u Unix path. A path set with this flag can only be accessed when invoking WSL Linux from Windows. Can be used with either the /p or /l flags
/w Windows path. A path set with this flag can only be accessed when invoking Windows from WSL Linux. Can be used with either the /p or /l flags

Path Translation

The main reason to share environment variables is for path translation. As you may already know, Windows has user profile folders as Linux has user profile directories, for example. Each user has a predetermined "home folder" like C:\Users\<username> on Windows and /home/<username> on Linux.

Using the /p and /l switches, the WSL will translate these folder paths between platforms.

Sharing and Translating Windows Paths with Linux

You can share a single path or multiple paths at once using the /p and /l switches.

Assuming you're in a Windows command prompt and you've defined a Windows environment variable called DESKTOP, you will then assign a value of DESKTOP/p to the WSLENV variable to access it from WSL Linux. You can see an example below.

Setting variables in Windows and accessing in Linux

The exact same procedure can be performed for multiple paths at once using the /l switch.

Sharing and Translating Linux Paths with Windows

To share and translate Linux path with Windows is the same procedure as it Windows although using Linux-specific commands to set environment variables.

For a deeper look at sharing environment variables, check out, this Microsoft article.

Sharing Network Resources: WSL Differences Explained

The networking component is another handy resource to share between Windows and WSL Linux. Networking is where WSL gets a little difficult. There are a couple pieces of information you should know about though depending on the version of WSL you are using.

WSL vs WSL2 Networking

You'll find that depending on the version of WSL you're using, networking is going to be completely different. It's important to understand these differences because they can have a major impact on how you develop applications in WSL.

Physical vs. Virtualized Network Interfaces

The most prominent difference is how WSL exposes Windows network interfaces. In WSL1, WSL uses the same physical network interfaces as Windows 10 uses. Using the same network interfaces means that WSL network interfaces will share the same IP addresses as Windows 10 does.

WSL1 networking is fine if you can use the same IP scheme across both Windows and WSL but if you need them to differ, you'll have to use WSL2.

Comparison of Windows and WSL1 IP addresses

In WSL2, the network interfaces are virtualized. Virtualized network interfaces mean that WSL2 network instances can hold different IP configurations than their Windows 10 counterparts.

At the time of this writing, the WSL2 Linux IP addresses are run through Network Address Translation (NAT) to access network resources on Windows, though Microsoft has mentioned removing NAT is high on their backlog of issues to fix.

Same comparison from earlier, but against a WSL2 distro
Client DNS Resolution

WSL and WSL2 will still both generate /etc/resolv.conf and /etc/hosts_ files to allow for DNS resolution. As long as you don’t explicitly override that behavior in /etc/wsl.conf, client DNS resolution will continue to work as expected. You’ll learn more about the wsl.conf file later in the post.

Using PowerShell and Bash Together

One of the coolest features of WSL is the ability to seamlessly pass information to and from PowerShell and Bash on WSL.

PowerShell --> Bash

Since the WSL executable accepts input from the pipeline, you can call the wsl.exe command inside of PowerShell and accept stdin. This allows you to use WSL to pass entire objects from PowerShell into the WSL which then get processed with the bash terminal. You can see an example below.

Passing PowerShell to grep

Bash --> PowerShell/Cmd

You can also pass information from bash in the WSL to PowerShell and cmd just as easily. Below you can see an example of executing the Linux ls command and passing the output to the PowerShell Select-Object cmdlet via the pipeline.

Passing Bash output to PowerShell

You can also call some Windows cmd utilities from the WSL and pass the output back to Linux as long as both commands are in the system path.

Remember that the WSL knows what the system path is on both sides because it has access to the Windows PATH variable by default

Below you can see that you can run ipconfig, which is a Windows command, from within the WSL and pass that output to the Linux grep command. You can also see the opposite of calling the Linux command which and passing output to the Windows ipconfig command.

Executing a Windows command in Linux

Translation Issues

There are some caveats to passing command output back and forth between bash and PowerShell.

One big problem is how PowerShell and bash return information. PowerShell is an object-oriented programming language while bash is a string manipulation tool. Any PowerShell objects piped to bash will flattened as a string. Conversely, any bash output piped to PowerShell will be converted to a string object.

You can get around the behavior somewhat by converting or explicitly casting object types in PowerShell like in the example below. But if you are expecting to pass objects between PowerShell and WSL without any extra work, you're going to be disappointed.

Problems passing objects

By casting the bash date as the [datetime] class in PowerShell, now we have a valid PowerShell object that we can use in our script. If you are writing scripts that need to go from Windows to WSL and back again, it’s possible to do with a little massaging to the code.

Install a Windows Subsystem for Linux GUI with Xfce4

When a command line isn't enough, it's time to break out the GUIs. If you need to run a graphical utility on WSL, explore a custom distro, or you’re not familiar with bash yet, you can install a Linux GUI.

Xfce

Linux has many available desktop environments. One of the most common ones to set up for WSL is called Xfce. At the time of this writing, Xfce is at version 4. Other desktop environments are available but in this article, you'll learn how to get Xfce4 set up.

xRDP

When you have a Linux desktop environment set up, you'll need a service that understands the RDP protocol. In this article, we'll focus on the xRDP server. xRDP is an open source RDP server for Linux that allows you to use RDP clients to connect to Linux just as if you can Windows hosts.

Setting Up

To access a Linux GUI from Windows with Xfce4 and xRDP, follow the instructions below. In a WSL terminal:

  1. Download and install Xfce4 - Download and install Xfce4 using the command sudo apt-get -y install xfce4 && sudo apt-get -y install xubuntu-desktop. This will take a while. Stand by.
  2. Install the xRDP server - Download and install xRDP by running sudo apt-get -y install xrdp.
  3. Configure xRDP for xfce4 - echo xfce4-session > ~/.xsession
  4. Restart xRDP - sudo service xrdp restart
  5. Find the WSL distro IP address - ifconfig | grep inet

At this point, you should be able to open an RDP session from Windows 10. Open up remote desktop connection window using mstsc and provide the Linux IP address found in step #5.

If all goes well, you can open an RDP connection to the Linux distro that’s running on your Windows operating system as shown below.

Windows Subsystem for Linux GUI with Xfce4 and xRDP

Tips and Tricks

Now that you know the basics of WSL and how to use it, what's next? Fortunately there are a lot of tools that are either built for or work well with WSL.

Setting WSL Configuration Items at Bootup with wsl.conf

A configuration file exists in the WSL at /etc/wsl.conf. This file contains configuration settings that run every time the WSL distro is started. When the wsl.conf file exists, WSL will ingest any setting in this file every time the Linux distro is started.

There are a few different sections inside of the wsl.conf file you can configure.

  • Automount - Mounting drives from Windows at start
  • Network - Generate resolv.conf or the hosts file
  • Interop - Enabling or disabling interop with Windows

For more details on the wsl.conf file, check out the Microsoft Set WSL Launch Settings page.

Developing on WSL with Visual Studio Code (VS Code)

VS Code seemingly integrates with everything and WSL is no exception. From within VS Code, you can set up a workspace on your WSL Distro but manipulate it completely with VS Code on Windows. You don't even need to have a terminal running!

To set up VS Code on Windows to work with WSL, you'll first obviously need VS Code for Windows installed. Also be sure you have the Remote - WSL VS Code extension installed.

Once you've got the extension set up, you can now connect to it by opening a WSL terminal and running code <workspace> where <Workspace> is the directory where you'd like to run VS Code from. VS Code will then detect that you are in a WSL distro, open a window, and establish a connection to to the workspace.

Confirm it worked by noticing the WSL connection icon in the lower left corner of VS Code. You should see that it has the name of your WSL distro.

Working with WSL and Visual Studio Code

You can even use the built-in terminal to interact directly with the WSL workspace, so there’s no need to run a separate window for git bash commands.

Adding Windows Subsystem for Linux to the Windows Terminal

Another useful use-case of WSL is to add the WSL console it to the Windows Terminal.

From within Windows Terminal, you add each WSL distro in it’s own tab. You can also customize the look of each tab so you don’t get lost.

If you’re using a WSL distro that sets an environment variable for the user directory like UBUNTU_HOME you learned from earlier in the post, you can also set that as the starting directory for your terminal.

If you'd like a complete video walkthrough on setting up WSL to work with the Windows Terminal, check out the TechSnips how-to video below.

Closing Thoughts

Microsoft released the WSL to allow Linux developers the ability to develop on Windows. So far, the WSL has been a step in the right direction.

It appears that the WSL is going to be a crucial component of Microsoft’s new open-source friendly strategy. If Microsoft is going to take on Apple to be the devices that developers write their code on, it’s going to be an uphill battle, but WSL is a strong card to play.

WSL brings about many many welcome benefits to developers like:

  • Significantly lighter weight than running local Linux VMs
  • Removing the overhead of installing and managing a hypervisor
  • No more requirement for multi-partitioned hard drives
  • No more complicated grub bootloaders

WSL just turns on and runs so we can all code happily ever after.

Further Reading