kp-diff

kp-diff is a CLI utility that compares and prints diff for Keepass database files.

Demo

Installation

Linux

Arch Linux

kp-diff is available in the Arch User Repository and could be installed with any AUR helper.

yay -S kp-diff-bin

Manual installation

All releases of kp-diff can be downloaded from releases page

Command line installation via curl

A particular version of kp-diff can be downloaded with next command which also changes the file to an executable in directory $HOME/.local/bin

curl -sSLO https://github.com/aivanovski/kp-diff/releases/download/0.6.0/kp-diff-linux-amd64 && chmod +x kp-diff-linux-amd64 && mkdir -p $HOME/.local/bin && mv kp-diff-linux-amd64 $HOME/.local/bin/kp-diff

macOS

kp-diff is available as Homebrew formula (formulas repositry)

brew tap aivanovski/brew
brew install kp-diff

Usage

USAGE:
    kp-diff [OPTIONS] <FILE-A> <FILE-B>

ARGS:
    <FILE-A>    First file
    <FILE-B>    Second file

OPTIONS:
    -o, --one-password               Use one password for both files
    -k, --key-file                   Path to key file for <FILE-A> and <FILE-B>
    -a, --key-file-a                 Path to key file for <FILE-A>
    -b, --key-file-b                 Path to key file for <FILE-B>
    -p, --password                   Password for <FILE-A> and <FILE-B>
        --password-a                 Password for <FILE-A>
        --password-b                 Password for <FILE-A>
    -f, --output-file                Path to output file
    -n, --no-color                   Disable colored output
    -d, --diff-by                    Type of differ, default is 'path'. Possible values:
                                         path - produces more accurate diff, considers entries identical if they have identical content but UUID differs
                                         uid - considers entries identical if they have identical content and UUID
    -v, --verbose                    Print verbose output (entry fields will be printed)
    -V, --version                    Print version
    -h, --help                       Print help information

Integration with git

kp-diff can be used as external diff tool in git repository.

1. Create wrapper script kp-diff-git.sh in order to provide password or key to kp-diff.

#!/bin/sh
password=$(gpg ...) # read database password in a secure way, for example with gpg
kp-diff $2 $5 --password $password --verbose # arguments $2 and $5 are important and will be provided by git

2. Specify kp-diff-git.sh in repository config file

[diff "kp-diff"]
command = kp-diff-git.sh

3. Use kp-diff as external diff tool in git log

git log -p --ext-diff

Building from sources

Building .jar file

git clone https://github.com/aivanovski/kp-diff.git
cd kp-diff

Then to build the project run:

./gradlew shadowJar

Output file should be localed at kp-diff/build/libs/

Building binary file

Binary file provides faster startup and better performance. It can be compiled (ahead-of-time) from .jar file with GraalVM with the following steps:

• Install and setup latest version of GraalVM (for example version >= 21)
• Compile binary with following command:

native-image \
    --no-server \
    --no-fallback \
    -H:IncludeResources=".*\.properties" \
    --allow-incomplete-classpath \
    -jar PATH_TO_JAR_FILE