Leveling up Windows Powershell with Oh My Posh

whoisryosuke

Ryosuke

Posted on May 19, 2022

Leveling up Windows Powershell with Oh My Posh

I was sitting on YouTube the other day and looking for a quick productivity win, and I stumbled across Scott Hanselman’s video on making the ultimate Windows Terminal. I’ve recently started doing more web and game development on my Windows machine, so I thought I’d give it a shot and see how much better my shell experience could get.

After watching 15 minutes of his video, I was hooked and already tweaking and customizing my theme to my exact needs.

Image description

I thought I’d write about my process and the steps I took to get to my final Terminal setup. The process was similar to “oh my zsh” on Mac if you’re familar with that.

Getting Started

First things first, we need PowerShell. This will work with other shells, but to make this process simple, we’ll start with PowerShell.

Windows 10 comes with a “Windows Powershell”, but it’s not the same as Powershell. You’ll need to download a separate shell if you haven’t already:

  1. Download and install Powershell

⚠️ It’s recommended you use Windows Terminal to manage different shells. That’s a separate download, but it automatically picks up any shells you have (from Windows PowerShell, to PowerShell, to even the WSL (aka Linux) ones. I had to set PowerShell as default in the Windows Terminal settings.

Oh My Posh

Image description

Like oh my zsh for Mac, but for PowerShell. Styles your Powershell and displays extra info (like current Github branch).

Windows | Oh My Posh

How to make the ultimate Terminal Prompt on Windows 11 - This video is LONG and WORDY and DETAILED

Getting Started

  1. Make sure Powershell is installed (see top of this page)
  2. Install oh-my-posh. I used the manual method.
  3. Restart your Powershell (or Windows Terminal).
  4. You should see it! But with broken fonts and missing glyphs…
  5. Install special fonts from NerdFont (basically fonts + glyphs like FontAwesome).
    • You can usually find your favorite coding font (like Fira Code or Jet Brains Mono)
  6. Go to Windows Terminal settings, select Powershell settings, go to Appearance, and change font to the one you downloaded - it will end in NF (e.g. JetBrainsMono NF)
    • You’ll also want to do this for Visual Studio Code if you plan to use the integrated shell/console.
  7. Now things should look correct! 🎆

🎨 Themes

Image description

Browse all the themes here or run Get-PoshThemes. The default themes come pre-installed with oh-my-posh in the $env:POSH_THEMES_PATH.

Install the theme by opening your $PROFILE (or .bashrc for WSL) and changing the oh-my-posh initialization we added earlier with your theme config. Here you can see we’re installing one of the default themes - Night Owl:

oh-my-posh init pwsh --config $env:POSH_THEMES_PATH\night-owl.omp.json | Invoke-Expression
Enter fullscreen mode Exit fullscreen mode

⚠️ You can use echo $PROFILE to see where the profile is, and open it with whatever text editor you prefer.

Protip: I use the code command to open things in VSCode. You can activate this by going to the Command Prompt (CMD + Shift + P) and typing “bash” and installing it from there.

Customize | Oh My Posh

My Theme

Image description

I created a theme based on powerlevel10k_modern and took some modules from night-owl like the CPU monitor, Node version, and PHP version.

Oh My Posh - My Custom Theme (based on powerlevel10k + night-owl)

3rd Party Plugins

These are extra sprinkles on top of Windows Terminal that help enhance the experience (like adding icons or autocomplete to commands).

Autocomplete using history

Predictive intellisense based off your shell history - like a smart search. So if you go to certain folders often, they’ll pop up in the list as you type.

Image description

  1. Install the prelease of the module (requires 2.2.0-beta1 or greater as of 5/17/2022): Install-Module -Name PSReadLine -AllowPrerelease -Scope CurrentUser -Force -SkipPublisherCheck
  2. Add this to your $PROFILE:
# Add auto complete (requires PSReadline 2.2.0-beta1+ prerelease)
Set-PSReadLineOption -PredictionSource History
Set-PSReadLineOption -PredictionViewStyle ListView
Set-PSReadLineOption -EditMode Windows
Enter fullscreen mode Exit fullscreen mode

This wasn’t as simple as the commands sometimes (go figure with prerelease lol) - but these resources helped get things working.

GitHub - PowerShell/PSReadLine: A bash inspired readline implementation for PowerShell

Set-PSReadLineOption : A parameter cannot be found that matches parameter name 'PredictionSource' · Issue #2189 · PowerShell/PSReadLine

Adding Predictive IntelliSense to my Windows Terminal PowerShell Prompt with PSReadline

Terminal Icons

Image description

These are nice icons for the different folders and files you have in development projects. If you’ve used VSCode and installed any icon extensions, you’re probably familiar with this.

  1. Run this command to install the module: Install-Module -Name Terminal-Icons -Repository PSGallery
  2. Add this to your $PROFILE: Import-Module -Name Terminal-Icons
  3. Refresh your PS config by running: . $PROFILE
  4. Try running ls or dir to see the icons!

Thanks again to Scott Hanselman for the tip!:

Take your Windows Terminal and PowerShell to the next level with Terminal Icons

My Final Configuration

For reference, here is the final configuration file for my Windows Terminal (aka $PROFILE). I also added some comments that go over the installation of plugins/modules I mentioned above (just in case).

PowerShell Config - Includes Oh My Posh, Terminal Icons, and Autocomplete with History (requires module see below)

What’s your shell look like?

Now that I’ve dipped my toe in the shell customization water, I’m definitely looking for more inspiration to improve my setup and make it even better. Hit me up on Twitter and share your shell setup, I’d love to see it.

💖 💪 🙅 🚩
whoisryosuke
Ryosuke

Posted on May 19, 2022

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related