tte

[command] | tte [options] effect [effect-options]tte -i file [options] effect [effect-options]

tte is the terminal program installed with the terminaltexteffects package. It reads text from a pipe or from --input-file and plays one built-in effect over it: rain, decrypt, beams, matrix, burn, and others. The animation uses ANSI sequences, runs in line, and tries to leave the terminal usable when it finishes.Each effect adds its own flags, generated from that effect's configuration. tte decrypt -h shows them. The same engine can be called as python -m terminaltexteffects when the package is imported instead of installed as an application.

effect

Effect to play. tte effect -h lists that effect's own options.

Read the input text from file instead of standard input.

Choose an effect at random.

Seed the random effect choice.

Effects --random-effect is allowed to choose. Names are separated by spaces.

Effects --random-effect must not choose.

Target frames per second. 0 disables the limit. The default is 60.

Draw the effect without color.

Map 24-bit hex colors to the nearest xterm 256-color index.

Terminal background, as an xterm index 0-255 or a hex RGB value 000000-ffffff. Effects use it for fades.

What to do with ANSI colors already in the input. always keeps them, dynamic lets the effect decide, and ignore drops them. The default is ignore.

Wrap lines that are wider than the canvas.

Canvas size. A positive integer sets that dimension, 0 follows the terminal, and -1 follows the input text. Both default to -1.

Where the canvas sits in the terminal. The default is sw.

Where the input text sits inside the canvas. The default is sw.

Spaces per tab. Must be greater than zero.

Draw the full canvas even when it is larger than the terminal.

Move the cursor up over the input's rows and draw there again, instead of adding new rows.

Do not print a newline when the effect finishes.

Leave the cursor hidden after the effect.

Print the version and exit.

Print a completion script and exit.

The effect set and some flags on the project's development branch are ahead of the last published package. A flag documented upstream can be missing from the tte that a package manager installed.--reuse-canvas is reliable in a script that owns the screen. An interactive prompt between runs makes the cursor movement land in the wrong place.--random-effect needs a terminal that can play the animation. --no-color and --xterm-colors are the escapes for terminals that cannot show 24-bit color.

terminaltexteffects was created by ChrisBuilds and is written in Python. The installed command name is tte.

terminaltexteffects(1), lolcat(1), figlet(1), toilet(1)

Documentation · Source code