Skip to content

Blazing fast and slick shell prompt, written in Go

License

Notifications You must be signed in to change notification settings

LucaScorpion/gokart-prompt

Repository files navigation

Gokart Prompt 🏎

Blazing fast and slick shell prompt, written in Go

Build

Screenshot of a terminal with the Gokart prompt

Installation 🚀

First download the archive for your platform from the latest release. Next, follow the steps for your terminal setup:

Oh My Zsh

Extract the archive to $ZSH_CUSTOM/themes:

tar xzvf gokart-prompt-linux-amd64.tar.gz -C "$ZSH_CUSTOM/themes"

Make sure to replace gokart-prompt-linux-amd64.tar.gz with the filename of the archive you downloaded.

Next, symlink gokart.zsh-theme in your $ZSH_CUSTOM/themes directory:

ln -s "$ZSH_CUSTOM/themes/gokart-prompt/gokart.zsh-theme" "$ZSH_CUSTOM/themes/gokart.zsh-theme"

Finally, set ZSH_THEME="gokart" in your .zshrc.

Bash

Extract the archive, for example to your $HOME directory:

tar xzvf gokart-prompt-linux-amd64.tar.gz -C "$HOME"

Make sure to replace gokart-prompt-linux-amd64.tar.gz with the filename of the archive you downloaded.

Finally, source gokart.bash-theme in your .bashrc:

source "$HOME/gokart-prompt/gokart.bash-theme"

Requirements ✅

To check if the font works, run:

echo -e "\xee\x82\xa0"

This should print a "branch" icon.

Features ✨

  • Git branch and status information
  • Command exit code
  • Command execution time1
  • Version information for various tools and languages:
    • Docker
    • .NET
    • Go
    • Java
    • Lua
    • Node.js
    • PHP
    • Python
    • Ruby
    • Rust
  • Expected version and mismatch indicator (⚠️) for:
    • Go (go.mod)
    • Node.js (.nvmrc)

Is something missing? Feel free to open an issue or send a pull request!

Footnotes

  1. Only in Zsh, due to limitations of Bash.