Updated Readme and updated help output

This commit is contained in:
Eric Renfro 2024-11-25 20:26:43 -05:00
parent e3c1ed1324
commit cdd027c68f
Signed by: psi-jack
SSH key fingerprint: SHA256:1TKB8Z257L8EHK8GWNxKgMhD8a+FAR+f+j3nnlcuNVM
2 changed files with 27 additions and 3 deletions

View file

@ -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 <command> [arguments]
Commands:
add <db> - Add an entry to the keyring
remove <db> - Remove an entry from the keyring
service <opt> - 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
```

View file

@ -405,7 +405,7 @@ def help():
""" """
Prints the help message. Prints the help message.
""" """
print("Usage: python script.py <command> [arguments]") print("Usage: keepassxc-unlocker <command> [arguments]")
print("Commands:") print("Commands:")
print(" add <db> - Add an entry to the keyring") print(" add <db> - Add an entry to the keyring")
print(" remove <db> - Remove an entry from the keyring") print(" remove <db> - Remove an entry from the keyring")