ykocli(1)

📦 version 1.4.0, in fedora 43, fedora 44

💖 ykocli — the manual page, but make it a group chat 💖

okay bestie, so this is the ykocli(1) page — it lives in the General Commands Manual section, and it's genuinely one of those little scripts that fixes a problem you didn't even know was making you miserable. let's get into it 🫶

✨ NAME ✨

ykocli — the front end script that makes getting TOTP tokens out of ykman actually painless. like, it's the glow-up wrapper. 💅

🌸 SYNOPSIS 🌸

ykocli [action] [search_string]

🦋 DESCRIPTION 🦋

so here's the tea: pulling TOTP tokens out of ykman through the CLI means manual copying. every single time. with your hands. 😭 and on top of that trauma, sometimes the token on screen expires before you can even use it, so you have to do the whole ritual again.

ykocli was built to mitigate both of those issues, and it also hands you TOTP ADD, DELETE and RENAME capabilities while it's at it. icon behavior, honestly.

here's the flow: the OATH entries stored on your inserted YubiKey get displayed in a table. you get prompted to pick an entry. that entry is then used to grab a non-expired TOTP token. and if only 1 entry matches your search criteria, the table doesn't even show up — the appropriate TOTP token goes straight into the CopyQ clipboard. zero extra steps, main character energy. ✨

and the clever bit: if the code displayed is less than the REGEN value set in the config file, another code gets generated for the next cycle interval, which greatly reduces or eliminates the whole expired-token situation. no cap.

⚠️ heads up: REGEN functionality is not available for TOTP OATH entries that require a touch to generate a token. that part is just not happening, bestie.

🎀 CONFIGURATION 🎀

ykocli lets you customize certain items in the configuration. so let's customize.

if you want to change an option, first make a copy:

cp /etc/ykocli.conf $HOME/.ykocli.conf

then modify only the $HOME/.ykocli.conf version. don't touch the system one, we are respectful in this house 🫶

the configuration variables can be set like this:

VARIABLE="value"

where "value" needs to be quoted. and yes, all shell escaping/quoting rules apply. the shell is always watching 👀

here's the list of changable configuration options ykocli recognizes:

  • REGEN="5" — default setting is 5 seconds. this is the minimum threshold in seconds for TOTP token expiration. if the remaining time for the TOTP token is at or less than this value, ykocli will automatically create a replacement. and reminder because it matters: REGEN functionality is not available for TOTP OATH entries that require a touch to generate a token. 💀
  • EXITIME="5" — default setting is 5 seconds. this is the minimum threshold in seconds for pressing the ENTER key to exit instead of returning to BACKGROUND MODE.
  • FIGFONT="small" — default setting is small. this is the font to be used by the Figlet generated banner. aesthetic choice, honestly. 🎀

🌈 COLOR OVERRIDES 🌈

monochrome, terminal defaults set value to "DEFAULT". available colors:

RED, YELLOW, GREEN, BLUE, CYAN, PURPLE, GRAY, WHITE, BLACK, LRED, LYELLOW, LGREEN, LBLUE, LCYAN, LPURPLE, LGRAY.

placing an "L" in front of the color designates the "LIGHT" version — e.g. LRED is Light RED. colors are assigned based upon the content being displayed. and the definitions of the abbreviated variables are listed above each entry in ykocli.conf, so go read them there, iykyk. 👑

⭐ USAGE NOTES ⭐

  • [action] — supported actions are TOTP | RENAME | ADD | DELETE
  • [search_string] — ykocli will only display OATH entries that match the search_string entered on the command line. if multiple matches are found, you will be prompted to select the desired entry.
  • BKGND — Konsole running under KDE Plasma ONLY. invoke it by using Konsole background mode, i.e.
konsole --background-mode -e ykocli bkgnd

or with an optional konsole profile, i.e.

konsole --background-mode --profile xyz -e ykocli bkgnd

this command can be entered using krunner, or as part of an autostart routine. the Konsole window will start in the background. press the default hotkey CRTL+SHIFT+F12 to toggle the window between ACTIVE and BACKGROUND. examples for desktop and profile files can be found in the /usr/share/doc/ykocli/examples directory. alternatively, you can invoke the following command from your home directory:

bash /usr/share/doc/ykocli/examples/ykocli-konsole-bkgnd.sh

💜 BACKEND TOOLS 💜

ykocli requires the following backend tools, no substitutions bestie:

  • bash — GNU Bourne-Again SHell
  • yubikey-manager (ykman) — required to interface with the inserted YubiKey
  • copyq — required to place TOTP tokens automatically in CopyQ clipboard
  • figlet — required to facilate display formatting
  • konsole — required if background mode is desired
  • zbar — required for add TOTP tokens using SCAN mode

🔥 SEE ALSO 🔥

👑 AUTHOR 👑

Gerald Cox <gbcox@fedoraproject.org>

🌐 WWW 🌐

https://bitbucket.org/gbcox/ykocli/

and that's the whole page, bestie — you made it to the end, slay 🎀✨ this was ykocli(1) from the General Commands Manual, and we are obsessed with her. go get those tokens. 💖

📦 where this page comes from