basic readme

This commit is contained in:
Robin Appelman 2023-02-03 20:23:25 +01:00
commit 03f11afb51

27
README.md Normal file
View file

@ -0,0 +1,27 @@
# ykoauth-cli
CLI for getting TOTP codes from a Yubikey
# Usage
Simply insert your yubikey and run `ykoauth-cli` and you'll get a fuzzy-searchable list of token stored on the yubikey
```
Nextcloud:example
Google:example@gmail.com
Amazon:me@example.com
PayPal:example
DigitalOcean:me@example.com
Patreon:me@example.com
HackerOne:example
> Microsoft:me@example.com
$
```
Once a token is selected it will be printed and, if the (default) `clipboard` feature is enabled, copied to clipboard.
# Dependencies
- `pcsclite` for communicating with the yubikey
- `libX11` (optional) for the `clipboard` feature