Share your custom commands/modules!

[tiffafoo]

Heyo Starship Fleet 👋,

I've seen a lot of people use custom commands to make modules that fit their needs. It would be great if we could share them here for others that may want to reuse them!

Here's the template to use to share custom commands:

#### Screenshot

#### Custom Command Script

<!-- An explanation of your script in one or two lines here -->

```toml
# ~/.config/starship.toml

[custom.foo]
command = "echo foo"  # shows output of command
files = ["foo"]       # can specify filters
when = """ test "$HOME" == "$PWD" """
prefix = " transcending "
```

[marekkon]

Screenshot

Custom Command Script

The script below (git-change) checks git for any status changes. If repo is not clean, script returns 0.

#!/usr/bin/zsh

if ! git rev-parse --is-inside-work-tree > /dev/null 2>&1; then
  exit 1
fi

$(git diff-files --no-ext-diff --quiet)
unstaged=$?

$(git diff-index --no-ext-diff --quiet --cached HEAD)
uncommited=$?

untracked=$(git ls-files -o --exclude-standard)

if [[ $unstaged -eq 1 || $uncommited -eq 1 || -n $untracked ]]; then
  exit 0
fi
exit 1

# ~/.config/starship.toml

[custom.dirty]
command = "echo '*'"
when = "git-change"
style = "fg:red"
shell = "zsh"
prefix = ""
suffix = " "

[dalefrancum]

Screenshot

zsh

fish

Custom Command Script

I've been bouncing between zsh and fish, so I wanted a subtle indicator to let me know which shell I was working in. I used external scripts as opposed to trying to make it work inline, since fish has its own syntax for conditional statements.

# ~/.config/starship.toml

[custom.zsh]
command = "echo 🚀"
when = "~/.test_zsh.sh"
prefix = ""

[custom.fish]
command = "echo 🐟"
when = "~/.test_fish.sh"
prefix = ""

~/.test_zsh.sh

#!/usr/bin/env bash

if [ "$STARSHIP_SHELL" == "zsh" ]
then
    echo true
else
    exit 1
fi

~/.test_fish.sh

#!/usr/bin/env bash

if [ "$STARSHIP_SHELL" == "fish" ]
then
    echo true
else
    exit 1
fi

[T-O-R-U-S]

If I may ask, what is your shell font?

[Quantalabs]

Couldn't you have just added echo 🚀 to your .zshrc?

[rockboynton]

I have a similar idea, but slightly different that I haven't seen done yet. I'd like to have the character module set to $ for bash and ❯ for powershell (complete with success and error colors), but I haven't been able to get this to work dynamically...can it be done? Obviously I can have 2 different config files, but I'd rather not resort to that :(

[zzamboni]

@dalefrancum You could use the shell built-in indicator for this: https://starship.rs/config/#shell

[rockboynton]

This shows sorta what I'm thinking (but doesn't work)

[shell]
bash_indicator = "\\$"
powershell_indicator = "❯"

[character.bash]
success_symbol = "[($shell.bash_indicator)](bold green)" # normal prompt
error_symbol = "[($shell.bash_indicator)](bold red)" # used if previous command failed

[character.powershell]
success_symbol = "[($shell.powershell_indicator)](bold green)" # normal prompt
error_symbol = "[($shell.powershell_indicator)](bold green)" # used if previous command failed

[numToStr]

Screenshot

without Dockerfile*

with Dockerfile

Custom Command Script

This is just a visual indicator for me that my current project that I am working on does have docker/docker-compose support. The symbol will only be shown when docker is installed on the machine and the current working directory contains Dockerfile or docker-compose.yml files.

[custom.docker]
description = "Shows the docker symbol if the current directory has Dockerfile or docker-compose.yml files"
command = "echo 🐳"
files = ["Dockerfile", "docker-compose.yml", "docker-compose.yaml"]
when = """ command -v docker &> /dev/null; exit (echo $?); """
prefix = "on "

Related

#393
#477

[jankatins]

Screenshot:

Custom Command Script

This is an alternative to the current git_status module which performs faster in some repos by calling git directly (in one of my cases: <1sec vs 4+ secs). I stole it from spaceship-prompt: https://github.com/denysdovhan/spaceship-prompt/

# ~/.config/starship.toml

format = """
...
$git_branch\
$git_commit\
$git_state\
$git_status\
${custom.git_status}\
...
"""

[git_status]
stashed = ''
# to slow
disabled=true

[custom.git_status]
description = "git status which calls git directly"
command = "~/bin/git_status_prompt.zsh || true"
when = "true"
style = "bold red"
# current master version of how to specify formats
format = "[\\[$output\\]]($style) "
#disabled = true

~/bin/git_status_prompt.zsh:

#!/usr/bin/zsh
# initial code from https://github.com/denysdovhan/spaceship-prompt/blob/master/sections/git_status.zsh

#
# Git status
#


# ------------------------------------------------------------------------------
# Local Config
# ------------------------------------------------------------------------------

# Don't like stashed show up, I usually always have something stashed in the main repo
SPACESHIP_GIT_STATUS_STASHED=""
# coloring happens in starship
SPACESHIP_GIT_STATUS_COLOR=""

# ------------------------------------------------------------------------------
# Utils (from https://github.com/denysdovhan/spaceship-prompt/blob/master/lib/utils.zsh)
# ------------------------------------------------------------------------------

