FoundryTools-CLI

FoundryTools-CLI, former known as ftCLI, is a collection of command line tools written in Python to inspect, manipulate and convert fonts. It takes advantage of the capabilities made available by other tools such as:

• FontTools
• AFDKO
• skia-pathops
• cffsubr
• ttfautohint-py
• dehinter

The command line interface is built with click and tables are rendered by rich.

Even if not directly imported to keep the footprint as small as possible, portions of code have been copied from fontbakery and font-line.

Installation

FoundryTools-CLI requires Python 3.9 or later.

Note for Windows users: installation on Python 3.11 and later may fail due to an error while building the wheel for the AFDKO dependency. This is a known issue and a workaround is to install Visual Studio 2022 (Community Edition is fine) and the Python development workload, selecting the Python native development tools optional component.

IMPORTANT: If you have Python 2.x installed in your system, you may have to use python3 (instead of python) in the commands below.

pip

FoundryTools-CLI releases are available on the Python Package Index (PyPI), so it can be installed with pip:

python -m pip install foundrytools-cli

Editable mode

If you would like to contribute to the development, you can clone the repository from GitHub, install the package in 'editable' mode and modify the source code in place. We strongly recommend using a virtual environment.

# clone the repository:
git clone https://github.com/ftCLI/foundrytools-cli.git
cd foundrytools-cli

# create new virtual environment named e.g. ftcli-venv, or whatever you prefer:
python -m venv ftcli-venv

# to activate the virtual environmtnet in macOS and Linux, do:
. ftcli-venv/bin/activate

# to activate the virtual environment in Windows, do:
ftcli-venv\Scripts\activate.bat

# install in 'editable' mode
python -m pip install -e .

Documentation

FoundryTools-CLI is a Terminal app where commands are logically organized into subcommands.

Please refer to the user documentation.

License

FoundryTools-CLI is available under the MIT license

Credits

To Sergiev. May You rest in peace.