Skip to content

gk-theme

This package provides a command-line interface for a very basic management of GitKraken themes.

It allows to list available themes and install new ones by linking theme files into GitKraken's themes directory.

While it is intended for use during Home Manager activation by the NixKraken module, it can also be used independently for testing.

Although its execution is considered safe, it is possible that theme files are overwritten, resulting in theme data loss. Please back up your themes before use.

Usage

txt
usage: gk-theme [-h] [-l] [-i PATHS] [--dry-run] [-v] [-V]

GitKraken themes handler.

options:
  -h, --help           show this help message and exit
  -l, --list           list available themes
  -i, --install PATHS  install themes (comma-separated list of absolute paths
                       to lookup for JSONC theme files)
  --dry-run            only print what would be done
  -v, --verbose        enable verbose output
  -V, --version        show program's version number and exit

How to Run

bash
# Using the raw Bash script
./pkgs/theme/script.sh
bash
# ...or using new Nix commands
nix run '.#theme'
bash
# ...or using classic Nix commands
nix-build ./pkgs -A theme && ./result/bin/gk-theme
bash
# ...or from the Nix development shell (nix develop / nix-shell)
gk-theme

Since the package is typically run during Home Manager activation, it respects the following environment variables:

  • DRY_RUN: if set, commands are not executed, only logged
  • VERBOSE: if set, logs are enabled

For further details, refer to the actual script code.

Released under the MIT License