{"id":15116875,"url":"https://github.com/lhvy/pipes-rs","last_synced_at":"2025-05-16T04:04:02.353Z","repository":{"id":38313818,"uuid":"331470563","full_name":"lhvy/pipes-rs","owner":"lhvy","description":"An over-engineered rewrite of pipes.sh in Rust","archived":false,"fork":false,"pushed_at":"2024-10-20T14:03:14.000Z","size":248,"stargazers_count":397,"open_issues_count":1,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-08T14:08:39.459Z","etag":null,"topics":["cli","emojis","hacktoberfest","pipes-rs","rust","terminal"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lhvy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-21T00:34:15.000Z","updated_at":"2025-04-05T09:26:57.000Z","dependencies_parsed_at":"2023-10-16T14:17:45.287Z","dependency_job_id":"5db5f923-8198-4bc2-8986-92c2ca5e0bb2","html_url":"https://github.com/lhvy/pipes-rs","commit_stats":{"total_commits":172,"total_committers":9,"mean_commits":19.11111111111111,"dds":0.5174418604651163,"last_synced_commit":"ab67f68476e9d4284a4cc7ac30a195b83a067776"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhvy%2Fpipes-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhvy%2Fpipes-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhvy%2Fpipes-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhvy%2Fpipes-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lhvy","download_url":"https://codeload.github.com/lhvy/pipes-rs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254464891,"owners_count":22075570,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","emojis","hacktoberfest","pipes-rs","rust","terminal"],"created_at":"2024-09-26T01:45:22.115Z","updated_at":"2025-05-16T04:04:02.331Z","avatar_url":"https://github.com/lhvy.png","language":"Rust","funding_links":[],"categories":["Rust","CLI/TUI Apps"],"sub_categories":["Other"],"readme":"# pipes-rs\n\n![GitHub Actions CI status](https://github.com/lhvy/pipes-rs/actions/workflows/ci.yaml/badge.svg)\n\n\u003e An over-engineered rewrite of pipes.sh in Rust\n\n![pipes-rs preview](https://github.com/lhvy/i/raw/master/pipes-rs-preview.gif)\n\n## Installation\n\nInstall the latest version release via git on any platform using Cargo:\n\n```sh\ncargo install --git https://github.com/lhvy/pipes-rs\n```\n\nAlternatively for macOS, install via Homebrew:\n\n```sh\nbrew install lhvy/tap/pipes-rs\n```\n\nAlternatively for Windows, install via Scoop:\n\n```sh\nscoop bucket add extras\nscoop install pipes-rs\n```\n\n### Manual Download\n\nDownload compiled binaries from [releases](https://github.com/lhvy/pipes-rs/releases/latest).\n\n## Windows Font Issues\n\nThere have been reports that some characters pipes-rs uses are missing on Windows, which causes them to appear as [tofu](https://en.wikipedia.org/wiki/Noto_fonts#Etymology). If you experience this issue, try using a font with a large character set, such as [Noto Mono](https://www.google.com/get/noto/).\n\n## Keybindings\n\n- \u003ckbd\u003er\u003c/kbd\u003e: reset the screen\n- \u003ckbd\u003eq\u003c/kbd\u003e or \u003ckbd\u003e^C\u003c/kbd\u003e: exit the program\n\n## Configuration\n\npipes-rs can be configured using TOML located at `~/.config/pipes-rs/config.toml`.\nThe following is an example file with the default settings:\n\n```toml\nbold = true\ncolor_mode = \"ansi\" # ansi, rgb or none\npalette = \"default\" # default, darker, pastel or matrix\nrainbow = 0 # 0-255\ndelay_ms = 20\ninherit_style = false\nkinds = [\"heavy\"] # heavy, light, curved, knobby, emoji, outline, dots, blocks, sus\nnum_pipes = 1\nreset_threshold = 0.5 # 0.0–1.0\nturn_chance = 0.15 # 0.0–1.0\n```\n\n### Color Modes\n\n| Mode   | Description                                                                       |\n| :----- | :-------------------------------------------------------------------------------- |\n| `ansi` | pipe colors are randomly selected from the terminal color profile, default option |\n| `rgb`  | pipe colors are randomly generated rgb values, unsupported in some terminals      |\n| `none` | pipe colors will not be set and use the current terminal text color               |\n\n### Palettes\n\n| Palette   | Description                                                      |\n| :-------- | :--------------------------------------------------------------- |\n| `default` | bright colors – good on dark backgrounds, default option         |\n| `darker`  | darker colors – good on light backgrounds                        |\n| `pastel`  | pastel colors – good on dark backgrounds                         |\n| `matrix`  | colors based on [Matrix digital rain] – good on dark backgrounds |\n\n### Pipe Kinds\n\n| Kind      | Preview                   |\n| :-------- | :------------------------ |\n| `heavy`   | `┃ ┃ ━ ━ ┏ ┓ ┗ ┛`         |\n| `light`   | `│ │ ─ ─ ┌ ┐ └ ┘`         |\n| `curved`  | `│ │ ─ ─ ╭ ╮ ╰ ╯`         |\n| `knobby`  | `╽ ╿ ╼ ╾ ┎ ┒ ┖ ┚`         |\n| `emoji`   | `👆 👇 👈 👉 👌 👌 👌 👌` |\n| `outline` | `║ ║ ═ ═ ╔ ╗ ╚ ╝`         |\n| `dots`    | `• • • • • • • •`         |\n| `blocks`  | `█ █ ▀ ▀ █ █ ▀ ▀`         |\n| `sus`     | `ඞ ඞ ඞ ඞ ඞ ඞ ඞ ඞ`         |\n\n_Due to emojis having a different character width, using the emoji pipe kind along side another pipe kind can cause spacing issues._\n\n## Options\n\nThere are also command line options that can be used to override parts of the configuration file:\n\n| Option      | Usage                                                                             | Example            |\n| :---------- | :-------------------------------------------------------------------------------- | :----------------- |\n| `-b`        | toggles bold text                                                                 | `-b true`          |\n| `-c`        | sets the color mode                                                               | `-c rgb`           |\n| `-d`        | sets the delay in ms                                                              | `-d 15`            |\n| `-i`        | toggles if pipes inherit style when hitting the edge                              | `-i false`         |\n| `-k`        | sets the kinds of pipes, each kind separated by commas                            | `-k heavy,curved`  |\n| `-p`        | sets the number of pipes on screen                                                | `-p 5`             |\n| `-r`        | sets the percentage of the screen to be filled before resetting                   | `-r 0.75`          |\n| `-t`        | chance of a pipe turning each frame                                               | `-t 0.15`          |\n| `--palette` | sets the color palette, RGB mode only                                             | `--palette pastel` |\n| `--rainbow` | sets the number of degrees per frame to shift the hue of each pipe, RGB mode only | `--rainbow 5`      |\n\n## Credits\n\n### Contributors\n\npipes-rs is maintained by [lhvy](https://github.com/lhvy) and [lunacookies](https://github.com/lunacookies); any other contributions via PRs are welcome! Forks and modifications are implicitly licensed under the Blue Oak Model License 1.0.0. Please credit the above contributors and pipes.sh when making forks or other derivative works.\n\n### Inspiration\n\nThis project is based off of [pipes.sh](https://github.com/pipeseroni/pipes.sh).\n\n[matrix digital rain]: https://en.wikipedia.org/wiki/Matrix_digital_rain\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flhvy%2Fpipes-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flhvy%2Fpipes-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flhvy%2Fpipes-rs/lists"}