matheuscarino/wsl2-notes

Local development environment with Windows + WSL2 + VSCode + Docker Desktop for Windows

WSL2 documentation

About: Local development environment with Windows + WSL2

Install on Powershell as Administrator (Reboot needed)

PS C:\> wsl --install

Define Version 2 of WSL as Default

PS C:\> wsl --set-default-version 2

Comparing WSL 1 and WSL 2 (documentation)

https://learn.microsoft.com/en-us/windows/wsl/compare-versions#whats-new-in-wsl-2

Listing Distros

PS C:\> wsl --list
PS C:\> wsl --list --running      ## Only running Distros
PS C:\> wsl --list --verbose      ## Verbose mode

Converting a GNU/Linux Distro from WSL1 to WSL2

PS C:\> wsl --set-version <distro-name> 2

Running commands

PS C:\> wsl ls ~
PS C:\> wsl cat /etc/os-release

Running commands on a particular distro

> wsl -d <distro-name> ls ~
> wsl -d <distro-name> cat /etc/os-release

Running commands on a particular distro with a specific user

PS C:\> wsl whoami
PS C:\> wsl -u root whoami

Stop a particular distro

PS C:\> wsl --terminate <distro-name>

Shutdown WSL and stop all distros

PS C:\> wsl --shutdown

WSL Configuration files

https://learn.microsoft.com/pt-br/windows/wsl/wsl-config

[ .wslconfig ] [ wsl.conf ]

Windows Terminal Shorcuts

Windows Terminal JSON file settings

settings.json

Create a new instance

CTRL + SHIFT + SPACEBAR

Show the profile list to pick one

CTRL + SHIFT + T

Switch open instances

CTRL + TAB

Launch the profile 1

CTRL + SHIFT + 1

Launch the profile 2

CTRL + SHIFT + 2

Switch to instance 1

CTRL + ALT + 1

Switch to instance 2

CTRL + ALT + 2

Close current instance

CTRL + SHIFT + W

Open Windows Terminal Settings

CTRL + ,

Split current pane horizontally

ALT + SHIFT + -

Split current pane vertically

ALT + SHIFT + +

Create a new instance of the profile from the current pane

ALT + SHIFT + D

Open Palette with multiples options

CTRL + SHIFT + P

Move between panes

ALT + cursor Up ALT + cursor Down ALT + cursor Left ALT + cursor Right

Resizing panes

ALT + SHIFT + cursor Up ALT + SHIFT + cursor Down ALT + SHIFT + cursor Left ALT + SHIFT + cursor Right

Access Linux Distro filesystem from Windows Explorer

\\wsl$

Access Linux Distro filesystem from Powershell

PS C:\> Get-Content '\\wsl$\Ubuntu\home\matheus\hello.txt'

Running Linux applicaions from Windows

$env:SystemRoot = [ C:\Windows ]

PS C:\> Get-Childitem $env:SystemRoot
PS C:\>  Get-Childitem $env:SystemRoot | ForEach-Object { $_.Name.Substring(0,1).ToUpper() }
PS C:\>  Get-Childitem $env:SystemRoot | ForEach-Object { $_.Name.Substring(0,1).ToUpper() } | wsl sort | wsl uniq -c
PS C:\>  Get-Childitem $env:SystemRoot | ForEach-Object { $_.Name.Substring(0,1).ToUpper() } | wsl bash -c "sort | uniq -c"
PS C:\>  wsl ls /usr/bin
PS C:\>  wsl bash -c "ls /usr/bin | cut -c1"
PS C:\>  wsl bash -c "ls /usr/bin | cut -c1-1" | Group-Object

## Accessing Windows files from Linux (WSL2)

