This repo contains files for customizing the Windows Terminal (Powershell, WSL) and VS Code Integrated Terminal using the Starship prompt engine and Nerd Fonts. It also contains custom color scheme for Windows Terminal to go with the custom prompt.
The Starship prompt is Cross-Shell you can use the Starship custom prompt file just about anywhere. However, this guide is geared towards Windows Terminals using PowerShell Core and WSL Ubuntu Bash.
-
Install a Nerd Font
- Nerd Fonts provide the nifty icons which allow you to create custom prompts beyond the basic ASCII.
- The choice is up to you but the one used in the preview pictures is 'IosevkaTerm Nerd Font'.
-
- Mono fonts may cause the icons to become very small
-
Install Starship
- Starship is the prompt engine that is used to build and customize the prompt. It is written in rust and is cross-shell meaning it will work just about anywhere.
- If you are using WSL then this also needs to be done within the distribution if you want the custom prompt to apply there.
-
Configure your shell to use Starship
- For powershell there are several Profile options available that apply the customization in different scopes. To have the prompt apply more universally for your user, update the 'Current User, All Hosts' profile
- If you are using WSL then this also needs to be done within the distribution if you want the custom prompt to apply there.
-
Get a local copy of the customization files
- You can either clone this repository or download a copy locally
-
Configure Starship to use custom prompt
- Make a copy of the Starship TOML file that corresponds to the custom prompt you want and place it in your users .config folder with the name 'starship.toml' (yes, rename it). This method allows you to use the starship file as a starting point for your own customizations with out being tied to the changes made in the repository.
- Alternatively you can point Starship to the specific prompt file you wish to impliment using environment variables. If you cloned the repository this is a good method to keep the file up to date with any changes made in the repository.
- If you are using WSL then this also needs to be done within the distribution if you want the custom prompt to apply there.
-
Configure Windows Terminal to use Nerd Font
- Just focus on the Nerd Font section as the rest of the guid goes into using Oh My Posh prompt engine.
- Windows Terminal > Settings > {defaults | specific profile} > Appearence > Font Face > {Nerd Font you installed}
-
Configure VS Code Integrated Terminal to use Nerd Font
- File > Preferences > Settings > Search Settings 'terminal integrated font family' > Add name of installed Nerd Font