Skip to content

Installation

Lukasz Perek edited this page Jan 4, 2026 · 2 revisions

Installation

desktop-2fa is distributed as a Python package and works on Linux, macOS, and Windows. It has no external services, no network requirements, and no background daemons. Once installed, the desktop-2fa CLI is immediately available.

Requirements

  • Python 3.11 or newer
    (the project is tested on Python 3.11–3.13; earlier versions such as 3.9–3.10 are not supported)

Install from PyPI

Install the stable release:

pip install desktop-2fa

Verify that the CLI is available:

desktop-2fa --help

Upgrade to the latest version

pip install --upgrade desktop-2fa

Development installation

If you want to contribute or run the project from source:

git clone https://github.com/wrogistefan/desktop-2fa
cd desktop-2fa
pip install -e .[dev]

Run the CLI locally:

desktop-2fa --help

Uninstallation

pip uninstall desktop-2fa

Notes

  • No network access is required at any point during usage.
  • All data is stored locally in an encrypted vault.
  • The tool does not modify system configuration or create global state.
  • The vault location is platform‑specific and documented in the Security Model and Vault Architecture pages.

Clone this wiki locally