1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# Application Guide
When used as a system application, TerminalTextEffects will produce animations on text passed to stdin or through the
`-i` argument. Passing data via STDIN to TTE occurs via pipes or redirection.
## Invocation Examples
=== "Piping"
```bash title="Piping directory listing output through TTE"
ls -latr | tte slide
```
=== "Redirection"
```bash title="Redirecting a file through TTE"
tte slide < your_file
```
=== "File Input"
```bash title="Passing a file argument to TTE"
tte -i path/to/file slide
```
## Configuration
TTE has many global terminal configuration options as well as effect-specific configuration options available via command-line arguments.
Terminal configuration options should be specified prior to providing the effect name. The basic format is as follows:
```bash title="TTE usage syntax"
tte [global_options] <effect_name> [effect_options]
```
Using the `-h` argument in place of the global_options or effect_options will produce either the global or effect help output, respectively.
The example below will pass the output of the `ls` command to TTE with the following options:
* *Global* options:
- Text will be wrapped if wider than the terminal.
- Tabs will be replaced with 4 spaces.
* *Effect* options:
- Use the [slide](./effects/slide.md) effect.
- Merge the groups.
- Set movement-speed to 2.
- Group by column.
```bash title="TTE argument specification example"
ls | tte --wrap-text --tab-width 4 slide --merge --movement-speed 2 --grouping column
```
## Example Usage
Animate fetch output on shell launch using screenfetch:
```bash title="Shell Fetch"
screenfetch -N | tte slide --merge
```
!!! note
Fetch applications which utilize terminal sequences for color/formatting will not work with TTE.
Check if your fetch application has a raw output switch.
|
