From e9d6260dc6ff8a1b94f6b0b6239e09fd207850fb Mon Sep 17 00:00:00 2001 From: Danil Akhtarov Date: Sat, 4 Nov 2023 11:38:44 +0300 Subject: [PATCH] docs: update readme --- README.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e75967b..024a00e 100644 --- a/README.md +++ b/README.md @@ -22,20 +22,30 @@ curl -fsSL https://raw.githubusercontent.com/daxartio/kdbx/master/install.sh | s ### Examples -``` Display selector and then print entry's info: - $ kdbx show + +``` +kdbx show +``` Copy password/totp if only single entry found otherwise display selector: - $ kdbx pwd /root/emails/gmail - $ kdbx totp /root/emails/gmail + +``` +kdbx pwd /root/emails/gmail +kdbx totp /root/emails/gmail +``` Print password/totp to STDOUT: - $ kdbx pwd github.com | cat - $ kdbx totp github.com | cat + +``` +kdbx pwd github.com | cat +kdbx totp github.com | cat +``` Read password from STDIN: - $ cat /mnt/usb/key | kdbx pwd + +``` +cat /mnt/usb/key | kdbx pwd ``` @@ -82,7 +92,6 @@ Options: -d, --database KDBX file path [env: KDBX_DATABASE=] -k, --key-file Path to the key file unlocking the database [env: KDBX_KEY_FILE=] -h, --help Print help - -V, --version Print version ``` ### totp @@ -105,7 +114,6 @@ Options: -d, --database KDBX file path [env: KDBX_DATABASE=] -k, --key-file Path to the key file unlocking the database [env: KDBX_KEY_FILE=] -h, --help Print help - -V, --version Print version ``` ### show @@ -127,7 +135,6 @@ Options: -d, --database KDBX file path [env: KDBX_DATABASE=] -k, --key-file Path to the key file unlocking the database [env: KDBX_KEY_FILE=] -h, --help Print help - -V, --version Print version ``` ### add @@ -143,7 +150,6 @@ Options: -d, --database KDBX file path [env: KDBX_DATABASE=] -k, --key-file Path to the key file unlocking the database [env: KDBX_KEY_FILE=] -h, --help Print help - -V, --version Print version ``` ### init @@ -157,7 +163,6 @@ Options: -d, --database KDBX file path [env: KDBX_DATABASE=] -k, --key-file Path to the key file unlocking the database [env: KDBX_KEY_FILE=] -h, --help Print help - -V, --version Print version ``` ### list @@ -174,7 +179,6 @@ Options: -d, --database KDBX file path [env: KDBX_DATABASE=] -k, --key-file Path to the key file unlocking the database [env: KDBX_KEY_FILE=] -h, --help Print help - -V, --version Print version ```