clrsync/README.md

clrsync

Notice: This application is not yet released and is subject to change.
Deb, RPM, and AUR packages, as well as a Windows installer, will be available soon.

A theme management tool for synchronizing color schemes across multiple applications. clrsync allows to define color palettes once and apply them consistently to all configurable applications.

Features

• Unified Color Management: Define color palettes in TOML format and apply them across multiple applications
• CLI & GUI: Choose between a command-line interface or a graphical editor
• Live Reload: Define post-apply hooks (configurable per template)
• Flexible Color Formats: Support for HEX, RGB, HSL with multi-component access (e.g., {color.r}, {color.hex}, {color.hsl})
• Pre-built Themes: Includes popular themes

Installation

NixOS

Home Manager Module

1. Add clrsync to your flake inputs

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    home-manager.url = "github:nix-community/home-manager";
    
    clrsync.url = "github:obsqrbtz/clrsync";
  };
}

2. Import the Home Manager module

In home.nix:

  imports = [
    inputs.clrsync.homemanagermodules.default
  ];

3. Configure in home manager

programs.clrsync = {
  enable = true;
  package = inputs.clrsync.packages.x86_64-linux.default;  
  defaultTheme = "dark";
  palettesPath = "~/.config/clrsync/palettes";
  font = "JetBrainsMono Nerd Font Mono";
  fontSize = 14;
  applyTheme = true;

  templates = {
    kitty = {
      enabled = true;
      inputPath = "~/.config/clrsync/templates/kitty.conf";
      outputPath = "~/.config/kitty/clrsync.conf";
      reloadCmd = "pkill -SIGUSR1 kitty";
    };
    
    rofi = {
      enabled = true;
      inputPath = "~/.config/clrsync/templates/rofi.rasi";
      outputPath = "~/.config/rofi/clrsync.rasi";
    };
  };
};

4. Rebuild

home-manager switch --flake .

Package (For non-declarative configurations)

1. Add clrsync to your flake inputs

{
  inputs = {
    clrsync.url = "github:obsqrbtz/clrsync";
  };
}

2. Install the package

# In NixOS configuration.nix:
environment.systemPackages = [
  inputs.clrsync.packages.x86_64-linux.default
];

# Or in Home Manager:
home.packages = [
  inputs.clrsync.packages.x86_64-linux.default
];

3. Use the app manually

clrsync_gui

# or
clrsync_cli --apply --theme dark

Other systems

Follow the steps from Building section then install with cmake:

cd build
cmake --install .

Building

Prerequisites

• C++20 compatible compiler (GCC, Clang, or MSVC)
• CMake
• OpenGL
• glfw
• fontconfig
• freetype

With CMake

mkdir build && cd build
cmake ..
cmake --build .

Configuration

Edit or create a configuration file at ~/.config/clrsync/config.toml:

[general]
palettes_path = "~/.config/clrsync/palettes"
default_theme = "cursed"

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

Palette Files

Create palette files in your palettes_path directory:

# ~/.config/clrsync/palettes/dark.toml
[general]
name = 'cursed'

[colors]
accent = '#B44242FF'
background = '#151515FF'
base00 = '#151515FF'
base01 = '#B44242FF'
base02 = '#95A328FF'
base03 = '#E1C135FF'
base04 = '#60928FFF'
base05 = '#7C435AFF'
base06 = '#A48B4AFF'
base07 = '#C2C2B0FF'
base08 = '#3F3639FF'
base09 = '#DC7671FF'
base0A = '#E8E85AFF'
base0B = '#9E9052FF'
base0C = '#76C39BFF'
base0D = '#86596CFF'
base0E = '#CEB34FFF'
base0F = '#B0AFA8FF'
border = '#3F3639FF'
border_focused = '#E1C135FF'
cursor = '#E1C135FF'
editor_background = '#151515FF'
editor_command = '#CEB34FFF'
editor_comment = '#3F3639FF'
editor_disabled = '#3F3639FF'
editor_emphasis = '#DC7671FF'
editor_error = '#B44242FF'
editor_inactive = '#3F3639FF'
editor_line_number = '#86596CFF'
editor_link = '#60928FFF'
editor_main = '#C2C2B0FF'
editor_selected = '#3F3639FF'
editor_selection_inactive = '#2A2A2AFF'
editor_string = '#76C39BFF'
editor_success = '#95A328FF'
editor_warning = '#E1C135FF'
error = '#B44242FF'
foreground = '#C2C2B0FF'
info = '#60928FFF'
on_background = '#C2C2B0FF'
on_error = '#151515FF'
on_info = '#151515FF'
on_success = '#151515FF'
on_surface = '#C2C2B0FF'
on_surface_variant = '#C2C2B0FF'
on_warning = '#151515FF'
success = '#95A328FF'
surface = '#1C1C1CFF'
surface_variant = '#1C1C1CFF'
warning = '#E1C135FF'

Template Files

Create template files at ~/.config/clrsync/templates using color variables:

# ~/.config/clrsync/templates/kitty.conf
cursor              {cursor}
cursor_text_color   {background}
foreground            {foreground}
background            {background}
selection_foreground  {on_surface}
selection_background  {surface}
url_color             {accent}
color0      {base00}
color8      {base08}
color1      {base01}
color9      {base09}
color2      {base02}
color10     {base0A}
color3      {base03}
color11     {base0B}
color4      {base04}
color12     {base0C}
color5      {base05}
color13     {base0D}
color6      {base06}
color14     {base0E}
color7      {base07}
color15     {base0F}

Color Format Specifiers

Format colors using dot notation:

# HEX formats
{color}                    # Default: #RRGGBB
{color.hex}                # #RRGGBB
{color.hex_stripped}       # RRGGBB
{color.hexa}               # #RRGGBBAA
{color.hexa_stripped}      # RRGGBBAA

# RGB components (0-255)
{color.rgb}                # rgb(r, g, b)
{color.r}                  # Red component
{color.g}                  # Green component
{color.b}                  # Blue component

# RGBA (alpha normalized 0-1)
{color.rgba}               # rgba(r, g, b, a)
{color.a}                  # Alpha component

# HSL (hue 0-360, saturation/lightness 0-1)
{color.hsl}                # hsl(h, s, l)
{color.h}                  # Hue component
{color.s}                  # Saturation component
{color.l}                  # Lightness component

# HSLA (hue 0-360, saturation/lightness/alpha 0-1)
{color.hsla}               # hsla(h, s, l, a)
{color.a}                  # Alpha component

Usage

CLI

List available themes:

clrsync_cli --list-themes

Apply the default theme:

clrsync_cli --apply

Apply a specific theme:

clrsync_cli --apply --theme cursed

Apply a theme from a file path:

clrsync_cli --apply --path /path/to/theme.toml

Show available color variables:

clrsync_cli --show-vars

Use a custom config file:

clrsync_cli --config /path/to/config.toml --apply

GUI

Launch the graphical editor:

clrsync_gui

The GUI provides:

• Color Scheme Editor: Visual palette editor with color pickers
• Template Editor: Edit template files
• Live Preview: See changes in real-time

Acknowledgments

• matugen - A material you color generation tool
• Dear ImGui - Bloat-free graphical user interface library for C++
• GLFW - Multi-platform library for OpenGL, OpenGL ES and Vulkan development
• toml++ - Header-only TOML config file parser and serializer for C++17
• argparse - Argument Parser for Modern C++
• ImGuiColorTextEdit - Syntax highlighting text editor for ImGui
• cursed by pyratebeard - Color scheme