Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aivanovski/kp-diff
CLI utility to diff KeePass database
https://github.com/aivanovski/kp-diff
cli diff graalvm keepass kotlin
Last synced: 2 months ago
JSON representation
CLI utility to diff KeePass database
- Host: GitHub
- URL: https://github.com/aivanovski/kp-diff
- Owner: aivanovski
- License: apache-2.0
- Created: 2023-02-28T13:33:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T09:49:16.000Z (8 months ago)
- Last Synced: 2024-05-19T14:53:00.409Z (8 months ago)
- Topics: cli, diff, graalvm, keepass, kotlin
- Language: Kotlin
- Homepage:
- Size: 368 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-keepass - kp-diff - Command-line tool written in Kotlin to show differences between KeePass Database files. (Clients / Other clients)
README
 
# kp-diff
**kp-diff** is a CLI utility that compares and prints diff for Keepass database files.
## Demo
[](https://asciinema.org/a/582798)
## Installation
### Linux
##### Arch Linux
`kp-diff` is available in the [Arch User Repository](https://aur.archlinux.org/) and could be installed with any [AUR](https://aur.archlinux.org/) helper.
```
yay -S kp-diff-bin
```
##### Manual installation
All releases of `kp-diff` can be downloaded from [releases](https://github.com/aivanovski/kp-diff/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](https://github.com/aivanovski/homebrew-brew))
```
brew tap aivanovski/brew
brew install kp-diff
```
## Usage
```
USAGE:
kp-diff [OPTIONS]
ARGS:
First file
Second file
OPTIONS:
-o, --one-password Use one password for both files
-k, --key-file Path to key file for and
-a, --key-file-a Path to key file for
-b, --key-file-b Path to key file for
-p, --password Password for and
--password-a Password for
--password-b Password for
-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](https://www.graalvm.org/) with
the following steps:
- Install and setup latest version of [GraalVM](https://www.graalvm.org/) (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
```