pyfiglet Documentation

If you have new font files (either a single .flf file or a ZIP archive containing multiple fonts), you can install them into your pyfiglet collection using the -L flag. Depending on your installation method, you may require root privileges.

Note: On Unix-like systems, pyfiglet automatically detects and uses fonts installed by the system FIGlet in /usr/local/share/figlet and /usr/share/figlet.

pyfiglet -L <font file>
# If permission is denied:
sudo pyfiglet -L <font file>

You can integrate pyfiglet into your Python projects using two different patterns: the object-oriented Figlet class or the functional figlet_format approach. Both allow you to specify a font (defaults to standard.flf) to render ASCII art from text.

from pyfiglet import Figlet
f = Figlet(font='slant')
print(f.renderText('text to render'))

# OR

import pyfiglet
f = pyfiglet.figlet_format("text to render", font="slant")
print(f)

pyfiglet can be used as a standalone CLI tool, behaving similarly to the original C FIGlet. It accepts text as an argument and supports various options. The most common option is -f to specify a font.

To see all available command-line tweaks, run with --help.

When using the pyfiglet.py command, you can customize the output using the following flags:

The pyfiglet.py command-line tool converts ordinary ASCII text into large ASCII art characters using FIGlet (.flf) and toilet-compatible (.tlf) fonts.

Usage:

pyfiglet.py [options] text...