yk-cli/README.md

18 lines
716 B
Markdown
Raw Normal View History

2020-12-11 04:16:35 +00:00
# yk-cli
2020-12-11 04:55:55 +00:00
Yubikey cli for retrieving TOTP codes
## Installation
Currently, there is no binary release published, but it can be built with `make build` and then you can copy `./build/yk` to somewhere in your path.
If you're a [`fish`](https://fishshell.com) user, you can also add `./scripts/yk.fish` to your `conf.d/` directory to get completions.
## Building
Executing `make build` will compile to `./build/yk`. Additionally, distribution builds should be possible with `make all` or by building a particular target. Eg `make ./dist/yk-darwin-amd64`. There is also an alias present and the `./dist/` prefix can be left off.
### Note on distribution builds
Currently cross compiling is not working correctly.