NOTE: "Although the Linux side treats the file system as case-sensitive, the underlying Windows file system is still case-insensitive and it is important to keep this in mind."
```bash
$ cat /mnt/c/Users/mathe/lab/wsl2-book/hello.txt

Accessing Windows applicaions from Linux (WSL2)

$ /mnt/c/Windows/System32/calc.exe
$ notepad.exe "c:\\Users\\mathe\\lab\\wsl2-book\\hello.txt"

WSL will map your Windows environment variable PATH to the Linux PATH on all your WSL distros.

$ echo $PATH

Retrive values from Windows Registry from Linux

$ powershell.exe -C "Get-ItemProperty -Path Registry::HKEY_LOCAL_MACHINE\HARDWARE\DESCRIPTION\System"

echo "Matheus" | powershell.exe -noprofile -c 'Write-Host "Hello $input"'

Using symlinks to make Windows path easier to access

$ ln -s /mnt/c/<custom-path>/ .
$ ln -s /mnt/c/Users/mathe/Downloads/ .
$ ln -s /mnt/c/Users/mathe/lab/ .
$ ln -s /mnt/c/Users/mathe/lab/vagrant/ .

Start a default application from WSL distro with wsl utility

$ touch /home/matheus/teste.txt
$ sudo apt install wslu
$ wslview teste.txt 
$ wslview https://wsl.tips

Translating PATHs from Linux format to Windows format

$ wslpath -w ~/teste.txt
\\wsl.localhost\Ubuntu\home\matheus\teste.txt

$ wslpath -w /mnt/c/Windows
C:\Windows

Translating PATHs from Windows format to Linux format (single quotes needed)

$ wslpath -u '\\wsl.localhost\Ubuntu\home\matheus\teste.txt'
/home/matheus/teste.txt

$ wslpath -u 'C:\Windows'
/mnt/c/Windows

Combining wslview with wslpath

$ wslview $(wslpath -w /home/matheus/teste.txt)

Wrap all that into a function for ease of use

$ wslvieww() { wslview $(wslpath -w "$1"); };

Calling this function

$ wslview /home/matheus/teste.txt

Easy way to mapping Windows PATHs on WSL2

$ WIN_PROFILE=$(cmd.exe /C echo %USERPROFILE% 2>/dev/null)
$ WIN_PROFILE_MNT=$(wslpath -u ${WIN_PROFILE/[$'\r\n']})
$ ln -s $WIN_PROFILE_MNT/Downloads ~/Downloads

Windows OpenSSH Authentication Agent

Windows key + R Type it "services.msc" (quotes not needed) Find OpenSSH Authentication Agent, open its Properties (right-click on it). Make sure your settings look like this:

Startup Type: Automatic
Service Status is Running (click Start to do this =)

Generate SSH key pair (If you don't already have one)

$ ssh-keygen -t rsa -b 4096

Include your SSH private key on Windows OpenSSH Authentication Agent

$ ssh-add ~/.ssh/id_rsa

If you have configured your SSH keys to be user to authenticate on Github, you can test it.

# On WLS2 Linux distro
$ ssh -T git@github.com
The authenticity of host 'github.com (20.201.28.151)' can't be established.
ED25519 key fingerprint is SHA256:+FiY3wmmM6TuWWhbpZisF/zDAPL0zPMSvHdkr4UvCOqU.
This key is not known by any other names
Are you sure you want to continue connecting (yes/no/[fingerprint])? yes
Warning: Permanently added 'github.com' (ED25519) to the list of known hosts.
Hi matheuscarino! You've successfully authenticated, but GitHub does not provide shell access.

# On Powershell
PS C:\> ssh -T git@github.com
The authenticity of host 'github.com (20.201.28.151)' can't be established.
ED25519 key fingerprint is SHA256:+FiY3wmmM6TuWWhbpZisF/zDAPL0zPMSvHdkr4UvCOqU.
This key is not known by any other names
Are you sure you want to continue connecting (yes/no/[fingerprint])? yes
Warning: Permanently added 'github.com' (ED25519) to the list of known hosts.
Hi matheuscarino! You've successfully authenticated, but GitHub does not provide shell access.

Rename Windows Terminal Tab on WSL distro

$ function set-prompt() { echo -ne '\033]0;' $@ '\a'; }
$ set-prompt "Novo Título"

Rename Windows Terminal Tab on Powershell

PS C:\> function Set-Prompt {

    param (

        # Specifies a path to one or more locations.

        [Parameter(Mandatory=$true,

                   ValueFromPipeline=$true)]

        [ValidateNotNull()]

        [string]

        $PromptText

    )

    $Host.UI.RawUI.WindowTitle = $PromptText

}
> Set-Prompt "Novo Título 2"

Open Windows Terminal from command line with a custom tab title

PS C:\> wt.exe -p "PowerShell" --title "This one is PowerShell"`; new-tab -p "Ubuntu-20.04" --title "WSL here!"

Windows Terminal

*****new-tab *****split-pane

