Git branches can become very long (e.g. gitlab auto-generated branch names), thus it would be nice to be able to truncate them to keep your prompt lenght in line. This patch adds two new options to the git_branch module: * truncation_length: The amount of graphemes to of a gitbranch to truncate to * truncation_symbol: The symbol that should be used to indicate that a branch name was trunctated To be able to correctly work with UTF-8 graphemes, unicode-segmentation was added as a dependency. |
||
---|---|---|
.. | ||
.vuepress | ||
advanced-config | ||
config | ||
guide | ||
README.md | ||
package-lock.json | ||
package.json |
README.md
home | heroImage | actionText | actionLink | footer |
---|---|---|---|---|
true | /logo.svg | Get Started → | /guide/ | ISC Licensed | Copyright © 2019-present Starship Contributors |
Compatibility First
Works on the most common shells on the most common operating systems. Use it everywhere!
Quick Install
-
Install the starship binary:
Download archives of precompiled binaries if you don't use the platforms below.
Homebrew
$ brew install starship
Rust (v1.33 or higher)
$ cargo install starship
Arch Linux (AUR)
Starship is available on the AUR under the name
starship
. Install it withyay
or your favorite AUR helper.$ yay -S starship
Nix (unstable)
$ nix-env --install starship
Termux
$ pkg install starship
-
Add the init script to your shell's config file:
Bash
Add the following to the end of
~/.bashrc
:# ~/.bashrc eval "$(starship init bash)"
Fish
Add the following to the end of
~/.config/fish/config.fish
:# ~/.config/fish/config.fish eval (starship init fish)
Zsh
Add the following to the end of
~/.zshrc
:# ~/.zshrc eval "$(starship init zsh)"