Starship

Starship lets you custimize you command line tool with icons, colors, fonts and more. Starship works well together with Windows Terminal.

Official website: https://starship.rs
Tutorial by Christian Lempa: https://www.youtube.com/watch?v=AK2JE2YsKto

Install Windows Terminal¶

Download and install Windows Terminal.

winget install --id Microsoft.WindowsTerminal -e

Install a Nerd Font¶

To display symbols correctly, we need to install a "Nerd Font", for instance JetBrainsMono Nerd Font.

Install it just like a normal font and set it as default in Windows Terminal. Refer to the configuration documentation for an example config file.

settings.json

{
    "profiles": 
    {
        "defaults": 
        {
            "font": 
            {
                "face": "JetBrainsMonoNL Nerd Font"
            }
        }
    }
}

Install Starship¶

Install Starship using winget.

winget install starship

Configure Starship¶

Create the file C:\Users\<USERNAME>\.config\starship.toml.

starship.toml example

add_newline = true
command_timeout = 1000
format = """$os$username$hostname$kubernetes$directory$git_branch$git_status
$character"""

# Drop ugly default prompt characters
[character]
# success_symbol = ''
success_symbol = '[➜](bold green)'
error_symbol = ''

# ---

[os]
format = '[$symbol](bold white) '   
disabled = false

[os.symbols]
Windows = ''
Arch = '󰣇'
Ubuntu = ''
Macos = '󰀵'

# ---

# Shows the username
[username]
style_user = 'white bold'
style_root = 'black bold'
format = '[$user]($style) '
disabled = false
show_always = true

# Shows the hostname
[hostname]
ssh_only = false
format = '➜ [$hostname](bold yellow) '
disabled = false

# Shows current directory
[directory]
truncation_length = 5
truncation_symbol = '…/'
home_symbol = '󰋜 ~'
read_only_style = '197'
read_only = '  '
format = 'at [$path]($style)[$read_only]($read_only_style) '

# Shows current git branch
[git_branch]
symbol = ' '
format = 'via [$symbol$branch]($style)'
# truncation_length = 4
truncation_symbol = '…/'
style = 'bold green'

# Shows current git status
[git_status]
format = '[$all_status$ahead_behind]($style) '
style = 'bold green'
conflicted = '🏳'
up_to_date = ''
untracked = ' '
ahead = '⇡${count}'
diverged = '⇕⇡${ahead_count}⇣${behind_count}'
behind = '⇣${count}'
stashed = ' '
modified = ' '
staged = '[++\($count\)](green)'
renamed = '襁 '
deleted = ' '

# Shows kubernetes context and namespace
[kubernetes]
format = 'via [󱃾 $context\($namespace\)](bold purple) '
disabled = false

# ---

[vagrant]
disabled = true

[docker_context]
disabled = true

[helm]
disabled = true

[python]
disabled = true

[nodejs]
disabled = true

[ruby]
disabled = true

[terraform]
disabled = true

Download the starship.toml example file.

Initialize Starship¶

Bash¶

Open Bash and type the following to reveal the path to the config file. In should be the user root directory C:\Users\<USERNAME>.
```
echo ~
```
Navigate to that folder and create the file .bash_profile.
```
cd c:\Users\<USERNAME>
```
```
nano .bash_profile
```
Add this code at the bottom of the file:
.bash_profile
```
eval "$(starship init bash)"
```

In Windows Terminal settings.json, add the following code under profiles:

settings.json

"list":
[
    {
        "commandline": "%PROGRAMFILES%/Git/bin/bash.exe -i -l",
        "guid": "{1fc853bf-83b3-4555-9230-8b010466f547}",
        "hidden": false,
        "icon": "C:\\Users\\<USERNAME>\\Windows Terminal Icons\\icons8-git-100-white.png",
        "name": "Git Bash",
        "startingDirectory" : "%USERPROFILE%"
    }
]

The icon property is optional.

Command Prompt (cmd)¶

Install Clink.
```
winget install clink
```
Open the scripts directory C:\Users\<USERNAME>\AppData\Local\clink. Read more about file locations on the documentation page if you experienses problems.
Create the file starship.lua and add the following code:
starship.lua
```
load(io.popen('starship init cmd'):read("*a"))()
```

PowerShell¶

Open a PowerShell prompt and open the profile file in VS Code.
```
code $PROFILE
```
Add the following code.
Microsoft.PowerShell_profile.ps1
```
Invoke-Expression (&starship init powershell)
```