YKMAN(1)

πŸ’– YKMAN(1) β€” the YubiKey Manager, bestie edition πŸ’–

okay so this is the manual for ykman, part of the User Commands crew, and it's literally the glow-up your YubiKey has been waiting for πŸ¦‹


✨ NAME ✨

ykman β€” YubiKey Manager (ykman) πŸ‘‘


✨ SYNOPSIS ✨

ykman [OPTIONS] COMMAND [ARGS]...

✨ DESCRIPTION ✨

Configure your YubiKey straight from the command line. that's it, that's the whole vibe πŸ’…


✨ OPTIONS ✨

  • -d, --device SERIAL β€” pick which YubiKey you're talking to, by serial number πŸŽ€
  • -r, --reader NAME β€” pick a YubiKey by its smart card reader name. ngl this one can't be used together with --device or list 🚫
  • -t, --scp-ca FILENAME β€” tell it which CA to use to verify the SCP11 card key (CA-KLCC) πŸ”
  • -s, --scp CRED β€” hand over the private key and certificate chain for secure messaging. you can use this one multiple times to pass key + certs across multiple files (private key, certificates in leaf-last order), OR you can give SCP03 keys in hex separated by a colon: K-ENC:K-MAC[:K-DEK] πŸ—οΈ
  • -p, --scp-password PASSWORD β€” the password needed to unlock the --scp file, if it needs one πŸ”‘
  • -l, --log-level [error|warning|info|debug|traffic] β€” turn on logging at whichever verbosity level you want πŸ“
  • --log-file FILE β€” write the log into FILE instead of spilling it onto stderr (heads up: this needs --log-level) πŸ“‚
  • --diagnose β€” show diagnostics info that's actually useful for troubleshooting 🩺
  • -v, --version β€” show version info about the app ⭐
  • --full-help β€” show the --help output, including the hidden commands πŸ‘€
  • -h, --help β€” show this message and exit, bye ✌️

✨ Commands ✨

  • info β€” show general information 🌸
  • list β€” list connected YubiKeys 🌈
  • script β€” run a python script 🐍
  • config β€” configure the YubiKey, enable or disable applications βš™οΈ
  • fido β€” manage the FIDO applications πŸ”‘
  • hsmauth β€” manage the YubiHSM Auth application πŸ’œ
  • oath β€” manage the OATH application 🎟️
  • openpgp β€” manage the OpenPGP application βœ‰οΈ
  • otp β€” manage the YubiOTP application πŸ”’
  • piv β€” manage the PIV application πŸͺͺ

✨ EXAMPLES ✨

List connected YubiKeys, only output serial number:

$ ykman list --serials

Show information about YubiKey with serial number 123456:

$ ykman --device 123456 info

✨ SHELL COMPLETION ✨

there's experimental shell completion for the command line tool and honestly? obsessed 🫢 to enable it, run this command once (for Bash):

$ source <(_YKMAN_COMPLETE=bash_source ykman | sudo tee /etc/bash_completion.d/ykman)

want more info on shell completion (including how to do it in other shells)? it's all at: https://click.palletsprojects.com/en/stable/shell-completion/


and that's the whole page bestie πŸ’– this was ykman 5.9.2, born June 2026, filed under YKMAN(1) β€” go forth and manage those keys, main character πŸ‘‘βœ¨

πŸ“¦ where this page comes from