[!TIP] Русская версия: README-RU.md
Features
- Smooth terminal animation with configurable pipes, colors, and glyph sets
- Multiple color modes (
ansi,rgb,argb) with named palettes and rainbow shift - Screen coverage tracking for intelligent reset timing
- Interactive runtime controls for speed, color, and visual behavior
- Two executables:
pipesrfor interactive animationpipesr-benchfor throughput benchmarking
- Benchmark modes:
core(algorithm only, no terminal output)full-render(full draw pipeline in terminal)
Installation
Install from crates.io
Install with Nix (Flake)
The Nix flake builds pipesr from flake.nix. Use nix run to try the animation without installing it into your profile, or nix profile install to install both pipesr and pipesr-bench persistently.
Requires Nix with flakes enabled on Linux (x86_64 or aarch64).
Install with Snap (Linux)
Download the .snap package for your architecture from GitHub Releases: amd64 for x86-64, or arm64 for ARM64.
With snapd installed, replace ./pipesr.snap below with the path to your downloaded file:
--dangerous allows installing the local package without a Snap Store signature; strict confinement remains enabled.
The Snap commands are pipesr and pipesr.bench (not pipesr-bench). The release workflow publishes these files to GitHub Releases, not to the Snap Store.
Install from source
This installs the pipesr and pipesr-bench binaries into your Cargo bin directory.
Build
Usage
# Run installed binary
# With runtime options
# Help and version
# Generate default config
Runtime Keys
~- toggle keyboard reference+/-- increase/decrease the number of pipes by 1 (minimum: 1;=also increases)p/o- increase/decrease turn chance (0.0..1.0)f/d- increase/decrease FPS (1..720)b- toggle boldc- toggle colork- toggle keep color/type when crossing edgesr- manual screen reset0..9- switch pipe type to the matching-t/--typeindexq,Ctrl+Q,Ctrl+C- quit
Config file
pipesr loads persistent settings from:
~/.config/pipesr/config.toml
Merge priority:
CLI options > config file > built-in defaults
-s, --turn-chance [0.0-1.0] turn probability (default: 0.08) -r, --reset-threshold [0.0-1.0] screen coverage threshold for reset, 0 = no reset (default: 0.5)
= 4
= 60.0
= 0.1
= 0.5
= true
= false
= false
= "ansi" # ansi | rgb | argb
= "terminal" # terminal | github | kanagawa | material-ocean | gruvbox | catppuccin | tokyonight | nord | ayu
= false
= true
= [0, 2]
= ["fedcba9876543210"]
= [1, 2, "#AF"] # requires color_mode = "ansi"
Pipe Types
| Index | Name | Preview |
|---|---|---|
| 0 | heavy | ┃ ━ ┏ ┓ ┗ ┛ |
| 1 | light | │ ─ ┌ ┐ └ ┘ |
| 2 | curved | │ ─ ╭ ╮ ╰ ╯ |
| 3 | outline | ║ ═ ╔ ╗ ╚ ╝ |
| 4 | ascii | | + - |
| 5 | diagonal | | / \\ - |
| 6 | dots | . . . . . . |
| 7 | round | . o . o . o |
| 8 | mixed | - \\ / | |
| 9 | knobby | ╿ ╼ ┍ ┑ ┕ ┙ |
Select at runtime with -t <index> or switch live with keys 0-9.
Custom sets can be added via -T (exactly 16 characters) or type_custom in config.
pipesr CLI Options
-p, --pipes [1-N] number of pipes (default: 1)
-t, --type [0-N] pipe type index (repeatable)
-T, --type-custom [16 chars] custom pipe type (repeatable)
-c, --color [0-255|#HEX] color index, decimal or hex (repeatable)
-m, --color-mode [ansi|rgb|argb] color mode (default: ansi)
-P, --palette named color palette (default: terminal)
palettes: terminal | github | kanagawa | material-ocean
gruvbox | catppuccin | tokyonight | nord | ayu
-w, --rainbow shift colors between frames
-f, --framerate [FPS] frames per second (default: 60)
-s, --turn-chance [0.0-1.0] turn probability (default: 0.08)
-r, --reset-threshold [0.0-1.0] screen coverage threshold for reset, 0 = no reset (default: 0.5)
-R, --random-start randomize initial position/direction
-B, --no-bold disable bold
-C, --no-color disable color
-n, --no-config ignore config.toml and use built-in defaults as the base
-K, --keep-color-type keep color/type on edge crossing
-g, --generate-config write default config file to the standard config path
-h, --help help
-v, --version version
Examples:
# 4 pipes, random start, higher FPS
# custom palette + no auto reset
# RGB mode with animated palette shift
# an advanced generated truecolor palette
# custom pipe set (exactly 16 chars)
rgb uses the fixed theme colors directly
argb generates an expanded truecolor palette from the selected theme, which gives smoother hue transitions and denser rainbow cycling
Benchmark (pipesr-bench)
Run core benchmark:
Run full terminal rendering benchmark:
Pass pipesr options through benchmark:
Benchmark options
-l, --limit N generated chars per run (default: 1000)
-n, --runs N benchmark runs (default: 5)
-W, --width N logical width (default: 80)
-H, --height N logical height (default: 24)
-m, --mode core|full-render benchmark mode (default: core)
-u, --humanize human-readable throughput
-L, --label TEXT output label
-h, --help help
-v, --version version
Output format:
{label} [{mode}]: {cps} c/s
Example:
custom [core]: 19600156 c/s