mirror of
https://github.com/erenfro/keepassxc-unlocker.git
synced 2024-12-04 16:05:38 -05:00
Updated Readme and updated help output
This commit is contained in:
parent
e3c1ed1324
commit
cdd027c68f
2 changed files with 27 additions and 3 deletions
28
README.md
28
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 <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
|
||||
```
|
||||
|
|
|
@ -405,7 +405,7 @@ def help():
|
|||
"""
|
||||
Prints the help message.
|
||||
"""
|
||||
print("Usage: python script.py <command> [arguments]")
|
||||
print("Usage: keepassxc-unlocker <command> [arguments]")
|
||||
print("Commands:")
|
||||
print(" add <db> - Add an entry to the keyring")
|
||||
print(" remove <db> - Remove an entry from the keyring")
|
||||
|
|
Loading…
Reference in a new issue