Installation
TerminalTextEffects can be installed as a system application, to run effects from your shell, or as a library, to use effects in your Python code. The core package has no third-party dependencies.
Requirements
| Version | Minimum Python |
|---|---|
| 0.15.0, the latest published release | 3.8 |
Development main, toward 0.16.0 |
3.9.2 |
Effects use standard ANSI terminal sequences and work in most modern terminals. See Support and Compatibility for platform coverage and terminal requirements.
System Application
When installed as an application, TerminalTextEffects can be called from the shell to produce effects on any input piped to standard input. Uses include running it on shell launch, aliasing commands to pass their output through TTE, and SSH login animations.
echo 'terminaltexteffects is awesome' | nix run github:ChrisBuilds/terminaltexteffects -- beams
These commands use development main and require the nix-command and flakes features. See the
README for pinning a release, flake inputs,
and classic Nix.
Optionally, enable shell completion for effect names and options.
To compose text and preview effects interactively, install the optional tui extra, for example
pipx install 'terminaltexteffects[tui]'. See Interactive Interface.
To save effects as GIF or WebP animations with --export, install the optional export extra, for example
pipx install 'terminaltexteffects[export]'. See GIF and WebP.
The all extra installs both: pipx install 'terminaltexteffects[all]'.
Library
When installed as a library, TerminalTextEffects can be imported to produce animations in your Python applications.
Installing Development main
This documentation follows development main, so some documented features are not yet in the published release.
To try them, install from the repository:
Development main can change at any time. Use the published release for stable behavior.