alfred-yubico-auth/README.md

24 lines
1.1 KiB
Markdown
Raw Normal View History

2018-04-12 22:55:55 +00:00
# Alfred Yubico Auth
2017-08-07 17:20:22 +00:00
2020-12-10 16:42:50 +00:00
This workflow allows quick searching and filling, and copying of OTP codes from a supported Yubikey.
2017-08-07 17:20:22 +00:00
So far, it has been tested with a Yubikey NEO on a MacBook Pro running macOS Catalina. I have no other devices to test with, but bug reports and patches may still be reviewed.
2021-01-04 18:34:08 +00:00
## Cloning
Currently this package depends on a fork of [yawn/ykoath](https://github.com/yawn/ykoath). To allow this to be built directly from this repo, the fork is added as a git submodule. This can be cloned using `git clone --recurse-submodules` or cloning normally and then executing `git submodule update --init`. Once the change has been merged upstream, the submodule and this notice will go away.
2020-12-10 16:42:50 +00:00
## Building
2017-08-07 17:20:22 +00:00
2020-12-10 16:42:50 +00:00
Building requires [`mage`](https://magefile.org/)
2017-08-07 17:20:22 +00:00
2021-01-04 18:34:27 +00:00
To see all targets and their descriptions, run `mage -l`. The most basic ones are as follows:
* `mage install`: Build and install into your local machine for testing
* `mage dist`: Build bundle for distribution
2018-04-12 22:55:55 +00:00
## Credits
2017-08-07 17:20:22 +00:00
2020-12-10 16:42:50 +00:00
This uses [deanishe/awgo](https://github.com/deanishe/awgo) to interface with Alfred and [yawn/ykoath](https://github.com/yawn/ykoath) for interracting with the Yubikey