Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
daxartio committed Nov 4, 2023
1 parent 5681247 commit e9d6260
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<!-- CLI START -->
Expand Down Expand Up @@ -82,7 +92,6 @@ Options:
-d, --database <DATABASE> KDBX file path [env: KDBX_DATABASE=]
-k, --key-file <KEY_FILE> Path to the key file unlocking the database [env: KDBX_KEY_FILE=]
-h, --help Print help
-V, --version Print version
```

### totp
Expand All @@ -105,7 +114,6 @@ Options:
-d, --database <DATABASE> KDBX file path [env: KDBX_DATABASE=]
-k, --key-file <KEY_FILE> Path to the key file unlocking the database [env: KDBX_KEY_FILE=]
-h, --help Print help
-V, --version Print version
```

### show
Expand All @@ -127,7 +135,6 @@ Options:
-d, --database <DATABASE> KDBX file path [env: KDBX_DATABASE=]
-k, --key-file <KEY_FILE> Path to the key file unlocking the database [env: KDBX_KEY_FILE=]
-h, --help Print help
-V, --version Print version
```

### add
Expand All @@ -143,7 +150,6 @@ Options:
-d, --database <DATABASE> KDBX file path [env: KDBX_DATABASE=]
-k, --key-file <KEY_FILE> Path to the key file unlocking the database [env: KDBX_KEY_FILE=]
-h, --help Print help
-V, --version Print version
```

### init
Expand All @@ -157,7 +163,6 @@ Options:
-d, --database <DATABASE> KDBX file path [env: KDBX_DATABASE=]
-k, --key-file <KEY_FILE> Path to the key file unlocking the database [env: KDBX_KEY_FILE=]
-h, --help Print help
-V, --version Print version
```

### list
Expand All @@ -174,7 +179,6 @@ Options:
-d, --database <DATABASE> KDBX file path [env: KDBX_DATABASE=]
-k, --key-file <KEY_FILE> Path to the key file unlocking the database [env: KDBX_KEY_FILE=]
-h, --help Print help
-V, --version Print version
```

<!-- CLI END -->
Expand Down

0 comments on commit e9d6260

Please sign in to comment.