pipes-rs lhvy

cli command-line cross-platform open-source pipes terminal terminal-app

Use this command to install pipes-rs:

winget install --id=lhvy.pipes-rs -e

An over-engineered rewrite of pipes.sh in Rust.

Pipes-rs is a terminal-based visualization tool designed to create animated, customizable pipe effects that flow across your screen. Built as an enhanced rewrite of pipes.sh using Rust, this cross-platform application offers improved performance and additional features while maintaining compatibility with various terminal environments.

Key Features:

Multiple Pipe Kinds: Choose from heavy, light, curved, knobby, emoji, outline, dots, blocks, or sus pipe styles to customize the visual experience.
Customizable Color Modes: Select between ANSI colors, randomly generated RGB values, or no color changes for different aesthetic effects.
Configurable Settings: Adjust delay timing, reset thresholds, turn chances, and other parameters through a TOML configuration file or command-line options.
Palette Options: Use predefined palettes like default, darker, pastel, or matrix to match your terminal theme.
Cross-Platform Compatibility: Works seamlessly on Linux, macOS, Windows, and other platforms with support for installation via Cargo, Homebrew, Scoop, and winget.

Audience & Benefit:

Ideal for developers, terminal enthusiasts, and users seeking a dynamic visual distraction while working. Pipes-rs enhances focus by providing an engaging yet non-intrusive animation that can be easily customized to fit any workflow or terminal setup. Its flexibility allows users to tailor the experience to their preferences, ensuring a seamless integration into daily use.

pipes-rs

> An over-engineered rewrite of pipes.sh in Rust

pipes-rs preview

Installation

Install the latest version release via git on any platform using Cargo:

cargo install --git https://github.com/lhvy/pipes-rs

Alternatively for macOS, install via Homebrew:

brew install lhvy/tap/pipes-rs

Alternatively for Windows, install via Scoop:

scoop bucket add extras
scoop install pipes-rs

Manual Download

Download compiled binaries from releases.

Windows Font Issues

There have been reports that some characters pipes-rs uses are missing on Windows, which causes them to appear as tofu. If you experience this issue, try using a font with a large character set, such as Noto Mono.

Keybindings

r: reset the screen
q or ^C: exit the program

Configuration

pipes-rs can be configured using TOML located at ~/.config/pipes-rs/config.toml. The following is an example file with the default settings:

bold = true
color_mode = "ansi" # ansi, rgb or none
palette = "default" # default, darker, pastel or matrix
rainbow = 0 # 0-255
delay_ms = 20
inherit_style = false
kinds = ["heavy"] # heavy, light, curved, knobby, emoji, outline, dots, blocks, sus
num_pipes = 1
reset_threshold = 0.5 # 0.0–1.0
turn_chance = 0.15 # 0.0–1.0

Color Modes

Mode	Description
`ansi`	pipe colors are randomly selected from the terminal color profile, default option
`rgb`	pipe colors are randomly generated rgb values, unsupported in some terminals
`none`	pipe colors will not be set and use the current terminal text color

Palette	Description
`default`	bright colors – good on dark backgrounds, default option
`darker`	darker colors – good on light backgrounds
`pastel`	pastel colors – good on dark backgrounds
`matrix`	colors based on Matrix digital rain – good on dark backgrounds

Kind	Preview
`heavy`	`┃ ┃ ━ ━ ┏ ┓ ┗ ┛`
`light`	`│ │ ─ ─ ┌ ┐ └ ┘`
`curved`	`│ │ ─ ─ ╭ ╮ ╰ ╯`
`knobby`	`╽ ╿ ╼ ╾ ┎ ┒ ┖ ┚`
`emoji`	`👆 👇 👈 👉 👌 👌 👌 👌`
`outline`	`║ ║ ═ ═ ╔ ╗ ╚ ╝`
`dots`	`• • • • • • • •`
`blocks`	`█ █ ▀ ▀ █ █ ▀ ▀`
`sus`	`ඞ ඞ ඞ ඞ ඞ ඞ ඞ ඞ`

Option	Usage	Example
`-b`	toggles bold text	`-b true`
`-c`	sets the color mode	`-c rgb`
`-d`	sets the delay in ms	`-d 15`
`-i`	toggles if pipes inherit style when hitting the edge	`-i false`
`-k`	sets the kinds of pipes, each kind separated by commas	`-k heavy,curved`
`-p`	sets the number of pipes on screen	`-p 5`
`-r`	sets the percentage of the screen to be filled before resetting	`-r 0.75`
`-t`	chance of a pipe turning each frame	`-t 0.15`
`--palette`	sets the color palette, RGB mode only	`--palette pastel`
`--rainbow`	sets the number of degrees per frame to shift the hue of each pipe, RGB mode only	`--rainbow 5`

pipes-rs lhvy

README

pipes-rs

Installation

Manual Download

Windows Font Issues

Keybindings

Configuration

Color Modes

Palettes

Pipe Kinds

Options

Credits

Contributors

Inspiration