From cdd027c68f2444e69055f7e7d5c31e43dc7483f8 Mon Sep 17 00:00:00 2001 From: Eric Renfro Date: Mon, 25 Nov 2024 20:26:43 -0500 Subject: [PATCH] Updated Readme and updated help output --- README.md | 28 ++++++++++++++++++++++++++-- keepassxc-unlocker | 2 +- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 833c821..0b618cf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ -# keepassxc-unlocker -KeePassXC Unlocker +# KeePassXC-Unlocker + +KeePassXC Unlocker is a took designed to utilize your system's keyring to +unlock your KeePassXC database(s) on login and session unlocking. + +Currently this only works on Linux, but the aim is to get this working +on macOS as well, and maybe Windows, if someone's willing to help write the +Windows portions and test, but I don't run Windows. + +## Command Help: + +``` +Usage: keepassxc-unlocker [arguments] +Commands: + add - Add an entry to the keyring + remove - Remove an entry from the keyring + service - Add or Remove user service for automation + unlock - Unlock all KeePassXC databases from keyring + watch - Monitor screensaver lock/unlock events + help - Show this help message + +Service Options: + add - Add systemd user service to automate unlock + remove - Remove systemd user service and automation + status - Status of service +``` diff --git a/keepassxc-unlocker b/keepassxc-unlocker index 48c1161..88735fb 100755 --- a/keepassxc-unlocker +++ b/keepassxc-unlocker @@ -405,7 +405,7 @@ def help(): """ Prints the help message. """ - print("Usage: python script.py [arguments]") + print("Usage: keepassxc-unlocker [arguments]") print("Commands:") print(" add - Add an entry to the keyring") print(" remove - Remove an entry from the keyring")