DEV Community: Piotr Stapp

6 steps to pimp my terminal

Piotr Stapp — Wed, 02 Jun 2021 09:40:27 +0000

Tools

My current setup is mixed of tools from following list:

oh-my-posh + powerlevel10k_rainbow (with mods) theme + custom font
posh-git
Set-PSReadlineKeyHandler for "bash style" search + autocomplete
PSKubectlCompletion with PSKubeContext for kubernetes
Register-ArgumentCompleter for dotnet
MagicTooltips which is responsible for displaying tooltips for kubectl and az

If you just want to copy-paste, scroll down to the end and copy what you need from my $PROFILE file 😅

Step 1 - standard + small hacks

The posh-git and oh-my-posh modules are quite popular, but will intruce them shortly:

posh-git displays info about git status
oh-my-posh allows to displays a lot of segments (like: time, battery, last exit code, kubernetes, aws, az, ....)

There are numerous themes for oh-my-posh. I'm using powerlevel10k rainbow, but there are missing icons even on the oh-my-posh website. You'll need a unique typeface to get this appearance. Oh-my-posh recommends Meslo LGM NF, but I went with Delugia Nerd Font Complete. Is is a Cascadia Code "Extended", which includes Nerd Fonts and powerline glyphs.

You must "force it" in Windows Terminal JSON after installation (to access settings, press CTRL+, then the gear icon on the left):

 "profiles": 
    {
        "defaults": 
        {
            "fontFace": "Delugia Nerd Font Complete"
        },

The final outcome is awesome:

Finally, remember to include your $PROFILE file (the best approach is to modify it using code $PROFILE if you have VS Code installed):

# posh git
Import-Module-With-Measure posh-git

# oh-my-posh
Import-Module-With-Measure oh-my-posh
Set-PoshPrompt -Theme powerlevel10k_rainbow

Step 2: bash style history search and autocomplete

Do you get tired of typing CTRL+R to look up commands in the history? Is it easier to just use arrows to find the last invocation of kubectl get, for example? I was one of them. Simply add the following to your profile:

# up&down arrow for history search
Set-PSReadLineKeyHandler -Key UpArrow -Function HistorySearchBackward
Set-PSReadLineKeyHandler -Key DownArrow -Function HistorySearchForward

Add one more if you'd like to view all autocomplete options after pressing TAB:

# menu complete using TAB instead of CTRL+SPACE
Set-PSReadlineKeyHandler -Chord Tab -Function MenuComplete

Still not convinced? It's time for a little demonstration:

Yummy 😋

Step 3: Autocomplete

Today I'm only using dotnet and kubernetes autocomplete. I hope that soon I could use also az.
Kubernetes config I described in my last post,

Anyway, the dotnet command is easy:

#dotnet completion
Register-ArgumentCompleter -Native -CommandName dotnet -ScriptBlock {
    param($commandName, $wordToComplete, $cursorPosition)
    dotnet complete --position $cursorPosition "$wordToComplete" | ForEach-Object {
        [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
    }
}

What about Az CLI? The proof of concept is easy, but it isn't a top priority for Azure team 😥, just check GitHub.
The gist is the only thing I've found, but I'm not using it.

If you need more stuff for autocomplete, just search, implement or rewrite bash to PowerShell. No shorthands, sorry 😥

Step 4: Magic tooltips

That's great for displaying dynamic segments. What does this imply? When I type kubectl<SPACE>, for example, I want to see information about Kubernetes context, but I don't need it most of the time. The same goes for az and aws.
The oh-my-posh author guides me to a MagicTooltips module. I'll probably have to submit a PR there to include namespace as well.
Anyway, I choose to set it up as follows:

$global:MagicTooltipsSettings = @{
    VerticalOffset = 0
    HorizontalOffset = 4
    HorizontalAlignment = "Right"
    Providers= @{
        Kubernetes = @{
            Commands = "kubectl,helm,kubens,kubectx,k9s,k"
        }
    }
}
Import-Module MagicTooltips

However, to make your theme seem good, you'll probably need to set HorizontalOffset and VerticalOffset.

My powerlevel 10k setup looks like this (the cluster name is under the clock):

Step 5: find slow modules/segments

I noticed performance issues after installing various extensions. To repair it, I chose to do the following:

remove unused segments in powerlevel theme
measure Import-Module

Step 6: having "sudo" mode

Isn't it awesome to use sudo in a terminal?
I used two functions to implement it:

function fcuk {
    $cmd = (Get-History ((Get-History).Count))[0].CommandLine
    Write-Host "Running $cmd in $PWD"
    start-process pwsh -verb runas -WorkingDirectory $PWD -ArgumentList "-NoExit -Command pushd $PWD; Write-host 'cmd to run: $cmd'; $cmd"
}

function sudo {
    if ($first -eq '!!') {
        fcuk;
    }
    else {
        $file=$args[0];
        [string]$arguments = "";
        if ($args.Count -gt 1) {
            $c = $args.Count - 1;
            [string]$arguments = $args[1..$c]
        }
        Write-Host "file = $file args = $arguments";
        start-process $file -verb runas -WorkingDirectory $PWD -ArgumentList $arguments;
    }
}

My $PROFILE file

Finally, here's what my $PROFILE file looks like:

# helper
function Import-Module-With-Measure {
    param ($ModuleName)
    $import = Measure-Command {
        Import-Module $ModuleName
    }
    Write-Host "$ModuleName import $($import.TotalMilliseconds) ms"
}

# posh git
Import-Module-With-Measure posh-git

# oh-my-posh
Import-Module-With-Measure oh-my-posh
Set-PoshPrompt -Theme powerlevel10k_rainbow

# menu complete using TAB instead of CTRL+SPACE
Set-PSReadlineKeyHandler -Chord Tab -Function MenuComplete
# up&down arrow for history search
Set-PSReadLineKeyHandler -Key UpArrow -Function HistorySearchBackward
Set-PSReadLineKeyHandler -Key DownArrow -Function HistorySearchForward

# kubectl + stuff 
Import-Module-With-Measure PSKubectlCompletion
Set-Alias k -Value kubectl
Register-KubectlCompletion

Import-Module-With-Measure PSKubeContext
Set-Alias kubens -Value Select-KubeNamespace
Set-Alias kubectx -Value Select-KubeContext
Register-PSKubeContextComplete


# magic tooltip config
$global:MagicTooltipsSettings = @{
    VerticalOffset = 0
    HorizontalOffset = 4
    HorizontalAlignment = "Right"
    Providers= @{
        Kubernetes = @{
            Commands = "kubectl,helm,kubens,kubectx,k9s,k"
        }
    }
}
Import-Module MagicTooltips


#dotnet completion
Register-ArgumentCompleter -Native -CommandName dotnet -ScriptBlock {
    param($commandName, $wordToComplete, $cursorPosition)
    dotnet complete --position $cursorPosition "$wordToComplete" | ForEach-Object {
        [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
    }
}

# SUDO functions
function fcuk {
    $cmd = (Get-History ((Get-History).Count))[0].CommandLine
    Write-Host "Running $cmd in $PWD"
    start-process pwsh -verb runas -WorkingDirectory $PWD -ArgumentList "-NoExit -Command pushd $PWD; Write-host 'cmd to run: $cmd'; $cmd"
}

function sudo {
    if ($first -eq '!!') {
        fcuk;
    }
    else {
        $file=$args[0];
        [string]$arguments = "";
        if ($args.Count -gt 1) {
            $c = $args.Count - 1;
            [string]$arguments = $args[1..$c]
        }
        Write-Host "file = $file args = $arguments";
        start-process $file -verb runas -WorkingDirectory $PWD -ArgumentList $arguments;
    }
}

What comes next?

You can also find some interesting configurations at:

Terminal-Icons module - check screenshot
Pimp my terminal by Dominik Jeske - check shortcuts

Maybe you have something useful in your setup? If yes please share!

Make PowerShell with k8s great again

Piotr Stapp — Mon, 31 May 2021 14:16:27 +0000

So, like me, you're using Windows. WSL isn't always reliable (e.g. VPN problems), yet you're working with Kubernetes and require autocomplete tools. I'm the same way :)

Kubectl autocomplete

With bash or zsh, having autocomplete is straightforward. Almost only one command is required to complete the task:

source <(kubectl completion bash)

However, this will obviously not work in PowerShell😅. Especially when you look what and how many lines the kubectl completion bash command produces and how many lines it generates:

kubectl completion bash | wc -l

14143 is the correct answer! To implement autocomplete, more than 14k lines of code were written!
How to use it on Windows? Is it possible to move it? Yes, and thankfully, someone else did the legwork for you: https://github.com/mziyabo/PSKubectlCompletion/blob/master/PSKubectlCompletion.psm1

To use autocomplete we will need the PSKubectlCompletion module. Install it with Install-Module PSKubectlCompletion and include with:

Import-Module PSKubectlCompletion
Set-Alias k -Value kubectl
Register-KubectlCompletion

At this point the basics are working quite well. But how about other tools? Like ...

kubectx and kubens

If you never use the original ones these are two simple commands to switch your current Kubernetes context (kubectx) and namespace (kubens). In PowerShell world they should be named rather like Select-KubeContext and Select-KubeNamespace, but I will you aliases instead 😜

And for above someone else did the work for you once more. It's me this time: https://github.com/ptrstpp950/PSKubeContext
How it works? Just let me present a small YouTube:

Great, isn't it? I'm so glad it works that I made and published a module called PSKubeContext

To utilize it, install it with Install-Module PSKubeContext, and simply add the following to your profile:

Import-Module PSKubeContext
Set-Alias kubens -Value Select-KubeNamespace
Set-Alias kubectx -Value Select-KubeContext
Register-PSKubeContextComplete

What's inside:

Select-KubeContext or if you prefer alias kubectx
Select-KubeNamespace or kubens
100% autocomplete using 🙈🙉🙊
A menu in command line to select the context/namespace if something goes wrong 😅

And that's it. Your PowerShell is great again and works well with Kubernetes CLI.

Improve the performance of git on WSL2

Piotr Stapp — Wed, 19 May 2021 07:24:35 +0000

I've returned to Windows after a year on the Mac. I built up pwsh and added a lot of tools, but I still need some Linux/MacOS ones, such as envsubst. Of course, WSL2 comes to the rescue, but you'll have to checkout the repo twice for Linux and Visual Studio. It is ridiculous.
I set up oh-my-posh with powerline on WSL2, which is a fantastic combination. However, there is a "but": git status is quite slow. What is the reason for this? Just read 4197

How can this be resolved? Simply replace the git command with the git function, as shown below:

function git() {
  if [[ $(pwd -P) = /mnt/* ]]; then
    git.exe "$@"
  else
    command git "$@"
  fi
}

And that's all 🙈🙉🙊