https://github.com/marlonrichert/zcolors

🌈 Use your $LS_COLORS to generate a coherent theme for Git & your Zsh prompt, command line and completions.
https://github.com/marlonrichert/zcolors

color completion configuration git lscolors prompt shell terminal theme theming zsh zsh-theme

Last synced: 10 days ago
JSON representation

🌈 Use your $LS_COLORS to generate a coherent theme for Git & your Zsh prompt, command line and completions.

• Host: GitHub
• URL: https://github.com/marlonrichert/zcolors
• Owner: marlonrichert
• License: mit
• Created: 2020-09-23T12:50:46.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-29T10:00:34.000Z (8 months ago)
• Last Synced: 2024-10-19T05:47:45.587Z (18 days ago)
• Topics: color, completion, configuration, git, lscolors, prompt, shell, terminal, theme, theming, zsh, zsh-theme
• Language: Shell
• Homepage:
• Size: 626 KB
• Stars: 78
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🌈 Z Colors

Use your Gnu `$LS_COLORS` or BSD `$LSCOLORS` to generate a coherent theme for `git`, `less`,

`grep`, and your Zsh prompt, completions and command line.  Don't know how to or don't feel like

customizing your colors?  No worries: Z Colors comes with an excellent default theme, too.

> Enjoy this software? [Become a sponsor!](https://github.com/sponsors/marlonrichert)

![screen shot](screenshot.png)

## Usage

Once you've installed Z Colors with the steps [below](#installation), then your theme is

automatically applied to `git`, `less`, `grep` plus Zsh completions and

[command line](#requirements).  No other steps are required for these.

For adding colors to your prompt, Z Colors provides an associative array `$zcolor` containing the

theme values for file types `di`, `ln`, `so`, `pi`, `ex`, `bd`, `cd`, `su`, `sg`, `tw` and `ow`.

You can use it like this:

```zsh

# $'...': string with support for `print` escape codes

# %{%}: Tell the prompt that  is zero-width output.

# %{\e[0m%}: Reset all colors and other highlighting.

# %~: present working dir;  %#: `%` for normal user, `#` for root

PS1=$'%{\e['$zcolor[di]$'m%}%~%{\e[m%}/ %# '

```

## Requirements

If you use `$LS_COLORS`, then the values for `di`, `ln`, `so`, `pi`, `ex`, `bd`, `cd`, `su`, `sg`,

`tw` and `ow` need to contain 3- or 4-bit colors only.  8- and 24-bit colors are currently _not_

supported!

For your theme be used to highlight your command line, you will need to also install

[`zsh-syntax-highlighting`](https://github.com/zsh-users/zsh-syntax-highlighting).

## Installation

Using [Znap](https://github.com/marlonrichert/zsh-snap) **(recommended)**:

1.  In your `~/.zshrc` file, add:

    ```zsh

    znap source marlonrichert/zcolors

    znap eval zcolors "zcolors ${(q)LS_COLORS}"

    ```

1.  To update, do:

    ```zsh

    % znap pull

    ```

Manually:

1.  On the command line, do:

    ```zsh

    % cd ~/Git  # or wherever you keep your Git repos/Zsh plugins

    % git clone https://github.com/marlonrichert/zcolors.git

    % autoload -Uz ~/Git/zcolors/functions/zcolors

    % zcolors >| ~/.zcolors

    ```

1.  In your `~/.zshrc` file, add:

    ```zsh

    source ~/Git/zcolors/zcolors.plugin.zsh

    source ~/.zcolors  # generated in step 1

    ```

1.  To update, do:

    ```zsh

    % git -C ~/Git/zcolors pull

    ```

1.  Whenever you change your `$LS_COLORS`, do:

    ```zsh

    % zcolors >| ~/.zcolors

    ```