Windows Terminal Custom profile (automatically connects via SSH)

            {
                "guid": "{9b0583cb-f2ef-4c16-bcb5-9111cdd626f3}",
                "hidden": false,
                "name": "Custom SSH Connection",
                "commandline": "wsl bash -c \"ssh <USER>@<FQDN-or-IPADDRESS>\"",
                "colorScheme": "Ubuntu-sl",
                "background": "#801720"
            },

Install Docker Desktop for Windows

https://docs.docker.com/desktop/install/windows-install/

$ docker info

Run a simple webserver in a container

$ docker run -d --name docker-nginx -p 8080:80 nginx

-d tells Docker to run this container detached from our terminal (to run it in the background); --name specific the name for the container rather than generating a random one; -p map ports on the host to ports inside the running container; nginx the name of the container image to run (if no version is specified, the latest will be used);

Access your browser http://localhost:8080

Listing Containers with status RUNNING

$ docker container ls

Listing ALL Containers (running or not)

$ docker container ls -a

Listing Container images

$ docker image ls

Stop Container

$ docker stop docker-nginx

Remove Container

$ docker rm docker-nginx

Enabling bash completion for Kubernetes (restart shell needed)

$ echo 'source <(kubectl completion bash)' >>~/.bashrc

Removing a WSL distro

PS C:\> wsl --unregister <distro-name>

Visual Studio Code Marketplace

https://marketplace.visualstudio.com/vscode

Visual Studio Code flavors of the remote extensions:

• Remote-WSL • Remote-SSH • Remote-Containers

https://code.visualstudio.com/docs/remote/remote-overview

Visual Studio Code Shortcuts

Open Palette

CTRL + SHIFT + P

Open Explorer bar

CTRL + SHIFT + E

Debugger

F5

Open Run and Debug view

CTRL + SHIFT + D

Add a Breakpoint

F9

Setting up on Git to use VSCode as code editor

On WSL distro (bash)

$ git config --global core.editor "code --wait"

On Windows hostPowershell

PS C:\>git config --global core.editor "code --wait"

$ git log --graph --oneline --decorate --all
$ git config --global --replace-all alias.logtree 'log --graph --oneline --decorate --all'

Open GitK from WSL

$ gitk.exe

Install JSON tool

$ sudo apt-get install jq
$ echo '[1,2,"testing"]' | jq

Working with JSON on Powershell

PS C:\> Get-Content ./<filename>.json | ConvertFrom-Json
PS C:\> Get-Content ./<filename>.json | ConvertFrom-Json | Select-Object -ExpandProperty title

Put JSON content in a variable and call it

PS C:\> $data = Get-Content ./wsl-book.json | ConvertFrom-Json
PS C:\> $data.title
PS C:\> $data.parts | Select-Object -ExpandProperty name
PS C:\> $data.parts | select -ExpandProperty name | ConvertTo-Json
PS C:\> $data.parts | ForEach-Object { @{ "Name" = $_.name } } | ConvertTo-Json
PS C:\> $data.parts | ForEach-Object { @{ "Name" = $_.name; "ChapterCount"=$_.chapters.Count } } | ConvertTo-Json
PS C:\> $data.parts | ForEach-Object { @{ "Name" = $_.name; "Chapters"=$_.chapters | Select-Object -ExpandProperty title } } | ConvertTo-Json

Invoke-WebRequest (curl alternative for Powershell)

PS C:\> $SAMPLE_URL="https://raw.githubusercontent.com/PacktPublishing/Windows-Subsystem-for-Linux-2-WSL-2-Tips-Tricks-and-Techniques/main/chapter-11/02-working-with-json/wsl-book.json"
PS C:\> Invoke-WebRequest $SAMPLE_URL
PS C:\> Invoke-RestMethod $SAMPLE_URL

EXTRA DOCUMENTATION

Universal naming convention (UNC) paths https://learn.microsoft.com/en-us/dotnet/standard/io/file-path-formats

Powershell Execution Policies https://learn.microsoft.com/pt-pt/powershell/module/microsoft.powershell.core/about/about_execution_policies

WSL2-Linux-Kernel https://github.com/microsoft/WSL2-Linux-Kernel

Connecting to GitHub with SSH https://docs.github.com/pt/authentication/connecting-to-github-with-ssh

Testing your SSH connection https://docs.github.com/pt/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection

Install Docker Desktop on Windows https://docs.docker.com/desktop/install/windows-install/

HTTP Status Code https://developer.mozilla.org/en-US/docs/Web/HTTP/Status