wintermi/zsh-starship

A zsh plugin to use the Starship prompt, along with a powerline theme

zsh-starship

A zsh plugin to manage the Starship prompt, along with providing a default powerline like theme.

Install

Using the ⚡ Zap minimal zsh plugin manager, add the following to your .zshrc

# Install plugin
plug "wintermi/zsh-starship"

Prerequisite Checks

A check will be performed to verify that starship has been installed:

• starship - The minimal, blazing-fast, and infinitely customizable prompt for any shell!

Configure a Custom Theme

This plugin installs its own powerline theme and will default to this unless you override via one of the following two options.

• Setting the STARSHIP_CONFIG environment variable to the location of your custom Starship theme configuration file.
• Custom Starship theme configuration file can be found at $HOME/.config/starship.toml.

As shown in the below examples:

# Example override of the STARSHIP_CONFIG environment variable
export STARSHIP_CONFIG="$HOME/custom_config.toml"
plug "wintermi/zsh-starship"

# Custom configuration file has been created using the default STARSHIP
# location of "$HOME/.config/starship.toml"
plug "wintermi/zsh-starship"

License

The zsh-starship plugin is released under the Apache License 2.0 unless explicitly mentioned in the file header.

zsh-starship's Issues

Documents symbol replacement seemingly broken

I have been feverishly scouring the web to find out what symbol this is supposed to be under the directory substitution. It appears to be https://www.fileformat.info/info/unicode/char/f718/browsertest.htm but I have not been able to find a font that includes this symbol in the typical font packs. I'm using NerdFont Hack and it addresses all of the other symbols except for this one.

Check for default starship file

I'm new to zsh and exploring, but, have previously used starship, so figured this might be a good fit. It took me a bit to figure out why my config was not being picked up, but, I see you expect a STARSHIP_CONFIG variable. I dont use that and use the default ~/.config/starship.toml

It might help others that the default starship file location is also checked before the plugin provided configuration steps in to make it nice right out of the box.

:)