Building yubico tools (ykman)

Working with the code
Install dependencies
It’s assumed a Python environment with pip is installed.

Windows
Make sure the swig executable is in your PATH. Add libusb and ykpers DLLs to the root of the repository.

macOS
brew install swig ykpers libusb
Linux (Debian-based distributions)
sudo apt install swig libykpers-1-1 libu2f-udev pcscd libpcsclite-dev
Install yubikey-manager from source
Clone the repository:

git clone https://github.com/Yubico/yubikey-manager.git
cd yubikey-manager
Install in editable mode with pip:

pip install -e .
Show available commands:

ykman --help
Show information about inserted YubiKey:

ykman info
Run ykman in DEBUG mode:

ykman --log-level DEBUG info
To uninstall, run:

pip uninstall yubikey-manager
Code Style
This project uses Flake8 for code style with a pre-commit hook. To use these:

pip install pre-commit flake8
pre-commit install
Unit tests
To run unit tests:

python setup.py test
Integration tests
WARNING
ONLY run these on a dedicated developer key, as it will permanently delete data on the device!
To run integration tests, indicate the serial number (given by ykman list) of the YubiKey to test with:

DESTRUCTIVE_TEST_YUBIKEY_SERIAL=123456 python setup.py test