https://github.com/zimfw/s1ck94

A fork of S1cK94's minimal prompt theme.
https://github.com/zimfw/s1ck94

minimal prompt theme zim zimfw zsh zsh-plugin zsh-plugins zsh-prompt zsh-theme

Last synced: about 2 months ago
JSON representation

A fork of S1cK94's minimal prompt theme.

• Host: GitHub
• URL: https://github.com/zimfw/s1ck94
• Owner: zimfw
• License: mit
• Created: 2018-12-28T21:35:10.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-08-13T16:51:19.000Z (over 2 years ago)
• Last Synced: 2024-04-20T18:50:28.881Z (9 months ago)
• Topics: minimal, prompt, theme, zim, zimfw, zsh, zsh-plugin, zsh-plugins, zsh-prompt, zsh-theme
• Language: Shell
• Homepage:
• Size: 18.6 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
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.

['detached HEAD' state]: https://git-scm.com/docs/git-checkout#_detached_head

[prompt-pwd module settings]: https://github.com/zimfw/prompt-pwd/blob/master/README.md#settings

[prompt-pwd]: https://github.com/zimfw/prompt-pwd

[git-info]: https://github.com/zimfw/git-info