spaceship::is_git() {
  # See https://git.io/fp8Pa for related discussion
  [[ $(command git rev-parse --is-inside-work-tree 2>/dev/null) == true ]]
}



# ------------------------------------------------------------------------------
# Configuration
# ------------------------------------------------------------------------------


SPACESHIP_GIT_STATUS_SHOW="${SPACESHIP_GIT_STATUS_SHOW=true}"
SPACESHIP_GIT_STATUS_PREFIX="${SPACESHIP_GIT_STATUS_PREFIX=" ["}"
SPACESHIP_GIT_STATUS_SUFFIX="${SPACESHIP_GIT_STATUS_SUFFIX="]"}"
SPACESHIP_GIT_STATUS_UNTRACKED="${SPACESHIP_GIT_STATUS_UNTRACKED="?"}"
SPACESHIP_GIT_STATUS_ADDED="${SPACESHIP_GIT_STATUS_ADDED="+"}"
SPACESHIP_GIT_STATUS_MODIFIED="${SPACESHIP_GIT_STATUS_MODIFIED="!"}"
SPACESHIP_GIT_STATUS_RENAMED="${SPACESHIP_GIT_STATUS_RENAMED="»"}"
SPACESHIP_GIT_STATUS_DELETED="${SPACESHIP_GIT_STATUS_DELETED="✘"}"
SPACESHIP_GIT_STATUS_STASHED="${SPACESHIP_GIT_STATUS_STASHED="$"}"
SPACESHIP_GIT_STATUS_UNMERGED="${SPACESHIP_GIT_STATUS_UNMERGED="="}"
SPACESHIP_GIT_STATUS_AHEAD="${SPACESHIP_GIT_STATUS_AHEAD="⇡"}"
SPACESHIP_GIT_STATUS_BEHIND="${SPACESHIP_GIT_STATUS_BEHIND="⇣"}"
SPACESHIP_GIT_STATUS_DIVERGED="${SPACESHIP_GIT_STATUS_DIVERGED="⇕"}"

# ------------------------------------------------------------------------------
# Section
# ------------------------------------------------------------------------------

