rmsthebest / pfetch-rs

A rewrite of the pfetch system information tool in Rust

Home Page:https://crates.io/crates/pfetch

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pfetch-rs

A rewrite of the pfetch system information tool by dylanaraps in Rust


About

If you are familiar with the pfetch system information tool by dylanaraps, this does the exact same thing, but with an about 10x faster runtime. pfetch is simple by design with some (but not many) configuration options and a minimalistic look.

Supported Platforms: Linux, Android, macOS, Windows, FreeBSD, NetBSD

Included Logos: Alpine Linux, Android, AmogOS (new) Arch Linux, ArcoLinux, Artix Linux, Bedrock Linux, Buildroot, CelOS, CentOS, Crystal Linux, dahliaOS, Debian, Devuan, DietPi (new), DragonflyBSD, Elementary OS, EndeavourOS, Fedora, Fiwix (new), FreeBSD, Garuda Linux, Gentoo Linux, Gnu, Guix, Haiku, HydroOS, Hyperbola, instantOS, IRIX, KDE neon, Linux Lite, Linux, Mint, macOS, Mageia, Manjaro, Minix, MorphOS (new), MX Linux, NetBSD, NixOS, Nobara Project (new), OpenBSD, openSUSE Tumbleweed, openSUSE Leap, OpenWrt, Parabola, Pop!_OS (updated), PureOS, Raspbian, SerenityOS, Slackware, Solus, SteamOS (new), Solaris, Ubuntu, Vanilla OS (new), Void Linux, Windows (new), Xeonix Linux

For all other distributions, a penguin will be displayed.

Credit to the original pfetch and its contributors.

If you want to add a logo, feel free to make a Pull Request.

Installation

Binary

Download a binary from the latest release.

Cargo

cargo install pfetch

Homebrew

brew install pfetch-rs

AUR

Install the pfetch-rs or pfetch-rs-bin AUR package.

Performance

Benchmarks performed on an AMD Ryzen 5 3600. Execution time is measured using hyperfine with -w 4 -m 500 -N flags

Implementation Mean [ms] Min [ms] Max [ms]
POSIX sh (bash) 23.7 ± 0.9 22.3 29.3
POSIX sh (dash) 15.9 ± 0.3 15.1 18.2
Rust (v2.3.0) 2.2 ± 0.2 1.8 3.9

Note: This is with pacman and flatpak being the only installed package managers. For more info, see Improving Performance.

Improving Performance

The by far slowest part of the pfetch execution time is counting the installed packages. For most package managers this is still very fast, but there are some (currently nix and zypper) that take ~500ms to report installed packages, which takes away all performance benefits of the Rust version. If you have one or more of these installed, you can skip counting them by setting the PF_FAST_PKG_COUNT environment variable.

Configuration

Like the original pfetch, pfetch-rs is configured through environment variables. Your existing config will probably still work, the only difference is how padding is configured.

If you want to display a custom logo, you will have to download the source code, make your changes to ./pfetch-extractor/logos.sh and build the binary with cargo b --release.

# Which information to display.
# Default: first example below
# Valid: space separated string
#
# OFF by default: shell editor wm de palette
PF_INFO="ascii title os host kernel uptime pkgs memory"

# Example: Only ASCII.
PF_INFO="ascii"

# Example: Only Information.
PF_INFO="title os host kernel uptime pkgs memory"

# A file containing environment variables to source before running pfetch.
# Default: unset
# Valid: A shell script
PF_SOURCE=""

# Separator between info name and info data.
# Default: unset
# Valid: string
PF_SEP=":"

# Enable/Disable colors in output:
# Default: 1
# Valid: 1 (enabled), 0 (disabled)
PF_COLOR=1

# Color of info names:
# Default: unset (auto)
# Valid: 0-9
PF_COL1=4

# Color of info data:
# Default: unset (auto)
# Valid: 0-9
PF_COL2=9

# Color of title data:
# Default: unset (auto)
# Valid: 0-9, COL1 (copies COL1 value)
PF_COL3=1

# Alignment paddings (this is different to the original version).
# Default: unset (auto)
# Valid: int
PF_PAD1=""
PF_PAD2=""
PF_PAD3=""

# Which ascii art to use.
# Default: unset (auto)
# Valid: string
PF_ASCII="openbsd"

# The below environment variables control more
# than just 'pfetch' and can be passed using
# 'HOSTNAME=cool_pc pfetch' to restrict their
# usage solely to 'pfetch'.

# Which user to display.
USER=""

# Which hostname to display.
HOSTNAME=""

# Skip package managers that take "long" to query package count (like nix)
PF_FAST_PKG_COUNT=1

About

A rewrite of the pfetch system information tool in Rust

https://crates.io/crates/pfetch

License:MIT License


Languages

Language:Rust 60.7%Language:Shell 39.3%