gk-configure

This package automates the creation and management of GitKraken's configuration files, especially in the context of a Home Manager installation.

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

WE ARE NOT RESPONSIBLE FOR NUKING YOUR CONFIGURATION

The package will modify GitKraken's configuration files, and loss of configuration is a possible outcome, although we strive to make it as safe as possible.

Please back up your configuration before use.

Usage

usage: gk-configure [-h] -c JSON [-p PROFILE_ID] [--dry-run] [-v] [-V]

GitKraken configuration generator.

options:
  -h, --help            show this help message and exit
  -c, --config JSON     configuration content in JSON format
  -p, --profile PROFILE_ID
                        operate on given profile configuration
  --dry-run             only print what would be done
  -v, --verbose         enable verbose output
  -V, --version         show program's version number and exit

Examples:
  Configure application:
    $ gk-configure -c JSON [--dry-run] [-v]

  Configure profile:
    $ gk-configure -c JSON -p PROFILE_ID [--dry-run] [-v]

How to Run

# Using the raw Bash script
$ ./pkgs/configure/script.sh

# ...or using new Nix commands
$ nix run '.#configure'

# ...or using classic Nix commands
$ nix-build ./pkgs -A configure && ./result/bin/gk-configure

# ...or from the Nix development shell (nix develop / nix-shell)
$ gk-configure

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.