Awesome
<h3 align="center"> <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/> <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/> Catppuccin for <a href="https://github.com/jesseduffield/lazygit">Lazygit</a> <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/> </h3> <p align="center"> <a href="https://github.com/catppuccin/lazygit/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/lazygit?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a> <a href="https://github.com/catppuccin/lazygit/issues"><img src="https://img.shields.io/github/issues/catppuccin/lazygit?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a> <a href="https://github.com/catppuccin/lazygit/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/lazygit?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a> </p> <p align="center"> <img src="assets/preview.webp"/> </p>Previews
<details> <summary>🌻 Latte</summary> <img src="assets/latte.webp"/> </details> <details> <summary>🪴 Frappé</summary> <img src="assets/frappe.webp"/> </details> <details> <summary>🌺 Macchiato</summary> <img src="assets/macchiato.webp"/> </details> <details> <summary>🌿 Mocha</summary> <img src="assets/mocha.webp"/> </details>Installation
Finding your config directory
Lazygit respects XDG (for macOS and Linux), and uses AppData on Windows. So, below are the default config directories:
- Linux:
~/.config/lazygit/config.yml
- MacOS:
~/Library/Application Support/lazygit/config.yml
- Windows:
%APPDATA%\lazygit\config.yml
If you cannot find the config files there, or your changes are not taking effect, you can ask lazygit itself for the config directory:
lazygit --print-config-dir
Keep this directory in mind for all future steps, replacing <config-dir>
when relevant.
Apply the theme
- Clone this repository locally
- Ensure the config directory exists. If it doesn't, you can run
lazygit
to launch and setup the directory.
At this point, you will have to decide how you want to load the theme.
You can either copy it straight into your config.yml
file, or
add flags to lazygit which will merge it from our presets.
If you want to merge with your own config:
-
Choose the flavor you want (from
./themes
) -
Choose the accent you want from within the flavor directory.
-
Replace the
theme
section of<config-dir>/config.yml
with the theme you want to use (fromthemes
).For example, if you want to use the catppuccin mocha theme, with the blue accent, then copy the contents of
<details> <summary>config.yml</summary>themes/mocha/blue.yml
and paste them directly into your lazygitconfig.yml
as follows:
</details>gui: # Use the mocha catppuccin theme theme: activeBorderColor: - '#89b4fa' - bold inactiveBorderColor: - '#a6adc8' optionsTextColor: - '#89b4fa' selectedLineBgColor: - '#313244' selectedRangeBgColor: - '#313244' cherryPickedCommitBgColor: - '#45475a' cherryPickedCommitFgColor: - '#89b4fa' unstagedChangesColor: - '#f38ba8' defaultFgColor: - '#cdd6f4' searchingActiveBorderColor: - '#f9e2af'
-
Close and re-open lazygit to see your new theme!
If you want to use our preset:
- Choose the flavor you want (from
./themes-mergable/
) - Choose the accent you want from within the flavor directory.
- Copy your chosen theme file into
<config-dir>/lazygit
- Change your lazygit startup command (you may want to set a shell alias) to the following:
# This will instruct lazygit to open both config files, merge them, and then boot.
# You can add more config files, delimited by a comma, to this list
# Replacing <your-theme> with the relevant theme file
lazygit --use-config-file="<config-dir>/config.yml,<your-theme>.yml"
# or
LG_CONFIG_FILE="<config-dir>/config.yml,<your-theme>.yml" lazygit
- Close and re-open lazygit to see your new theme!
🙋 FAQ
- Q: "Why is the background wrong?"
A: Lazygit uses your terminal background. You should set it to the relevant background for your theme.
💝 Thanks to
<p align="center"> <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" /> </p> <p align="center"> Copyright © 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a> </p> <p align="center"> <a href="https://github.com/catppuccin/lazygit/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a> </p>