GitKraken Config Discovery

This utility is a Bash script, bundled with the writeShellApplication build helper, which allows for easy and interactive GitKraken configuration discovery.

When run, the script will launch GitKraken as a child process and watch for changes to GitKraken configuration files. Internally, it uses the deep-json-diff Python utility to diff the updated configuration file with its previous content and output the changes.

This allows you to interact with the GitKraken UI in order to discover the configuration keys behind checkboxes, input fields and such that control GitKraken settings.

INFO

This utility is intended for NixKraken maintainers and contributors and is not distributed via NixKraken’s flake outputs.

Build

# From utility's source directory
nix-build

# From repository's root
nix-build ./gitkraken/utils/config-discovery

INFO

nix build currently does not support function installables. Use classic nix-build for this utility.

Selecting a Version

By default, the utility uses the latest GitKraken version redistributed by NixKraken (as defined in the NixKraken package set you’re building against).

To use a specific version, run:

nix-build ./gitkraken/utils/config-discovery --argstr version 11.1.0

Usage

By default, the utility watches the main application configuration file (i.e., ~/.gitkraken/config):

./result/bin/gk-config-discovery

Additionally, passing a profile identifier as argument allows to watch for this profile-specific configuration (i.e., ~/.gitkraken/profiles/<profileId>/profile):

# Default profile
./result/bin/gk-config-discovery d6e5a8ca26e14325a4275fc33b17e16f

WARNING

If GitKraken is already running, the utility will silently fail to launch it and watch for configuration changes anyway.

This means that if you selected a specific version of GitKraken, it will not have any effect until you close GitKraken and re-run the utility.