Quickstart

Installation#

Install clrsync for your platform:

Arch Linux: Install clrsync-git from the AUR
NixOS: see Install on NixOS
Fedora/Ubuntu: grab the package from releases (opens in new tab)
Other systems: see manual installation

On Home Manager, keep all clrsync settings (paths, templates, reload commands) in your Home Manager config. Don't edit config.toml by hand or change settings from the GUI. Editing palettes in the GUI is fine.

CLI#

Create a Palette#

Put a palette file in ~/.config/clrsync/palettes. Copying one of the bundled palettes is the easiest start.

Create a Template#

Write a template for your app. There are examples in ~/.config/clrsync/templates:

~/.config/clrsync/templates/kitty.conf:

foreground          {foreground}
background          {background}
selection_foreground {on_surface}
selection_background {editor_selection}
url_color           {accent}

color0  {term0}
color1  {term1}
color2  {term2}
color3  {term3}
color4  {term4}
color5  {term5}
color6  {term6}
color7  {term7}
color8  {term8}
color9  {term9}
color10 {term10}
color11 {term11}
color12 {term12}
color13 {term13}
color14 {term14}
color15 {term15}

Configure clrsync#

Edit ~/.config/clrsync/config.toml:

[general]
default_theme = 'example'
palettes_path = '~/.config/clrsync/palettes'

[templates.kitty]
enabled = true
input_path = '~/.config/clrsync/templates/kitty.conf'
output_path = '~/.config/kitty/theme.conf'
reload_cmd = 'pkill -SIGUSR1 kitty'

Apply Theme#

clrsync_cli --apply

GUI#

Run:

clrsync_gui

A palette editor with live preview, plus a basic text editor for templates.