.. intro.rst ============ Introduction ============ .. include:: includes/what-is-ykman.rst Navigating this Guide ===================== This guide contains the instructions for using both the ykman CLI tool and the YubiKey Manager GUI. The majority of this guide describes the ykman CLI commands, which are organized by YubiKey application. General YubiKey commands are listed in :ref:`base-commands-label`. For YubiKey Manager GUI tasks, see the chapter on :ref:`gui-label`. Troubleshooting =============== If you attempt to use a CLI/GUI command and it fails, the cause could be due to one of the following factors: - The CLI/GUI you are using is not the latest version - Your YubiKey model does not support the feature - Your YubiKey's firmware does not include the feature To verify if your CLI/GUI version supports a particular feature, check the release notes: * `ykman CLI Release Notes `_ * `YubiKey Manager GUI Release Notes `_ To check your YubiKey's model and firmware version, use the ``ykman info`` command with the ykman CLI tool or visit the `Home `_ (desktop, Android) or `Configuration `_ (iOS, iPadOS) page in Yubico Authenticator. .. Note:: Yubico periodically updates the firmware to take advantage of features and capabilities introduced into the ecosystem. YubiKeys are programmed in Yubico's facilities with the latest available firmware and once programmed cannot be updated to another version. The firmware cannot be altered or removed from a YubiKey. ---- Click for `Yubico Support `_.