aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a60154d576e36a5c326cbd76e0404f115bef5aa2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# base16-lazygit

<!-- markdownlint-disable MD013 -->

This repo provides templates for using [Base16](https://github.com/tinted-theming/home) color schemes with [lazygit](https://github.com/jesseduffield/lazygit), a simple terminal UI for git commands.

All files in `colors` directory generated by [lustache](https://luarocks.org/modules/olivine-labs/lustache), [lustache-cli](https://github.com/djmattyg007/lustache-cli) and [builder](https://git.sr.ht/~blueingreen/base16-builder).

## Examples

### base16-onedark

![Example lazygit with base16-onedark colorscheme](./examples/img/onedark.png)

### base16-google-light

![Example lazygit with base16-google-light colorscheme](./examples/img/google-light.png)

## Usage

You can find an example config in `examples/config.yml`.

Place this file in:

- Linux: `~/.config/lazygit/config.yml`.
- MacOS: `~/Library/Application\ Support/lazygit/config.yml`.
- Windows: `%LOCALAPPDATA%\lazygit\config.yml` (default location, but it will also be found in `%APPDATA%\lazygit\config.yml`.

### Separating the theme and the configuration

You can use a flag `--use-config-file` to combine multiple configuration files.

```bash
lazygit --use-config-file="$XDG_CONFIG_HOME/lazygit/config.yml,$XDG_DATA_HOME/tinted-theming/tinty/base16-lazygit-colors-file.yml"
```

Or an environment variable `LG_CONFIG_FILE`.

```bash
LG_CONFIG_FILE="$XDG_CONFIG_HOME/lazygit/config.yml,$XDG_DATA_HOME/tinted-theming/tinty/base16-lazygit-colors-file.yml" lazygit
```

## License

MIT