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 = " "

[tjex]

This should also do it. Unless I'm missing some detail with status -s?

#!/usr/bin/env bash

status=$(git status -s)
if [[ -z "$status" ]]; then
	exit 1
fi
exit 0

[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

[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

[aaronedev]

@rockboynton yea that would b cool like to see something like that!

[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"

[recluse099]

in the same code, just do bg:none @lorens-osman-dev

[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]

@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.

[azzamsa]

~ 🌍
❯

@mickimnet I have no luck finding a way to put the emoji before the > symbol. Do you have any suggestions on what I am missing?

[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.

[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.

[yuzujr]

I believe "require_repo = true when = true" is way more faster than "git rev-parse --is-inside-work-tree" on pwsh,at least on my pc,but i dont know why.

[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!

[obryckim]

Screenshot

Custom Command Script

I wanted to customize my transient prompt to include custom styling (colors).
I created a custom command to do so and then use it in my transient function.

# ~/.config/starship.toml

[custom.mob_transient]
format = "[❯]($style) "
description = "Transient prompt with styling"
style = 'fg:orange'
when = true

# ~/Documents/PowerShell/Microsoft.PowerShell_profile.ps1

# **************************************************
# * starship configuration
# **************************************************

function Invoke-Starship-TransientFunction {
  &starship module custom.mob_transient
}

Invoke-Expression (&starship init powershell)
Enable-TransientPrompt

[joshuadavidthomas]

I've been dabbling in git worktrees for the first time and it annoyed me that I couldn't tell which repo I was in anymore at a glance.

There's no good icon for a git worktree, so I went with the nf-oct-git_pull_request_draft nerd font for draft PRs because it was visually distinctive from the other git icons I'm using and conceptually kinda fits with the worktree.

Screenshot

Custom Command Script

A little bit of duplication between the command and when commands, but it's so short and I didn't feel like abstracting to a separate file, so it is what it is.

format = """
${custom.git_context}\
$all"""

[custom.git_context]
command = """
  MAIN=$(git worktree list --porcelain 2>/dev/null | awk '/^worktree/ {print $2; exit}')
  CURR=$(git rev-parse --show-toplevel 2>/dev/null)
  [ -n "$MAIN" ] && [ "$MAIN" != "$CURR" ] && basename "$MAIN"
"""
format = "[$symbol$output]($style) "
shell = ["sh"]
style = "bold blue dimmed"
symbol = " "
when = """
  MAIN=$(git worktree list --porcelain 2>/dev/null | awk '/^worktree/ {print $2; exit}')
  CURR=$(git rev-parse --show-toplevel 2>/dev/null)
  [ -n "$MAIN" ] && [ "$MAIN" != "$CURR" ]
"""

[jyasskin]

Jujutsu (jj) tree summary

Screenshot

~/src/design-principles 🥋 main 4⇡ @ 1✏️3+4- Small tweaks. 1⇡ registries ❯ jj new t >& /dev/null
~/src/design-principles 🥋 main 5⇡ registries 1⇡ @- Fix Martin's review comments. ❯ echo Test > new_file
~/src/design-principles 🥋 main 5⇡ registries 1⇡ @- Fix Martin's review comments. 1✏️1+0- ❯ jj prev >& /dev/null
~/src/design-principles 🥋 main 5⇡ registries @- Write an example for the lin… ❯ jj prev >& /dev/null
~/src/design-principles 🥋 main 4⇡ @- Small tweaks. 1⇡ registries ❯ echo Test > new_file
~/src/design-principles 🥋 main 4⇡ @- Small tweaks. 1✏️1+0-1⇡ registries ❯ jj prev >& /dev/null
~/src/design-principles 🥋 main 3⇡ @- Redraft to fix review commen… 2⇡ registries ❯ jj edit t >& /dev/null
~/src/design-principles 🥋 main 5⇡ registries 1⇡ @ 1✏️18+11- Fix Martin's review comments. ❯ jj prev --edit >& /dev/null
~/src/design-principles 🥋 main 5⇡ registries @ 1✏️43+0- Write an example for the lin… ❯ jj prev --edit >& /dev/null
~/src/design-principles 🥋 main 4⇡ @ 1✏️3+4- Small tweaks. 1⇡ registries ❯

Custom Command Script

Ideas drawn from https://github.com/jj-vcs/jj/wiki/Starship#alternative-prompt and https://andre.arko.net/2025/06/20/a-jj-prompt-for-powerlevel10k/.

This is designed for linear histories, and the code for bailing on branching histories isn't tested. I also haven't tested it on conflicts, etc, so that bit of the script might not display in the most useful way.

This shows whether you're editing an existing change @ or a scratch change on top of a described change @-. It shows the nearest ancestor and descendent bookmarks, along with how many changes sit between the working copy and those bookmarks. If your current change includes edits, it shows the number of files and lines changed. It uses jj's "label" system to match the colors jj uses for various concepts, even if they're locally customized. jj has colors for conflicts, etc, but I didn't incorporate them.

https://andre.arko.net/2025/06/20/a-jj-prompt-for-powerlevel10k/ does some work to show how local bookmarks have diverged from the remote state, but I didn't include that here.

This is a fairly slow prompt due to the number of jj invocations and the fact that it computes the diffstat.

# ~/.config/starship.toml

[custom.jj]
description = "The current jj status"
when = "jj --ignore-working-copy root"
symbol = "🥋 "
command = 'jj-prompt'

bin/jj-prompt:

#! /usr/bin/env bash

set -eu

# Don't know why the prompt starts bold, but this clears it.
echo -ne '\033[0m'

# Reflect the current repo state, and then don't check it again for the rest of the script.
jj debug snapshot
ARGS="--ignore-working-copy --at-op=@ --no-pager"
LOG="jj log $ARGS --no-graph"

root='trunk()'

function print_delta_to() {
  local target=$1
  local extra_template=${2:-'""'}
  # Replace `wc` with --count after jj v0.36.0.
  down=$(echo $($LOG --color never -r "$target..$root" -T '"n"' | wc -c))
  up=$(echo $($LOG --color never -r "$root..$target" -T '"n"' | wc -c))
  if [ $down -ne 0 -o $up -ne 0 ]; then
    $LOG --limit 1 --color always -r "$target" -T "
      separate(' ',
        concat(
          if($down > 0, label('diff removed', $down ++ '⇣')),
          if($up > 0, label('diff added', $up ++ '⇡'))),
        bookmarks,
        $extra_template
      )++' '"
  fi
  root="$target"
}

# We want to find the nearest bookmarks to the current revision.
# Treat either @ or @- as the "current" revision depending on whether @ has a description.
current=$($LOG --color never --limit 1 -r @ --template 'if(description || parents.len() > 1, "@", "@-")')

$LOG --limit 1 --color always -r 'trunk()' --template 'separate(" ", bookmarks)'
echo -n ' '

parent_branches=($($LOG --color never -r "heads(trunk()..$current- & (bookmarks() | remote_bookmarks()))" -T 'change_id++" "'))
if [ ${#parent_branches[*]} -eq 1 ]; then
  print_delta_to "${parent_branches[0]}"
fi

# Getting the full diff is slower than just the file count, but nice to see.
DIFF_TEMPLATE="concat(
    label('diff modified', self.diff().files().len() ++ '✏️'),
    label('diff added', self.diff().stat().total_added() ++ '+'),
    label('diff removed', self.diff().stat().total_removed() ++ '-'),
  )"

print_delta_to "$current" "separate(' ',
  label('commit node working_copy', '$current'),
  concat(
    if(conflict, '💥'),
    if(divergent, '🚧'),
    if(hidden, '👻'),
    if(immutable, '🔒')),
  if(current_working_copy && self.diff().files().len() > 0, $DIFF_TEMPLATE),
  coalesce(
    truncate_end(29, label('description first_line', description.first_line()), '…'),
    '(no description set)',
  )
)"

if [ $current != "@" ]; then
  $LOG --limit 1 --color always -r '@' --template "if(self.diff().files().len() > 0, $DIFF_TEMPLATE)"
fi

child_branches=($($LOG --color never -r "roots($current:: & (bookmarks() | remote_bookmarks()))" -T 'change_id++" "'))

if [ ${#child_branches[*]} -eq 1 ]; then
  print_delta_to "${child_branches[0]}"
fi

[Syzygy2048]

Screenshot

Custom Command Script

I tend to forget to update pacman/paru, so I want an indicator that there are updates available. I also have a check/popup when I start my system, but usually I just leave it running over night.

# ~/.config/starship.toml

[custom.paru]
when='test (paru -Qu | wc -l) -gt 0'
command='paru -Qu | wc -l'
format='󰮯 +$output'
ignore_timeout = true

The current implementation definitely has issues. It's slow and adds about 2 seconds to every single terminal command. I wrote it yesterday, so I'm not sure yet if it even works without running paru -Sy first. Somehow it messes with the text colors, even on the right side of the prompt (should be white) and it messes with the $character package - since paru -Qu succeeds, I always get the $success_symbol in the center, rather than the $error_symbol, even if my actual command fails.

[thinker227]

Screenshot

Custom Command Script

Shows the Godot version for the project in the current directory (using project.godot).

# ~/.config/starship.toml

[custom.godot]
command = "/bin/godot-version.sh"
detect_files = ["project.godot"]
symbol = ""
style = "blue bold"
format = "[$symbol ($output)]($style) "

/bin/godot-version.sh:

#! /usr/bin/env bash
set -e

path=$(pwd)/project.godot

if [ ! -f $path ]; then
    >&2 echo 'no `project.godot` found in the current directory'
    exit 1
fi

project=$(cat $path)

regex='\[application\][^\[]*config\/features=PackedStringArray\([^\)]*"([0-9]\.[0-9])"'

if [[ $project =~ $regex ]] then
    echo ${BASH_REMATCH[1]}
else
    exit 1
fi

Disclaimer: I'm not a Bash professional, and using regex is a rather hacky solution, but it works alright.

[MrDowntempo]

I just attempted something similar. You can get by without the custom bash script, by just using awk:

command = "awk -F'\"' '/config\\/features/ {print $2}' project.godot"

This has worked on the few projects I've tested it on so far. (though I've not done much godot development yet, so dunno if there could be corner cases where that line has more in it that would throw awk off the mark)

[DmitriyGrebenshikoff]

Screenshot
linux:

windows:

Custom Command Script
Custom sections that show selected config in Yandex Cloud CLI on linux and windows

[custom.yc_linux]
command = 'cat ~/.config/yandex-cloud/config.yaml | grep current |  cut -d " " -f 2'
os = 'linux'
when = true
symbol = ''
style = 'fg:color_fg0 bg:#5282FF'
format = '[ $symbol ($output )]($style)'

[custom.yc_windows]
command = '(cat ~/.config/yandex-cloud/config.yaml | Select-String "current").ToString().split(" ")[1]'
os = 'windows'
when = true
symbol = ''
style = 'fg:color_fg0 bg:#5282FF'
format = '[ $symbol ($output )]($style)'

[quaintops]

I wasn't happy with the aws module because I expect aws context to be presented on my prompt while my aws session is authenticated and active, further acknowledging any solution must not introduce any latency. I created a lightweight service for this purpose. Check it out here: https://github.com/quaintops/starship-aws-monitor

The built-in Starship [aws] module shows AWS info even when credentials are expired. This service solves that by:

• Running as a background systemd service (near-zero prompt latency)
• Checking authentication via STS GetCallerIdentity every 60 seconds
• Writing status to ~/.aws/auth-status for Starship to read
• Only displaying AWS info when actually authenticated

Currently supports systemd only; macOS launchd plist support can be added easily. So far tested mainly with AWS SSO and bash on Debian & Ubuntu.

How It Works

1. The service runs every 60 seconds
2. Calls AWS STS GetCallerIdentity to check authentication
3. Writes JSON status to ~/.aws/auth-status
4. Starship's custom module reads the display field from this file
5. If not authenticated, display is empty and nothing is shown

Starship Configuration

Add this to your ~/.config/starship.toml:

# Disable the built-in AWS module because it shows info even when your session is expired
[aws]
disabled = true

# Custom AWS module that reads from auth-status file
[custom.aws]
command = '''python3 -c "import json; d=json.load(open('$HOME/.aws/auth-status')); print(d.get('display','') if d.get('authenticated') else '')" 2>/dev/null'''
when = "test -f ~/.aws/auth-status"
format = " [$output]($style)"
style = "bold #FF9900"

Then add ${custom.aws} to your format string:

format = """$hostname$directory$git_branch$git_status${custom.aws}$character"""

[ccoVeille]

I was unhappy with the way Go module works, it displays the locally installed Go versions, but it's not useful when working with an old Go library

What is interesting is to display the Go minimal version that can be found in the go.mod or go.work files

[custom.gomod_version]
detect_files = ['go.mod', 'go.work']
symbol = '🐹.mod '
description = 'Display Go module version'
require_repo = true
command = '''
grep -h '^go ' go.work go.mod 2> /dev/null | sed 's/^go /v/'
'''
style = 'bold blue'

This is basic, but show me interesting thing.

This helps me to identify if I can use recent Go feature on a repository

It looks like this for a repository where there is a go.mod file https://github.com/stretchr/testify/blob/65697cefca1d61fba40e001c90d2166be5c8df7f/go.mod#L5 that uses Go 1.17 as a minimal version

The regular Go module, would have displayed "Go 1.25.6" because it's my local version of Go

[sarbagyastha]

Custom Module for Flutter

Screenshot

Custom Command Script

# ~/.config/starship.toml

[custom.flutter]
command = "flutter --version --machine | jq -r '.frameworkVersion + \" \\ue64c v\" + .dartSdkVersion'"
when = "which flutter"
description = "Flutter"
symbol = "\ue7dd v"
ignore_timeout = true
style = "bg:#042B59"
format = '[[ $symbol($output) ](bold fg:cdd6f4 bg:#042B59)]($style)'
detect_extensions = ["dart"]
detect_files = ['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']
detect_folders = ['.dart_tool']

[mellotanica]

Svn branch display

This simple custom module will display the current svn branch the same way as the regular git_branch does (since subversion only has directories and files, tags and nested checked out folders will be treated as branches as well but this will cope properly with standard three folders layouts)

The explicit shell selection is an improvement in my system since standard sh will take 5/6 times more to render.

[custom.svn_branch]
when = "true"
command = 'svn info --no-newline --show-item relative-url "$(svn info --show-item wc-root)" 2> /dev/null | sed -e "s|^\^/||"'
shell = "bash"
description = "Current svn branch"
format = '[( $symbol $output )]($style)'
symbol = '🄪'

[siropkin]

budi — AI coding costs in your prompt

Shows how much you're spending on AI coding agents (Claude Code, Cursor) today / this week / this month:

~/projects/myapp on main via 🐍 v3.14 via 🦀 v1.93  $12.50 · $87.30 · $1.2K
❯

[custom.budi]
command = "budi statusline --format=starship"
when = "command -v budi-daemon"
format = "[$output]($style) "
style = "cyan"
shell = ["sh"]

100% local, written in Rust. https://github.com/siropkin/budi

[alexmajor]

Winget upgrades available

Screenshot

Custom Command Script

This script takes inspiration from OhMyPosh showing Winget Upgrades. It is windows only, of course, and written in PowerShell. I did have to disable timeout but not sure if that is a PowerShell or a Winget issue.

# ~/.config/starship.toml

[custom.winget_upgrade]
description = "Winget upgrades available"
when = true
command = '''
(winget upgrade|?{$_ -match '^\S' -and $_ -notmatch '^-+|Name\s+Id\s+Version|^\d+ upgrades available'}|Measure).Count
'''
shell = ["pwsh", "-NoProfile", "-Command", "-"]
os = "windows"
ignore_timeout = true
symbol = "\uf409 "

[HappyKoalaDev]

Custom module for username

I want to see the username only if I am root or not an initial user (regardless if it is a local host or a remote). But default username module alwayw triggers on SSH.

So the main idea of ​​these modules is to show username only if you are root or not an initial user (regardless if it is a local or remote host). This could have been done with a single module, but I also wanted to highlight root in some different style, so I had to make two modules. If you don't want format root separately, you can combine this into one module. Also you can change formatting (spaces, colors and other). However, only one module always displays the output, so there won't be any duplicates in output.

Performance seems to be pretty good. On my not new machine the module username_other runs on average in 10-15 ms. The username_root runs in 5-10 ms.

# If the current user is root, display in red
[custom.username_root]
command = '[ "$UID" -eq 0 ] && echo "root@"'
when = true
format = "[ $output](bold fg:red bg:gray)"

# If the current user is not initial launched (and not root) -- display
[custom.username_other]
command = '''
# Whenever possible, use variables rather than commands to save milliseconds :)
# - To find current user, use $USER
# - To find the initial user, use logname. A $LOGNAME variable doesn't always value what you need.
if [ "$USER" != $(logname) ] && [ "$USER" != "root" ] ; then
  echo "${USER}@"
fi
'''
when = true
format = "[ $output](bold bg:gray fg:black)"

[ValleytheKnight]

Workaround using a custom module: a script prints the branch name in green/red based on git status --porcelain, wired in via [custom.git_status_colored] with git_branch disabled.

#!/usr/bin/env bash
branch=$(git branch --show-current 2>/dev/null)
[ -z "$branch" ] && exit 0
if [ -z "$(git status --porcelain 2>/dev/null)" ]; then
  color="32"   # green, clean
else
  color="31"   # red, dirty
fi
printf '\e[%sm %s\e[39m' "$color" "$branch"

[git_branch]
disabled = true

[custom.git_status_colored]
command = "~/.config/starship/git_status_colored.sh"
when = "git rev-parse --is-inside-work-tree 2>/dev/null"
shell = ["bash", "--noprofile", "--norc"]
format = "[$output]($style) "

[Faria22]

I made starship-worktrunk, a small custom module for people using Worktrunk.

Worktrunk’s default directory names include the branch name, which can feel redundant when your prompt already shows the branch:

Before: myproject.feature-login/src  feature/login ❯
After:  myproject/src                feature/login ❯

The command calls starship module directory and removes the matching branch suffix from the displayed repository name. Starship still handles the formatting, so you keep your existing [directory] settings—including colors and truncation.

Install

With Rust/Cargo installed:

cargo install --git https://github.com/Faria22/starship-worktrunk --locked

Configure

Replace $directory with ${custom.worktrunk} in your prompt’s format, then add:

[custom.worktrunk]
command = "starship-worktrunk"
when = true
format = "$output "

Keep your existing [directory] section.

Compaction is best-effort and supports Worktrunk’s default repo.branch naming convention. Non-matching paths and detached HEAD retain Starship’s output; transformed or ambiguous names are generally left unchanged. It adds an extra Starship process plus Git discovery per prompt.

Feedback welcome—especially from people with different directory configurations!