Installation

Getting started

TL;DR

pipx install f2-commander

F2 Commander is designed to work in Linux and macOS.

Windows is not officially supported at the moment. It may work in WSL, but it is not extensively tested.

Python pakage on PyPI

F2 Commander is available as a PyPI package f2-commander.

Install it with your preferred Python environment management tool. For example:

pip install --user f2-commander

or

pipx install f2-commander

Other package managers

F2 Commander is currently only available through PyPI. It may be released to other popular package managers in the future. If you have relevant experience and want to help, please reach out: open an according GitHub issue and manifest your interest!

Run or install from source

Clone the source code and build it with Poetry:

git clone git@github.com:candidtim/f2-commander.git
poetry install

Run from source:

poetry run f2

Or build a package locally and install from it. For example:

poetry build
pipx install [--force] dist/f2_commander-....tar.gz