KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #codex #ai-agents #claude-code #dsh #dsh-plugin #cli #macos #ai-agent #deepseek-harness #open-source

yubikey-oath-dmenu

★ 37 Open GitHub ↗

dmenu interface for getting OATH codes from a YubiKey

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

yubikey-oath-dmenu
===

[dmenu][] interface for getting OATH codes from a [YubiKey][]

This program lets you pick an OATH credential from your YubiKey using [dmenu][],
and copies the corresponding OTP to the clipboard.
Alternatively, it can "type" the OTP using [xdotool][] on X11 or [wtype][]
on Wayland.

Notable features:

- Pick between all credentials on all connected YubiKeys
- No mouse interaction required

Usage
---

Invoke with `--help` to see the command line options.

$ yubikey-oath-dmenu --help

Recommended usage is to map your preferred command line to a shortcut in your
window manager or desktop environment. For example, you could bind it to
<kbd>Super</kbd>+<kbd>o</kbd> and <kbd>Super</kbd>+<kbd>Shift</kbd>+<kbd>o</kbd>
in [i3wm][] like this:

```
# Grab OTPs from ykman oath
bindsym $mod+o exec yubikey-oath-dmenu --notify --clipboard
bindsym $mod+Shift+o exec yubikey-oath-dmenu --notify --type
```

Example invocations:

- Copy OTP to primary clipboard, no notifications
  ```
  yubikey-oath-dmenu --clipboard
  ```

- Use notifications for feedback and type the OTP into the focused window:
  ```
  yubikey-oath-dmenu --notify --type
  ```

- Copy the OTP to clipboard, type it _and_ print it on standard output:
  ```
  yubikey-oath-dmenu --clipboard --type --stdout
  ```

- Customize `xclip` options:
  ```
  yubikey-oath-dmenu --clipboard-cmd "xclip -selection clipboard"
  ```

- Customize `wl-copy` options:
  ```
  yubikey-oath-dmenu --clipboard-cmd "wl-copy --paste-once"
  ```

- Customize `dmenu` options:
  ```
  yubikey-oath-dmenu --menu-cmd 'dmenu -p "Credential to copy:"'
  ```

Dependencies
---

- [Python 3][python]
- [Click][click]
- [dmenu][]
- [YubiKey Manager Python library][ykman], version 4.0.0 or later

Optional dependencies:

- [libnotify][]: For the `--notify` option, which uses `notify-send`
- [pinentry][]: To prompt for the YubiKey OATH password when needed
- [xdotool][]: For the `--type` option under X11
- [wtype][]: For the `--type` option under Wayland (`xdotool` might also work)
- A clipboard tool: For the `--clipboard` option, for example [xclip][] or
  [wl-clipboard][]

Installation
---

- **Arch Linux**: [AUR package][aur]
- **pipx**: If you're using `pipx` you can proceed as usual:
  ```bash
  pipx install git+https://github.com/emlun/yubikey-oath-dmenu.git
  ```
  This may require installing *libpcsclite-dev* and *swig* as system packages beforehand.
- **Others**: Place `yubikey_oath_dmenu.py` with executable mode somewhere on
  your `$PATH`. `/usr/local/bin/` probably works, for example. The included
  Makefile provides targets for this:

```
  # make install
  install -D -m755 "yubikey_oath_dmenu.py" "/usr/local/bin/yubikey-oath-dmenu"

# make uninstall
  rm "/usr/local/bin/yubikey-oath-dmenu"
  ```

Both targets respect the standard `DESTDIR` and `PREFIX` variables:

```
  $ make DESTDIR=/tmp/yubikey-oath-dmenu PREFIX=/usr install
  install -D -m755 "yubikey_oath_dmenu.py" "/tmp/yubikey-oath-dmenu/usr/bin/yubikey-oath-dmenu"
  ```

[aur]: https://aur.archlinux.org/packages/yubikey-oath-dmenu
[click]: https://palletsprojects.com/p/click/
[dmenu]: https://tools.suckless.org/dmenu/
[i3wm]: https://i3wm.org/docs/userguide.html
[libnotify]: https://developer.gnome.org/libnotify/
[pinentry]: https://www.gnupg.org/related_software/pinentry/index.html
[python]: https://www.python.org/
[wl-clipboard]: https://github.com/bugaevc/wl-clipboard
[wtype]: https://github.com/atx/wtype
[xclip]: https://linux.die.net/man/1/xclip
[xdotool]: http://www.semicomplete.com/projects/xdotool/
[ykman]: https://github.com/Yubico/yubikey-manager
[YubiKey]: https://www.yubico.com/products/yubikey-hardware/

Contributors
---

Big thanks to our contributors:

- [Andrei Gherzan](https://github.com/agherzan)
- [Mark Stosberg](https://github.com/markstos)
- [Martin Stiborský](https://github.com/stibi)
- [ign0tus](https://github.com/ign0tus)
- [relatev](https://github.com/relatev)

yubikey-oath-dmenu

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README