zimfw/s1ck94

A fork of S1cK94's minimal prompt theme.

s1ck94

A fork of the (first deprecated, now extinct) minimal prompt by S1cK94.

What does it show?

Let's breakdown the left prompt (from left to right):

• User privilege:
  • On color if root.
  • Off color if not.
• Background jobs:
  • On color if 1 or more jobs in background.
  • Off color if 0 jobs.
• Keymap indicator:
  • On color if in main or vi insert mode.
  • Off color if in vi command mode.
• Exit status:
  • On color if last command returned 0.
  • Error color if not.

On the right prompt:

• The current working directory.
• Git branch name, or commit short hash when in 'detached HEAD' state, only when you are in a git repo. The segment color shows different statues:
  • Error color if dirty or diverged from remote.
  • Yellow if behind.
  • Off color if ahead.
  • On color if none of the above.

Settings

This theme can be customized with the following environment variables. If the variable is not defined, the respective default value is used.

Variable	Description	Default value
PROMPT_CHAR	Prompt character	❯
ON_COLOR	On color	green
OFF_COLOR	Off color	default
ERR_COLOR	Error color	red

Advanced settings

You can customize how the current working directory is shown with the prompt-pwd module settings.

These advanced settings must be overridden after where the theme is initialized.

Requirements

Requires Zim's prompt-pwd module to show the current working directory, and git-info to show git information.

s1ck94's Issues

Please add a license and a screen shot

I'd like to add this to awesome-zsh-plugins, but it doesn't have a license or a screen shot.

Please add a screen shot so people can see what the theme will look like without having to install it.

Also, please add a license, some people won't use any code that doesn't have an open source license. If you don't have one in mind, https://choosealicense.com is a good resource to help you pick one.