# We used to depend on OMZ git library,
# But it doesn't handle many of the status indicator combinations.
# Also, It's hard to maintain external dependency.
# See PR #147 at https://git.io/vQkkB
# See git help status to know more about status formats
spaceship_git_status() {
  [[ $SPACESHIP_GIT_STATUS_SHOW == false ]] && return

  spaceship::is_git || return

  local INDEX git_status=""

  INDEX=$(command git status --porcelain -b 2> /dev/null)

  # Check for untracked files
  if $(echo "$INDEX" | command grep -E '^\?\? ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_UNTRACKED$git_status"
  fi

  # Check for staged files
  if $(echo "$INDEX" | command grep '^A[ MDAU] ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_ADDED$git_status"
  elif $(echo "$INDEX" | command grep '^M[ MD] ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_ADDED$git_status"
  elif $(echo "$INDEX" | command grep '^UA' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_ADDED$git_status"
  fi

  # Check for modified files
  if $(echo "$INDEX" | command grep '^[ MARC]M ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_MODIFIED$git_status"
  fi

  # Check for renamed files
  if $(echo "$INDEX" | command grep '^R[ MD] ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_RENAMED$git_status"
  fi

  # Check for deleted files
  if $(echo "$INDEX" | command grep '^[MARCDU ]D ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_DELETED$git_status"
  elif $(echo "$INDEX" | command grep '^D[ UM] ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_DELETED$git_status"
  fi

  # Check for stashes
  if $(command git rev-parse --verify refs/stash >/dev/null 2>&1); then
    git_status="$SPACESHIP_GIT_STATUS_STASHED$git_status"
  fi

  # Check for unmerged files
  if $(echo "$INDEX" | command grep '^U[UDA] ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_UNMERGED$git_status"
  elif $(echo "$INDEX" | command grep '^AA ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_UNMERGED$git_status"
  elif $(echo "$INDEX" | command grep '^DD ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_UNMERGED$git_status"
  elif $(echo "$INDEX" | command grep '^[DA]U ' &> /dev/null); then
    git_status="$SPACESHIP_GIT_STATUS_UNMERGED$git_status"
  fi

  # Check whether branch is ahead
  local is_ahead=false
  if $(echo "$INDEX" | command grep '^## [^ ]\+ .*ahead' &> /dev/null); then
    is_ahead=true
  fi

  # Check whether branch is behind
  local is_behind=false
  if $(echo "$INDEX" | command grep '^## [^ ]\+ .*behind' &> /dev/null); then
    is_behind=true
  fi

  # Check wheather branch has diverged
  if [[ "$is_ahead" == true && "$is_behind" == true ]]; then
    git_status="$SPACESHIP_GIT_STATUS_DIVERGED$git_status"
  else
    [[ "$is_ahead" == true ]] && git_status="$SPACESHIP_GIT_STATUS_AHEAD$git_status"
    [[ "$is_behind" == true ]] && git_status="$SPACESHIP_GIT_STATUS_BEHIND$git_status"
  fi

  # changed
  if [[ -n $git_status ]]; then
  	echo $git_status
  fi
}

spaceship_git_status

[srgvg]

Screenshot

Custom Command Script

Shows which version of ansible is active, assuming ansible gets activated by its source ./hacking/env-setup script.
Other conditions can be tweaked with the when = setting of course.

# ~/.config/starship.toml

[custom.ansible]
description = "Ansible version"
command = "echo -n $(ansible --version 2>/dev/null | grep ^ansible | awk '{ print $2 }') $(which ansible | sed -e s@$HOME/@@ -e s@/bin/ansible@@ -e s@/.virtual_env@@)
when = """ test -n "${ANSIBLE_HOME}" """
files = [ "ansible.cfg" ]
shell = "/bin/bash"
symbol = "Ⓐ "
format = "[$symbol$output]($style) "

[srgvg]

Screenshot

Custom Command Script

Show a marker whilst the sudo timestamp is valid.

# ~/.config/starship.toml

[custom.sudo]
description = "valid sudo timestamp marker"
command = "echo -n '!'"
format = "[$symbol$output]($style) "
style = "bold fg:bright-red"
when = "sudo -vn &>/dev/null"

[stej]

@tyler36 maybe

when = "pwsh -noprofile -command \"exit ([Security.Principal.WindowsIdentity]::GetCurrent().Groups -contains 'S-1-5-32-544' ? 0 : 1)\" "

might work?
but it's slow...

[tyler36]

Thanks for the reply ... I tried your suggestion but it didn't seem to work.
I also flipped the boolean (1 <--> 0 ) which meant it should display when NOT an admin but it didn't display.

Obviously, I'm doing something else wrong. 🤷

[stej]

Thanks for the reply ... I tried your suggestion but it didn't seem to work. I also flipped the boolean (1 <--> 0 ) which meant it should display when NOT an admin but it didn't display.

Obviously, I'm doing something else wrong. 🤷

I reread the doc once again and tried simple script like

[custom.time]
command = "get-date"
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
when = "0"

I guess this should work, but it doesn't. It outputs the date every time.

[stej]

maybe this one #2629

[tyler36]

Thanks for link. I'll keep an eye on it.

[maximousblk]

Screenshot

Custom Command Script

A custom module for displaying Deno version. Before Deno, NodeJS was the only runtime for javascript so any .js, .mjs, .cjs or .ts would mean a NodeJS project so you need to disable the official NodeJS module and use a modified version. The current formatting syntax is not logical so I went with the community "standard" filenames for Deno.

[custom.deno]
command = """ sed "s/deno //g" <<< "$(deno -V)" """
files = ["mod.ts", "deps.ts", "mod.js", "deps.js"]
format = "🦕 [$output](green) "

[custom.node]
command = """ sed "s/v//g" <<< "$(node -v)" """
directories = ["node_modules"]
files = ["package.json"]
format = "node [$output](green) "

FAQ

• Theme: Dracula
• Font: JetBrains Mono

[offbyone]

Screenshot

Custom Command Script

A two-fer to show SSH agent status, if you have or don't have keys available

# ~/.config/starship.toml
[custom.ssh_no_keys]
description = "SSH missing keys"
when = "ssh-add -l | grep -q 'no identities'"
command = "echo 🚫"
format = "$symbol[$output]($style) "
shell = ["bash", "--noprofile", "--norc"]
symbol = "🔑"
style = "bold fg:red"

[custom.ssh_keys]
description = "SSH key count"
when = "ssh-add -l | grep -v -q 'no identities'"
command = "ssh-add -l | grep -v 'no identities' | wc -l"
format = "$symbol[$output]($style) "
shell = ["bash", "--noprofile", "--norc"]
symbol = "🔑"
style = "bold fg:green"

[trajano]

Based off my Q&A #1880 (comment)

This will fill the rest of the line with the background color of your choice.

[custom.bgfill]
command = "echo a"
style="yellow bg:yellow"
when="true"
shell="sh"
format = "[$output\u001B\\[K]($style)"

[lorens-osman-dev]

any way to make the background transparent , basically i want 2 fills :
[fill]
symbol="-"
style = "fg:#4b494f"
[fill]
symbol="*"
style = "fg:#4b494f"

[mickimnet]

Hello everybody,

based on a question on our Discord channel, the following displays a (pseudo) random emoji at your prompt:

Screenshot

Custom Command Script

For a how to use the custom script, please take a look a the configuration->custom-commands section of the documentation.

You can update the EMOJIS variable in the command line of the following script to your personal flavour of emojis. If you change the amount of items in the array, you also need to adjust the number in the EMOJI_INDEX variable, see below.

[custom.emoji]
description = "Displays a (pseudo) random emoji for each prompt"
# change the content of the EMOJIS array to your liking and replace the
# number 12 with the number of items in the array, minus one
command = "EMOJIS=(⛵️ 🛰 🪐 🚀 🧡 🔭 🌍 💫 ☄️ ✨ 🌠 🌌 ⭐️); EMOJI_INDEX=$(( $RANDOM % 12 + 0 )); echo ${EMOJIS[$EMOJI_INDEX]}"
# if you are on windows, replace "true" with "1"
when = "true"
shell = ["bash", "--noprofile", "--norc"]
format = "$output"

[itzmanish]

How did you get the length of emojis?
Tell me so that next time I don't have to count one by one manually 😆

[itzmanish]

@mickimnet Your solution does the job. But is it possible to make migrate my oxide theme emoji to starship?
Like error_prompt emoji is from different set and so on.

[itzmanish]

screenshot:

[mickimnet]

How did you get the length of emojis?

PROMPT_EMOJI=(🐶 🐱 🐭 🐹 🐰 🐻 🐼 🐨 🐯 🦁 🐮 🐷 🐽 🐵 🙈 🙉 🙊 🐒 🐔 🐧 🐦 🐤 🐣 🐥 🐺 🐗 🐴 🦄 🐝 🐛 🐌 🐜 🕷 🦂 🐠 🐟 🐡 🐬 🐳 🐋 🐆 🐅 🐃 🐂 😀 😬 😁 😃 😄 😅 😆 😇 😉 😊 🙂 🙃 😋 😌 😍 😘 😗 😙 😚 😜 😝 😛 🤑 🤓 😎 🤗 😏 😶 😐 😑 😒 🙄 🤔 😳 😞 😟 😠 😔 😕 🙁 😣 😖 😯 😦 😧 😵 😲 🤐 👦 👧 👨 👩 👴 👵 👶 👱 👮 👲 👳 👷 👸 💂); echo ${#PROMPT_EMOJI[@]}

@mickimnet Your solution does the job. But is it possible to make migrate my oxide theme emoji to starship?
Like error_prompt emoji is from different set and so on.

Yes, you can do that by copying the current custom section and changing the when variable to fit the condition you would like the section to be displayed.

[itzmanish]

when = """ test $? == 0 """
This doesn't work.

[westofer]

zsh/bash/fish custom emoji similar to the first post, but not requiring an extra script

[custom.zsh]
command = "echo 🚀"
when = """ test "$STARSHIP_SHELL" "==" "zsh" """
format = "$output"

[custom.bash]
command = "echo  " 
when = """ test "$STARSHIP_SHELL" "==" "bash" """
format = "$output"

[custom.fish]
command = "echo 🐟 "
when = """ test "$STARSHIP_SHELL" = "fish" """
format = "$output"

[westofer]

thanks for the tip. 😃
btw why do you have have "--noprofile". just searched about its use do not load /etc/profile, ~/.bash_profile, etc.

[mickimnet]

Because of speed reasons, I want to omit loading any configuration files for the bash. It just needs to execute the test.

[trajano]

@mickimnet wouldn't using sh be the same as ["bash", "--noprofile", "--norc"]

--noprofile
Do not read either the system-wide startup file /etc/profile or any of the personal initialization files ~/.bash_profile, ~/.bash_login, or ~/.profile. By default, bash reads these files when it is invoked as a login shell (see INVOCATION below).
--norc
Do not read and execute the personal initialization file ~/.bashrc if the shell is interactive. This option is on by default if the shell is invoked as sh.

from https://linux.die.net/man/1/sh

[mickimnet]

@trajano, thanks for the idea. I would need to find a comparison between sh installed on different OS in order to find the common denominator.

[trajano]

I think sh is going to be a common denominator and bash is usually linked to sh which if it is run with sh it will run without the profile. The problem with the noprofile and norc approach is it does not work correctly for me in git for Windows' bash.

[mickimnet]

Show remote Git server

Custom Command Script

Displays a Nerd Font symbol of the location of the remote git.

# ~/.config/starship.toml

[custom.giturl]
# disabled = true
description = "Display symbol for remote Git server"
command = "check-git-remote"
when = 'git rev-parse --is-inside-work-tree 2> /dev/null'
shell = ["bash", "--noprofile", "--norc"]
format = "at $output  "

#!/usr/bin/env bash
## place in your shell path with the name 'check-git-remote'
GIT_REMOTE=$(command git ls-remote --get-url 2> /dev/null)
if [[ "$GIT_REMOTE" =~ "github" ]]; then
    GIT_REMOTE_SYMBOL=" "
elif [[ "$GIT_REMOTE" =~ "gitlab" ]]; then
    GIT_REMOTE_SYMBOL=" "
elif [[ "$GIT_REMOTE" =~ "bitbucket" ]]; then
    GIT_REMOTE_SYMBOL=" "
elif [[ "$GIT_REMOTE" =~ "git" ]]; then
    GIT_REMOTE_SYMBOL=" "
else
    GIT_REMOTE_SYMBOL=" "
fi
echo "$GIT_REMOTE_SYMBOL "

You need to place a ${custom.giturl}\\ entry in the format section at the top of your starship.toml. Fore more information take a look at configuration->custom commands.

[denisgolius]

you are a genius!
I tried to make mine not related to .bashrc so I pasted your code into the command directly
here it is if anyone cares
thanks again Mickimnet !

[custom.giturl]
# disabled = true
description = "Display symbol for remote Git server"
command = """
GIT_REMOTE=$(command git ls-remote --get-url 2> /dev/null)
if [[ "$GIT_REMOTE" =~ "github" ]]; then
    GIT_REMOTE_SYMBOL=" "
elif [[ "$GIT_REMOTE" =~ "gitlab" ]]; then
    GIT_REMOTE_SYMBOL=" "
elif [[ "$GIT_REMOTE" =~ "bitbucket" ]]; then
    GIT_REMOTE_SYMBOL=" "
elif [[ "$GIT_REMOTE" =~ "git" ]]; then
    GIT_REMOTE_SYMBOL=" "
else
    GIT_REMOTE_SYMBOL=" "
fi
echo "$GIT_REMOTE_SYMBOL "
"""
when = 'git rev-parse --is-inside-work-tree 2> /dev/null'
format = "at $output  "

Thanks for you work!
But maybe you know how I can show remote repository ?

[M8torr]

Here is the PowerShell version:

[custom.giturl-pwsh]
# disabled = true
description = "Display symbol for remote Git server (pwsh)"
command = """
$gitRemote = git ls-remote --get-url
$symbol = ' ' # If no Git Remote is returned.
switch -regex ($gitRemote) {\
    'github'    { $symbol = ' ' }\
    'gitlab'    { $symbol = ' ' }\
    'bitbucket' { $symbol = ' ' }\
     Default    { $symbol = ' ' }\
}
echo $symbol
"""
when = "git rev-parse --is-inside-work-tree"
shell = ["pwsh", "-NoProfile", "-Command", "-"]

[ShonLevRan]

How did you copy the symbols? it's shown as a rectangle for me

[trentjmorris]

Thank you so much! Any chance you could share the name of the font you're using in the preview? :)

[mickimnet]

... Any chance you could share the name of the font you're using in the preview? :)

The font I used in the preview is Victor Mono in the Nerd Fonts variation.

[zzhaolei]

Show system icons

need Nerd Font

[custom.system_icons]
description = "Show system icons"
command     = '([ $(uname -s) == "Darwin" ] && echo ) || ([ $(uname -s) == "Linux" ] && echo )'
symbol      = "at"
format      = "[$symbol]() [$output]($style) "
style       = "bold"
shell       = ["bash", "--noprofile", "--norc"]
when        = "true"

[zsimic]

Shows which version of python is currently active (if different from system python), keeping things as compact as possible.

# Using a custom format to highlight current non-system python in a compact manner
# - 🐍: python from virtual env is active
# - 🦎: python from pyenv is active
[custom.py]
command = """ pv=$(python --version | grep -Eo "\\d+\\.\\d+"); if [ -n "$VIRTUAL_ENV" ]; then echo "🐍 $pv"; else echo "🦎 $pv"; fi """
style = "blue"
when = """ [[ -n "$VIRTUAL_ENV" || $PATH =~ /pyenv/ ]] """
shell = ["bash", "--noprofile", "--norc"]

A python from a venv is active:

A python from pyenv is active:

[fitrh]

Just some modification of @mickimnet custom Show remote git server

Screenshot

Custom Command Script

This script just a little modification of the previous script which add the git host after the icon, I don't have enough understanding of bash scripting, so i think they are need an improvement.

#!/bin/sh
# ~/.local/bin/getgithost
IFS="/"
GIT_REMOTE=$(command git ls-remote --get-url 2> /dev/null)
read -ra GIT_HOST <<< "$GIT_REMOTE"

if [[ "$GIT_REMOTE" =~ "github" ]]; then
    GIT_REMOTE_SYMBOL=" "
elif [[ "$GIT_REMOTE" =~ "gitlab" ]]; then
    GIT_REMOTE_SYMBOL=" "
elif [[ "$GIT_REMOTE" =~ "bitbucket" ]]; then
    GIT_REMOTE_SYMBOL=" "
elif [[ "$GIT_REMOTE" =~ "git" ]]; then
    GIT_REMOTE_SYMBOL=" "
else
    GIT_REMOTE_SYMBOL=" localhost"
fi

echo "$GIT_REMOTE_SYMBOL${GIT_HOST[2]}"
IFS=" "

The custom module declaration

# ~/.config/starship/custom-module.toml
[custom.git_host]
command = 'getgithost'
when = 'git rev-parse --is-inside-work-tree 2> /dev/null'
shell = ["bash","--norc","--noprofile"]
style = "bright-yellow bold"
format = "at [$output]($style) "

And then, i put it in the format variable of prompt module

format = """
$username\
$hostname\
$shlvl\
$kubernetes\
${custom.dir}\
${custom.home_dir}\
$directory\
${custom.git_host}\
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
# other module
.
.
.

[Milo123459]

I love your config, what theme & starship config are you using? 👀

[fitrh]

The color scheme called Tokyo Night, and the config that i used in the screenshot is this.
right now i use this config

[thePaulRichard]

@fitrh How you get that 'status bar' at bottom of the terminal? it's tmux? just alacrity?
Can you share this conf? I'd like to use this theme.

[fitrh]

@PauloPaim it is just handcrafted tmux status bar, you can get that satus bar configuration here: tokyonight tmux, just adjust some color if you want to get the same color from the screenshot.

[thePaulRichard]

@fitrh Thanks!

[rod-stuchi]

Ranger shell indicator

Screenshot

Custom Command Script

This module shows if you are in a Ranger shell

# ~/.config/starship.toml

[custom.ranger]
description = "shows if you are in a Ranger shell"
command = "echo 🤠"
when = ''' test -n "${RANGER_LEVEL}" '''

[korochun]

Apple Music now playing

Screenshot

Description

When Apple Music is open and a track is playing, shows the name of the track.

Configuration

# ~/.config/starship.toml

[custom.music]
command = "osascript -e 'tell app \"Music\" to get name of current track'"
when = "[[ $(osascript -e 'application \"Music\" is running') == true && $(osascript -e 'tell application \"Music\" to playing = player state') == true ]]"
shell = "sh"
description = "Shows the name of the currently playing track on Apple Music"
symbol = " "
style = "#fa354f"
format = "to [$symbol($output )]($style)"
os = "macos"

Caveats

Unfortunately, AppleScript is very slow, so the prompt takes around 100 ms when Music is open and up to 400 ms when music is playing. If someone can suggest a way to speed it up, I would be most thankful.

[webbertakken]

Just a suggestion: For slow scripts you could possible run it as an async script as an x seconds cronjob (or app extension / hooks) that writes to a file or kind of storage.

[YurishoSan]

Screenshot

Custom Command Script

Just setup starship for the first time. As I work with TeX I wanted a custom language for it

# ~/.config/starship.toml

[custom.tex]
command = """tex --version | head -n 1 | cut --delimiter=" " --fields=2"""
detect_extensions =  ['tex']
symbol = " "

[seeker5084]

WordPress Logo

Screenshot

Description

Shows WordPress logo and version number.

Configuration

[custom.wordpress]
description = "Shows WordPress logo and version number."
detect_folders = ["wp-includes", "wp-admin", "wp-content"]
when = """ pwd | grep -Eo "/wp-(admin|content|includes)" """
symbol = " "
command = """ WP_FOLDER=$(pwd | grep -Eo "wp-(admin|content|includes)"); WP_FOLDER=${WP_FOLDER:=.}; VER_FILE="${PWD%/$WP_FOLDER*}/wp-includes/version.php"; grep 'wp_version' $VER_FILE | awk -F "'" '{print $2}' """
style = "bright-blue bold"
format = "[$symbol$output]($style) "

Limitations

The logo will be shown when the current working directory is under wp-admin/, wp-content/ or wp-includes/.

[torculus]

MPRIS now playing

Description

Same thing as @korochun's Apple Music, but uses MPRIS on Linux

Configuration

 ~/.config/starship.toml

[custom.mpris]
command = "playerctl metadata --all-players --format \"{{ trunc(title,12) }}: {{ trunc(artist,12) }}\""
when = "playerctl status"
description = "Shows current MPRIS song and artist"
symbol = "♫ "
style = "#fa354f"
format = "[to $symbol($output )]($style)"
os = "linux"

playerctl status is essentially instantaneous on Linux, so there's no performance degradation

[ArjunSahlot]

Know if your system is on FIRE 🔥🔥🔥

Screenshot

Custom Command Script

Checks if the system is on FIRE. Note that this does cause an excessive ~0.3s lag in the prompt each time.

#!/usr/bin/env bash

TEMP=$(sensors | grep -i "Core 1:" | awk '{print $3}' | cut -c 2-3)
CPU_USAGE=$(top -bn1 | grep "Cpu(s)" | sed "s/.*, *\([0-9.]*\)%* id.*/\1/" | awk '{print 100 - $1}')
RAM_USAGE=$(free | grep Mem | awk '{print $3/$2 * 100.0}')
SWAP_USAGE=$(free | grep Swap | awk '{print $3/$2 * 100.0}')
ROOT_USAGE=$(df -h | grep -vE '^Filesystem|tmpfs|cdrom' | awk '{ print $5 " " $1 }' | cut -d'%' -f1 | sed -n 2p)
HOME_USAGE=$(df -h | grep -vE '^Filesystem|tmpfs|cdrom' | awk '{ print $5 " " $1 }' | cut -d'%' -f1 | sed -n 3p)
FAN_SPEED=$(sensors | grep -i cpu_fan | awk '{print $2}')

if [ "$1" == "list" ]; then
    echo "Temp: $TEMP°C"
    echo "CPU Usage: $CPU_USAGE%"
    echo "RAM Usage: $RAM_USAGE%"
    echo "Swap Usage: $SWAP_USAGE%"
    echo "Root Usage: $ROOT_USAGE%"
    echo "Home Usage: $HOME_USAGE%"
    echo "Fan Speed: $FAN_SPEED RPM"
fi

MAX_TEMP=70
MAX_CPU_USAGE=90
MAX_RAM_USAGE=90
MAX_SWAP_USAGE=90
MAX_ROOT_USAGE=85
MAX_HOME_USAGE=85
MAX_FAN_SPEED=3500

compare() {
    echo "$1 > $2" | bc -l
}


if [ $(compare $TEMP       $MAX_TEMP)       -eq 1 ] || \
   [ $(compare $CPU_USAGE  $MAX_CPU_USAGE)  -eq 1 ] || \
   [ $(compare $RAM_USAGE  $MAX_RAM_USAGE)  -eq 1 ] || \
   [ $(compare $SWAP_USAGE $MAX_SWAP_USAGE) -eq 1 ] || \
   [ $(compare $ROOT_USAGE $MAX_ROOT_USAGE) -eq 1 ] || \
   [ $(compare $HOME_USAGE $MAX_HOME_USAGE) -eq 1 ] || \
   [ $(compare $FAN_SPEED  $MAX_FAN_SPEED)  -eq 1 ]; then
    exit 0
else
    exit 1
fi

# ~/.config/starship.toml

[custom.hot]
description = "Check if the system is on FIRE"
when = "hot"
format = "🔥"
disabled = false

[EricDriussi]

Hi there! Just in case it helps, you could also get the average CPU temp instead of the temp from Core number one with this little awk monster:

sensors | awk '/^Core/{gsub(/[°C+]/,"",$3); s+=$3; c++} END {print s/c}'

Similarly, you could get the max CPU temp from sensors itself (again using averages):

sensors | awk '/^Core/{gsub(/[°C+,]/,"",$6); s+=$6; c++} END {print s/c}'

[EricDriussi]

Although come to think about it, my AMD machine doesn't report per-core temps like Intel does, so something like this might be more appropriate (I'm assuming all AMD chips report temps with Tctl, but I'm not 100% on that):

sensors_output="$(sensors)"

if echo "$sensors_output" | grep -q ".*Core.*"; then
	temperature="$(echo "$sensors_output" | awk '/^Core/{gsub(/[°C+]/,"",$3); s+=$3; c++} END {print s/c}')"
	max_temp="$(echo "$sensors_output" | awk '/^Core/{gsub(/[°C+,]/,"",$6); s+=$6; c++} END{print s/c}')"
else
	temperature="$(echo "$sensors_output" | awk '/^Tctl:/{gsub(/[°C+]/,"",$2); print$2}')"
	max_temp="70"
fi

[ArjunSahlot]

Oh nice! awk is a command that's been on my to-do list for a while but I've never gotten around to it. Hopefully this is motivating enough to get me started!

[deepamin1994]

Cisco Anyconnect VPN status

Screenshot

Custom Command Script

Adds a globe icon when Cisco Anyconnect VPN is connected. Just checking the VPN status and looking for word "Connected" in the output string. Works on mac, for other OSes path change will be needed.

# ~/.config/starship.toml
[custom.vpn]
format ='[$symbol ]($style)'
description = 'Show Cisco Anyconnect VPN status'
when = 'test -z "${$(/opt/cisco/anyconnect/bin/vpn status)##*"Connected"*}"'
symbol = '🌐'

[hedgieinsocks]

Not sure if that is a known trick, but if you want some module to occupy its own dedicated line, but only when this module has something to display (another $line_break will show an empty line so it's not an option), you can do something like that:

format = """
$directory\
${custom.kubernetes}\
$line_break\
$character"""

[kubernetes]
disabled = false

[custom.kubernetes]
command = 'printf "\e\n"; starship module kubernetes'
when = '[[ "${KUBECONFIG}" ]]'

[Mortimerp9]

Screenshot

Custom Command Script

Sometimes you are deep in a git repository and starship is truncating the path of your current directory. But it's just called backend, or test, or some other generic name that could be in any of the 100s of repos you have checked out today. Or maybe you deal with a lot of different forks of the same repo.

This custom module will show the (github) repo name of the current git repo so that you know where you are at all times. Think of it as a way to know in what "project" you are.

(note, this just works for github right now as I don't really use any other provider, but feel free to propose some additions)

# ~/.config/starship.toml

[custom.reponame]
require_repo=true
symbol=' '
command="""
git ls-remote --get-url | sed 's#.*:\\(.*\\).git#\\1#'
""" 
description="display the directory root of the current repo"
when=true

[begoon]

Google Cloud Compute VM instance external IP address:

[custom.metadata]
symbol = "| "
disabled = false
command = 'curl -s -H "Metadata-Flavor: Google" http://metadata/computeMetadata/v1/instance/network-interfaces/0/access-configs/0/external-ip'
when = true
format = '[$symbol($output )]($style)'

[mikesmithgh]

I recently released git-prompt-string 📍A shell agnostic git prompt written in Go. git-prompt-string provides an alternate format to starship's git configurations. See git-prompt-string#starship for additional info on configuring it with starship.

See my dotfiles .config/starship.toml for my personal configuration used in the demo above.

Another example:

"$schema" = 'https://starship.rs/config-schema.json'

format = """
$directory\
${custom.git-prompt-string}\
$line_break\
[starship](green) \
[\\$](cyan) \
"""

[custom.git-prompt-string]
command = "git-prompt-string || :"
when = true

[directory]
home_symbol='~'
format = '[$path]($style)'
truncation_length = 0
truncate_to_repo = false
style = "yellow"
use_logical_path = true

Note

Starship will hide custom commands that fail with a non-zero exit code. To prevent this, add || :
or your shell's equvilent command to always return a zero exit code. It is recommended to always
return successfully so that error messages are displayed.

[pBouillon]

Hi all, thanks a lot for the various examples

I am working a lot with Angular and wanted to display the current version of the framework but without success

So far I created the following PowerShell script:

function Find-Angular-File {
    $currentDirectory = Get-Location
    $packageJsonFile = Get-ChildItem -Path $currentDirectory -Recurse -Filter 'package.json' -File | Select-Object -First 1

    if ($packageJsonFile) {
        $packageJson = Get-Content $packageJsonFile.FullName | ConvertFrom-Json
        $angularVersion = $packageJson.dependencies.'@angular/core'
        return $angularVersion
    }

    while ($currentDirectory.Parent) {
        $currentDirectory = $currentDirectory.Parent
        $packageJsonFile = Get-ChildItem -Path $currentDirectory -Filter 'package.json' -File | Select-Object -First 1

        if ($packageJsonFile) {
            $packageJson = Get-Content $packageJsonFile.FullName | ConvertFrom-Json
            $angularVersion = $packageJson.dependencies.'@angular/core'
            Write-Output $angularVersion
        }
    }

    Write-Output $null
}

Find-Angular-File

Which successfully prints either the version (i.e. ^17.3.0) or nothing

I am attempting to add this to my configuration using the following settings:

[custom.angular]
command = "~/.config/starship-scripts/find-angular-version.ps1"
shell = ['pwsh.exe', '-NoProfile', '-Command']
format = "using [\udb81\udebf $output](red)"

Unfortunately, nothing shows up. I would greatly appreciate any advice to make this work!

[porteightyeighty]

Screenshot

Custom Command Script

Relatively niche, but if you use Salesforce CLI regularly, this will show which Salesforce target you are currently authenticated against, with the logo to remind you what it's telling you. If not authenticated, it tells you that too.

It has jq as a "dependency", as it was the easiest way to get the info from Salesforce's CLI.

# ~/.config/starship.toml

[custom.sf]
description = "Salesforce extension"
detect_files = ["sfdx-project.json"]
style = "bold bright-blue"
symbol = " "
command = """value=$(sf config get target-org --json | jq -r '.result[0].value'); if [ "$value" != "null" ]; then echo "$value"; else echo "No Target Org"; fi"""
format = "using [$symbol$output ](bright-blue)"

[JustinBacher]

Show Pacman and AUR updates

I was thinking it would be nice to know if you're due for an update and what better place than the terminal!

Please upvote if you use, helps people find!

Note: I made it cache the results to a file and only refreshes every 5 minutes so there is no delay until it retrieves new values! Just change the rate variable if you'd like it to wait longer. Also there are dependencies so make sure you have them, they are under each heading.

Format

This is how I have mine set up in the picture (it's on the right) I excluded styling for simplicity. If you want the full setup then reply but mine's messy so I din't include it.

right_format = """
...
${custom.pacman_updates}\
${custom.aur_updates}\
...
"""

Pacman Updates

Format: symbol count-of-pac Depends on: pacman-contrib

[custom.pacman_updates]
command = """RATE=5; CACHE_FILE="${HOME}/.cache/pacman_update_count.txt"; write_updates () { echo "$(checkupdates --nocolor | wc -l)"" > $CACHE_FILE; }; if ! test -f $CACHE_FILE; then touch $CACHE_FILE && write_updates; fi; if test `find $CACHE_FILE -mmin +$RATE`; then write_updates; fi; echo "$(<$CACHE_FILE)""""
when = "true"
symbol = "  "
shell = ["bash", "--noprofile", "--norc"]
format = "$symbol$output"

AUR Updates

Format: symbol #-of-aur Depends on: aur-utils

[custom.aur_updates]
command = """RATE=5; CACHE_FILE="${HOME}/.cache/aur_update_count.txt"; write_updates () { echo "$(pacman -Qm | aur vercmp | wc -l)" > $CACHE_FILE; }; if ! test -f $CACHE_FILE; then touch $CACHE_FILE && write_updates; fi; if test `find $CACHE_FILE -mmin +$RATE`; then write_updates; fi; echo "$(<$CACHE_FILE)""""
when = "true"
symbol = "  "
shell = ["bash", "--noprofile", "--norc"]
format = "$symbol$output"

Combined

Format: symbol num-of-pac|num-of-aur Depends on: pacman-contrib and aur-utils

[custom.combined_updates]
command = """RATE=5; CACHE_FILE="${HOME}/.cache/aur_update_count.txt"; write_updates () { echo "$(($(checkupdates --nocolor | wc -l)))|$(($(pacman -Qm | aur vercmp | wc -l)))" > $CACHE_FILE; }; if ! test -f $CACHE_FILE; then touch $CACHE_FILE && write_updates; fi; if test `find $CACHE_FILE -mmin +$RATE`; then write_updates; fi; echo "$(<$CACHE_FILE)""""
when = "true"
symbol = "  "
shell = ["bash", "--noprofile", "--norc"]
format = "$symbol $output"

Total

Format: symbol num-of-pac+aur Depends on: checkupdates-with-aur

[custom.total_updates]
command = """RATE=5; CACHE_FILE="${HOME}/.cache/aur_update_count.txt"; write_updates () { echo "checkupdates-with-aur | wc -l)))" > $CACHE_FILE; }; if ! test -f $CACHE_FILE; then touch $CACHE_FILE && write_updates; fi; if test `find $CACHE_FILE -mmin +$RATE`; then write_updates; fi; echo "$(<$CACHE_FILE)""""
when = "true"
symbol = "  "
shell = ["bash", "--noprofile", "--norc"]
format = "$symbol $output"

[mikesmithgh]

Just as a small tip, you could use the bkt utility to cache the subprocess calls instead of having to implement the caching yourself. That would simplify it quite a bit.

Woah, that is awesome! Never thought of caching like that. 👍

[JustinBacher]

@megalithic See I'm kinda new to linux I never even knew that! I'll definitely switch to that!

[JustinBacher]

@megalithic do you think skate would also be good here?

[majutsushi]

@JustinBacher Are you sure you're tagging the right person? In any case I haven't used skate so I'm not sure how well it would work, but at least for caching purposes it looks like it would require more manual work than bkt would.

[JustinBacher]

Oops, I'm so sorry!

[zyf722]

Add file protocol hyperlink to directory

format = """
${custom.pwd_link_start}\
$directory\
${custom.pwd_link_end}\
"""

[custom.pwd_link_start]
command = 'echo %cd%'  # Change this for other shells or OS
when = true
format = "\u001b\\]8;;[file:$output]()\u001b\\\\"

[custom.pwd_link_end]
format = "\u001b\\]8;;\u001b\\\\"
when = true

#3036 (comment)