<div align="center">
# rustfetch
**A blazingly fast, highly extensible system information fetch tool written in Rust.**
*Full fastfetch parity • 45+ authentic distro logos • Real hardware probes • Zero runtime bloat*
[](https://github.com/zackmsa777-a11y/rustfetch/actions/workflows/ci.yml)
[](https://github.com/zackmsa777-a11y/rustfetch/releases)
[](LICENSE)
[](https://www.rust-lang.org/)
[](https://github.com/zackmsa777-a11y)
[](#benchmarks)
```text
.... ubuntu@workstation
.',:clooo: .:looooo:. --------------------------
.;looooooooc .oooooooooo' OS: Ubuntu 24.04.4 LTS x86_64
.;looooool:,''. :ooooooooooc Host: KVM/QEMU Standard PC
;looool;. 'oooooooooo, Kernel: Linux 6.17.0-oracle
;clool' .cooooooc. ,, Uptime: 6 days, 21 hours
... ...... .:oo, Packages: 1229 (dpkg), 65 (nix)
.;clol:,. .loooo' Shell: bash 5.2.21
:ooooooooo, 'ooool Display (Virtual-1): 1280x800
'ooooooooooo. loooo. Terminal: alacritty 0.13.0
'ooooooooool coooo. CPU: Intel(R) Xeon(R) (2) @ 2.59 GHz
,loooooooc. .loooo. GPU: QEMU Virtual Video Controller
.,;;;'. ;ooooc Memory: 2.85 GiB / 15.61 GiB (18%)
... ,ooool. Swap: Disabled
.cooooc. ..',,'. .cooo. Disk (/): 38.93 GiB / 47.39 GiB (82%)
;ooooo:. ;oooooooc. :l. Local IP (ens3): 10.0.0.248/24
.coooooc,.. coooooooooo. Locale: C.UTF-8
.:ooooooolc:. .ooooooooooo'
.':loooooo; ,oooooooooc [#] [#] [#] [#] [#] [#] [#] [#]
..';::c' .;loooo:' [#] [#] [#] [#] [#] [#] [#] [#]
```
</div>
---
## Highlights
- **Blazingly Fast**: Executes in **< 5ms** using native Linux `procfs`, `sysfs`, and `libc` calls. No shell forks, no slow subcommands.
- **Interactive Full-Screen Setup TUI (`--setup`)**: Visually browse, preview, and apply 50+ themes with real-time hardware metrics. Features split-screen live preview, full mouse click & scroll wheel support, and zero-latency unbuffered raw input.
- **Distro-Aware Rice Intelligence**: Automatically inspects `/etc/os-release` and surfaces recommended rice presets tailored to your distribution (Ubuntu, Arch, CachyOS, Gentoo, Bedrock, Fedora, Debian, NixOS, Mint, and more) flagged with `[rec]`.
- **50+ Built-in Themes & Layouts**: Tree branch graphs, compact card frames, retro amber CRT, neon cyberpunk, matrix rain, quiet monochrome paper, and iconic palettes (Catppuccin Mocha/Macchiato, Tokyo Night, Dracula, Nord, Gruvbox, Everforest, Synthwave '84, Monokai Pro, One Dark).
- **Authentic Fastfetch ASCII Logos**: 45+ pixel-perfect logos matching Fastfetch, compiled directly into Rust with accurate brand colors and automatic runtime fallback. Clean terminal aesthetics with zero emojis.
- **Concurrent Multi-threaded Probes**: Hardware and environment modules run in parallel with scoped threads (`std::thread::scope`).
- **Real System Detection**: Real hardware metrics—not hardcoded strings or mock prints. Accurately queries CPU, GPU, memory, swap, mount points, battery, displays, desktop environments, window managers, themes, fonts, and network interfaces.
- **Cross-Platform Info Backends**: Linux remains the full default; macOS and Windows compile dedicated core probes (see [Platform Support](#platform-support)).
- **Structured JSON & Config Export**: Full `--json` export for scripts and monitoring, plus instant `[e]` export from the TUI to save any theme as custom JSONC to `~/.config/rustfetch/config.jsonc`.
- **Clean Empty-Module Filtering**: Blank info lines are hidden by default (ideal for containers/VMs); opt back in with `--show-empty` or `display.showEmpty`.
- **Image Logos (Kitty, Sixel, iTerm2)**: High-resolution image rendering via Kitty Graphics Protocol (`t=f` / `t=d`), Sixel (PNG/JPEG encode), and iTerm2 inline images (`OSC 1337`). Auto mode probes `$TERM`, `$TERM_PROGRAM`, `KITTY_WINDOW_ID`, `ITERM_SESSION_ID`, and related env vars (WezTerm, foot, Windows Terminal, iTerm2, etc.). Includes dimension probing, aspect-aware cell sizing, and padding options. Unsupported terminals fall back to ASCII logos.
- **Pure Self-Documenting Architecture**: Built with zero source-code comments for maximum cleanliness and maintainability.
---
## Benchmarks
Measured on a standard Linux workstation (average of 50 runs):
| **`rustfetch`** | **Rust** | **~4.8 ms** | **~3.2 MB** | **0 (Direct sysfs/procfs/libc)** |
| `fastfetch` | C | ~4.5 ms | ~4.1 MB | 0 |
| `neofetch` | Bash | ~280 ms | ~18.5 MB | 25+ subshells |
| `screenfetch` | Bash | ~410 ms | ~24.0 MB | 35+ subshells |
---
## Installation
### Requirements (source builds)
- **Rust 1.88+** (edition 2024 + let-chains).
- Recommended: install via [rustup](https://rustup.rs/) and keep `stable` updated.
### Prebuilt Binary (recommended)
```bash
The installer detects OS/arch, prefers the latest GitHub Release asset for
`zackmsa777-a11y/rustfetch` (musl → gnu on Linux, darwin on macOS), validates
the gzip archive, and falls back to `cargo install --path` (from a checkout) or
`cargo install --git` if no matching asset exists.
Environment knobs:
| `INSTALL_DIR` | Install prefix for the binary (default: writable `/usr/local/bin`, else `~/.local/bin`) |
| `FORCE=1` | Reinstall even when the installed version already matches the latest tag |
| `METHOD=cargo` | Skip release downloads; use cargo (`--path` or `--git`) |
You can also grab release archives directly from [GitHub Releases](https://github.com/zackmsa777-a11y/rustfetch/releases/latest).
### Cargo (crates.io)
The crates.io package is named **`rustftechh`** (the GitHub repo stays `rustfetch`).
Installing the crate places the **`rustfetch`** binary on your `PATH`:
```bash
cargo install rustftechh --locked
# -> ~/.cargo/bin/rustfetch
```
> **Note:** The name `rustfetch` was already taken on crates.io by another project
> (max version **0.5.0**, owner [`dtomvan`](https://github.com/dtomvan)). This
> project therefore publishes as **`rustftechh`**; docs live at
> [docs.rs/rustftechh](https://docs.rs/rustftechh). Until the crate is published,
> use the git/`install.sh` methods below.
### Cargo via Git
```bash
cargo install --git https://github.com/zackmsa777-a11y/rustfetch.git --locked
```
### Build from Source / Makefile
```bash
git clone https://github.com/zackmsa777-a11y/rustfetch.git
cd rustfetch
cargo build --release
# or:
make install # -> ~/.local/bin/rustfetch
make completions-install # bash/zsh/fish under ~/.local/share/...
make man-install # -> ~/.local/share/man/man1/rustfetch.1
```
Equivalent manual copy:
```bash
cp target/release/rustfetch ~/.cargo/bin/
# or: cargo install --path . --locked
```
### Homebrew
Tap: [zackmsa777-a11y/homebrew-rustftechh](https://github.com/zackmsa777-a11y/homebrew-rustftechh)
(formula builds from source; installs the `rustfetch` binary).
```bash
brew tap zackmsa777-a11y/rustftechh
brew install rustftechh
rustfetch --version
```
### Nix
Flake (binary name **`rustfetch`**; crates.io crate **`rustftechh`**):
```bash
nix run github:zackmsa777-a11y/rustfetch -- --version
nix profile install github:zackmsa777-a11y/rustfetch
# or from crates.io once packaged in nixpkgs: nix-shell -p rustfetch
```
From a checkout: `nix build .#rustfetch` then `./result/bin/rustfetch --version`.
Packaging notes and a nixpkgs `fetchCrate` stub live under [`packaging/nix/`](packaging/nix/).
### AUR (PKGBUILD stub — not uploaded yet)
Arch packaging stubs: [`packaging/aur/PKGBUILD`](packaging/aur/PKGBUILD) and
[`packaging/aur/.SRCINFO`](packaging/aur/.SRCINFO) (`pkgname=rustftechh`, binary
`/usr/bin/rustfetch`). See [`packaging/aur/README.md`](packaging/aur/README.md)
for checksum / `.SRCINFO` steps.
```bash
# When uploaded to the AUR:
yay -S rustftechh
# or: paru -S rustftechh
```
### Debian / Ubuntu / Mint (.deb)
Package name **`rustftechh`** (matches crates.io); installs **`/usr/bin/rustfetch`**.
Not in the Debian/Ubuntu archives yet — `.deb` files ship via
[GitHub Releases](https://github.com/zackmsa777-a11y/rustfetch/releases)
(or build with [`packaging/apt/build-deb.sh`](packaging/apt/build-deb.sh)).
See [`packaging/apt/README.md`](packaging/apt/README.md).
```bash
sudo apt install ./rustftechh_*.deb
rustfetch --version
```
### Scoop (Windows)
Bucket: [zackmsa777-a11y/scoop-rustftechh](https://github.com/zackmsa777-a11y/scoop-rustftechh).
Until Windows release zips ship, prefer Cargo on Windows:
```powershell
scoop bucket add rustftechh https://github.com/zackmsa777-a11y/scoop-rustftechh
cargo install rustftechh --locked
```
### Shell Completions
Generate a completion script for your shell and install it in the usual location:
```bash
# Bash (requires bash-completion)
mkdir -p ~/.local/share/bash-completion/completions
rustfetch --completions bash > ~/.local/share/bash-completion/completions/rustfetch
# Zsh (add to fpath or copy into a directory already on fpath)
rustfetch --completions zsh > ~/.zsh/completions/_rustfetch
# or: source <(rustfetch --completions zsh)
# Fish
rustfetch --completions fish > ~/.config/fish/completions/rustfetch.fish
# From a source checkout via Makefile:
make completions-install
```
Checked-in copies also live under `completions/` (`rustfetch.bash`, `rustfetch.zsh`, `rustfetch.fish`) for packaging.
### Man Page
```bash
# From a source checkout
sudo mkdir -p /usr/local/share/man/man1
sudo cp man/rustfetch.1 /usr/local/share/man/man1/
# or user-local:
mkdir -p ~/.local/share/man/man1
cp man/rustfetch.1 ~/.local/share/man/man1/
- **Category Tabs**: Filter themes instantly with `Tab` / `Shift+Tab`, number keys `1`..`7`, or direct mouse clicks on the top pill bar:
- `[1: All]` - Complete catalog of all 50+ themes and rices.
- `[2: Recommended]` - Distro-specific themes tailored to your detected operating system.
- `[3: Kitty/Images]` - High-resolution image logo presets using the Kitty Graphics Protocol.
- `[4: Layouts]` - Tree branches, cards, dense blocks, prompt rices, CRT, and matrix styles.
- `[5: Distros]` - Dedicated rices for Ubuntu, Arch, CachyOS, Gentoo, Bedrock, Fedora, Debian, NixOS, Mint, etc.
- `[6: Palettes]` - Iconic color schemes (Catppuccin Mocha/Macchiato, Tokyo Night, Dracula, Nord, Gruvbox, Everforest, etc.).
- `[7: Mascot Art]` - Ferris the Rust crab and Tux the Linux penguin.
- **Left Pane**: Categorized theme catalog grouped with clear section headers and item counts (`── Section (count) ──`).
- **Right Pane**: Instant real-time live preview rendered using your actual hardware metrics. For Kitty image presets, displays a dedicated image card preview detailing dimensions, cell footprint, protocol, and aspect metrics.
### Controls & Mouse Navigation
| **`Tab` / `Shift+Tab`** | Cycle through category filter tabs |
| **`1` .. `7`** | Jump directly to category tab (1: All, 2: Rec, 3: Kitty, 4: Layouts, 5: Distros, 6: Palettes, 7: Mascots) |
| **`Mouse Click`** | Click category tab pills to filter; click themes to select; click footer buttons to Apply, Export, or Quit |
| **`Mouse Scroll`** | Scroll wheel up / down through the active theme list |
| **`↑` / `k`** or **`↓` / `j`** | Move selection up / down one theme (smoothly steps over section headers) |
| **`PageUp`** / **`PageDown`** | Jump 5 themes up / down |
| **`Home` / `g`** or **`End` / `G`** | Jump to first / last theme in current category |
| **`Enter`** | **Apply & Save** selected theme to `~/.config/rustfetch/config.jsonc` |
| **`e`** | **Export** theme to `~/.config/rustfetch/config.jsonc` as a custom theme |
| **`q`** / **`Esc`** / **`Ctrl+C`** | Exit setup without saving changes |
> **Non-Interactive Fallback**: When stdout/stdin is redirected or not a TTY (e.g. piped or automated), `rustfetch --setup` gracefully falls back to a clean numbered command-line prompt organized by section.
---
## Usage & CLI Options
```text
USAGE:
rustfetch [OPTIONS]
OPTIONS:
--setup, --themes Interactive full-screen theme & layout setup TUI
--theme <NAME> Use a theme once without saving
--set-theme <NAME> Save a theme as default in the config file
--list-themes List all available color themes and layouts
--preview-themes Print a live preview of every theme
--logo <NAME> Specify a custom distro or OS logo
--logo-color <COLOR> Override the logo primary ANSI color
--logo-type <TYPE> Logo type: kitty, kitty-direct, kitty-icat, sixel, iterm, file, builtin, auto
--kitty <PATH> Display an image logo using the Kitty graphics protocol
--kitty-direct <PATH> Display an image using direct Kitty file transfer
--kitty-icat <PATH> Display an image via kitten icat tool
--sixel <PATH> Display an image logo using the Sixel protocol
--iterm <PATH> Display an image logo using iTerm2 inline images
--logo-width <NUM> Target width in terminal character cells for image logo
--logo-height <NUM> Target height in terminal character cells for image logo
--logo-padding <NUM> Horizontal gap between image logo and module lines
--logo-padding-left <NUM> Left padding spaces before the image
--logo-padding-top <NUM> Top padding empty lines before image and text
--no-logo Hide the ASCII distro logo
-f, --fast Minimal sfetch-like profile (os/host/kernel/wm/terminal, builtin logo)
--no-color Disable ANSI terminal colors
--color <MODE> Color output mode (always, auto, never)
--structure <LIST> Colon or comma-separated list of modules to display
--disk-paths <PATHS> Comma-separated list of mount paths to check (default: /)
--config <PATH> Path to custom JSON/JSONC configuration file
--gen-config Print default JSON configuration to stdout
--import-fastfetch [PATH] Import a fastfetch JSON/JSONC config into rustfetch
--force Overwrite an existing rustfetch config when importing
--dry-run Print the mapped import to stdout without writing
--list-logos List all supported distro and OS logos
--list-modules List all available information modules
--json Output system information in structured JSON format
--show-empty Show info modules even when their value is empty
--completions <SHELL> Print shell completion script (bash, zsh, fish)
-v, --version Print version information
-h, --help Print help information
```
Empty info modules (common in containers/VMs) are **hidden by default** in human output. Use `--show-empty` or set `"display": { "showEmpty": true }` in config to restore blank keys. `--json` always includes null/empty fields for scripting.
### Common Examples
```bash
# Default auto-detected fetch
rustfetch
# Launch interactive visual setup TUI
rustfetch --setup
# Display high-resolution image logo via Kitty Graphics Protocol
rustfetch --kitty ~/Pictures/avatar.png
rustfetch --kitty ~/Pictures/wallpaper.png --logo-width 36 --logo-padding 4
# Direct transmission mode (works over SSH or inside containers without shared filesystem)
rustfetch --kitty-direct ~/Pictures/logo.png
# Sixel (WezTerm, foot, Windows Terminal where supported, mlterm, etc.)
rustfetch --sixel ~/Pictures/avatar.png
rustfetch --logo-type sixel --logo ~/Pictures/avatar.png --logo-width 30
# iTerm2 inline images (iTerm2, and other OSC 1337 terminals)
rustfetch --iterm ~/Pictures/avatar.png
# Auto-detect image protocol from the terminal environment
rustfetch --logo-type auto --logo ~/Pictures/avatar.png
# Try a theme once without modifying configuration
rustfetch --theme groups
rustfetch --theme catppuccin-mocha
rustfetch --theme cachyos-speed
# Permanently set default theme in ~/.config/rustfetch/config.jsonc
rustfetch --set-theme tokyo-night
# List all available built-in and user themes
rustfetch --list-themes
# Force a specific distro logo (e.g. Arch, CachyOS, Gentoo, Bedrock, or Ferris)
rustfetch --logo arch
rustfetch --logo cachyos
rustfetch --logo gentoo
rustfetch --logo bedrock
rustfetch --logo rust
# Fast minimal profile (sfetch-like; ignores expensive modules)
rustfetch --fast
# Select custom modules and ordering
rustfetch --structure title:os:kernel:cpu:gpu:memory:disk:colors
# Import a fastfetch config into ~/.config/rustfetch/config.jsonc
rustfetch --import-fastfetch
rustfetch --import-fastfetch ~/.config/fastfetch/config.jsonc --dry-run
# Output raw JSON for scripting or monitoring
# Minimal fetch with no logo
rustfetch --no-logo
# Show empty modules (containers / VMs)
rustfetch --show-empty
# Print bash completion script
rustfetch --completions bash
```
---
## Themes & Distro Ricing
`rustfetch` comes with 50+ built-in presets covering major distributions, community desktop rices, and legendary colorways.
### Distro-Specific Themes
- **Ubuntu**: `ubuntu-classic`, `ubuntu-modern`, `ubuntu-tree`, `ubuntu-minimal`, `ubuntu-mini`
- **Arch Linux**: `arch-clean`
- **CachyOS**: `cachyos-speed` (x86-64-v3/v4 teal & cyan layout)
- **Bedrock Linux**: `bedrock-strata` (multi-distro meta layout with silver accents)
- **Gentoo**: `gentoo-purple` (compiled-from-source purple & lavender aesthetic)
- **Debian**: `debian-swirl` (classic ruby swirl & soft white)
- **Fedora**: `fedora-blue` (navy & ocean blue with double-colon keys)
- **NixOS**: `nixos-snowflake` (glacial cyan snowflake motif)
- **Linux Mint**: `mint-fresh` (fresh mint green & silver leaf elegance)
- **openSUSE**: `opensuse-geek` (gecko green & rolling chameleon speed)
- **Pop!_OS**: `pop-cosmic` (cosmic teal & amber accents)
- **Void Linux**: `void-xbps` (runit fast, xbps green & graphite precision)
- **Alpine Linux**: `alpine-peak` (ultra-lightweight alpine blue & summit white)
- **Manjaro**: `manjaro-teal` (signature dark teal & neon emerald flow)
- **Kali Linux**: `kali-dragon` (security dragon deep cobalt & obsidian cyan)
- **EndeavourOS**: `endeavour-space` (interstellar violet, magenta & cosmic orange)
- **RHEL**: `redhat-shadow` (corporate crimson shadow)
### Layout Styles & Terminal Rices
- **`groups`**: Grouped tree branches with glyph connectors (`├─`, `└─`).
- **`hypr`**: Colour-dot bar framing a compact block layout.
- **`rice`**: Card frame with rule lines, bracketed labels, and piped values.
- **`cyber`**: Neon cyan on magenta with arrow keys and glowing block marks.
- **`retro`**: Amber CRT terminal aesthetics with prompt art and double-colon keys.
- **`matrix`**: Terminal green digital rain motif.
- **`paper`**: Quiet monochrome with soft grey keys and middle-dot separators.
- **`minimal`**: Single-column four-letter abbreviations with rainbow palette.
- **`ferris-crab`**: Rustacean mascot ASCII art with fiery rust tones.
- **`tux-penguin`**: Classic Linux Tux art in clean monochrome.
### Community Color Palettes
- **Catppuccin**: `catppuccin-mocha`, `catppuccin-macchiato`
- **Tokyo Night**: `tokyo-night`
- **Dracula**: `dracula`
- **Nord**: `nord`
- **Gruvbox**: `gruvbox`
- **Everforest**: `everforest`
- **Solarized**: `solarized-dark`
- **Synthwave '84**: `synthwave-84`
- **Monokai Pro**: `monokai-pro`
- **One Dark**: `one-dark`
### Custom Theme Files
Drop any `.jsonc` theme into `~/.config/rustfetch/themes/<name>.jsonc`:
```jsonc
{
"$schema": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json",
"display": {
"separator": " -> ",
"color": {
"keys": "magenta",
"title": "bright_cyan"
}
},
"modules": [
"title",
"separator",
{ "type": "os", "key": "os" },
{ "type": "cpu", "key": "cpu" },
{ "type": "memory", "key": "ram" },
"colors"
]
}
```
Run your custom theme instantly:
```bash
rustfetch --theme <name>
```
---
## Supported Distros & Logos
Run `rustfetch --list-logos` to see all supported identifiers:
| **AlmaLinux** | `--logo almalinux` | Alma Blue |
| **Alpine Linux** | `--logo alpine` | Alpine Blue |
| **Android** | `--logo android` | Android Green |
| **Arch Linux** | `--logo arch` | Cyan |
| **Artix Linux** | `--logo artix` | Artix Cyan |
| **Bedrock Linux** | `--logo bedrock` | Bedrock White |
| **CachyOS** | `--logo cachyos` | Cyan / Emerald |
| **CentOS** | `--logo centos` | CentOS Purple |
| **Debian** | `--logo debian` | Debian Crimson |
| **Devuan** | `--logo devuan` | Devuan Purple |
| **DragonFly BSD** | `--logo dragonfly` | Red |
| **elementary OS** | `--logo elementary` | Blue |
| **EndeavourOS** | `--logo endeavouros` | Magenta |
| **Fedora** | `--logo fedora` | Fedora Blue |
| **FreeBSD** | `--logo freebsd` | FreeBSD Red |
| **Garuda Linux** | `--logo garuda` | Garuda Cyan |
| **Gentoo** | `--logo gentoo` | Gentoo Purple |
| **GNU Guix** | `--logo guix` | Guix Yellow |
| **Haiku** | `--logo haiku` | Haiku Yellow |
| **Kali Linux** | `--logo kali` | Kali Blue |
| **Linux Mint** | `--logo mint` | Mint Green |
| **Mageia** | `--logo mageia` | Mageia Blue |
| **Manjaro** | `--logo manjaro` | Forest Green |
| **macOS** | `--logo macos` | Apple White |
| **MX Linux** | `--logo mx` | White |
| **NetBSD** | `--logo netbsd` | NetBSD Orange |
| **NixOS** | `--logo nixos` | Light Cyan |
| **OpenBSD** | `--logo openbsd` | OpenBSD Yellow |
| **openSUSE** | `--logo opensuse` | Gecko Green |
| **Oracle Linux** | `--logo oracle` | Oracle Red |
| **Parrot OS** | `--logo parrot` | Parrot Cyan |
| **Pop!_OS** | `--logo pop` | Cyan |
| **Raspberry Pi OS** | `--logo raspberry` | Raspberry Red |
| **Red Hat / RHEL** | `--logo redhat` | Red Hat Red |
| **Rocky Linux** | `--logo rocky` | Rocky Green |
| **Rust (Ferris)** | `--logo rust` | Rust Orange |
| **Slackware** | `--logo slackware` | Dark Blue |
| **Solaris / Illumos** | `--logo solaris` | Sun Yellow |
| **Solus** | `--logo solus` | Solus Blue |
| **SteamOS** | `--logo steamos` | Steam Blue |
| **Tails** | `--logo tails` | Tails Purple |
| **Ubuntu** | `--logo ubuntu` | Bright Red / Orange |
| **Void Linux** | `--logo void` | Void Green |
| **Windows** | `--logo windows` | Windows Cyan |
| **Zorin OS** | `--logo zorin` | Zorin Blue |
| **Generic Linux (Tux)** | `--logo linux` | Tux Yellow |
---
## Available Modules
Run `rustfetch --list-modules` to see the complete module catalog:
| `title` | `username@hostname` | `$USER` / `/etc/hostname` / libc |
| `separator` | Horizontal divider dashes | String repeat matching title width |
| `os` | Distro name, version & architecture | `/etc/os-release`, `uname` |
| `host` | Motherboard, model, virtualization | DMI sysfs, ARM device-tree, systemd-virt |
| `kernel` | Operating system kernel release | `/proc/sys/kernel/osrelease`, `uname` |
| `uptime` | Human-readable system uptime | `/proc/uptime`, `sysinfo` |
| `packages` | Installed packages count | dpkg, pacman, rpm, flatpak, snap, nix, apk, brew |
| `shell` | Current shell and version | `$SHELL`, `--version` |
| `display` | Monitor resolution and refresh rate | DRM modes, X11 xrandr, Wayland hyprctl |
| `de` | Desktop Environment | `$XDG_CURRENT_DESKTOP`, desktop sessions |
| `wm` | Window Manager | Active Wayland compositors & X11 WMs |
| `wm_theme` | Window manager theme | Window manager settings |
| `theme` | GTK/Qt theme | `~/.config/gtk-3.0/settings.ini` |
| `icons` | Desktop icon theme | GTK settings / dconf |
| `font` | System UI font | GTK settings |
| `cursor` | Mouse cursor theme | GTK settings |
| `terminal` | Terminal emulator & version | Process tree walker, `$TERM_PROGRAM` |
| `terminal_font` | Terminal typeface font | Terminal configuration files |
| `cpu` | CPU model, core count, frequency | `/proc/cpuinfo`, cpufreq sysfs |
| `gpu` | Dedicated & integrated graphics | PCI bus scan, `nvidia-smi`, `lspci` |
| `memory` | Used and total RAM with % | `/proc/meminfo` (MemTotal - MemAvailable) |
| `swap` | Used and total swap space with % | `/proc/meminfo` (SwapTotal - SwapFree) |
| `disk` | Partition usage and filesystem type | `statvfs` on `/proc/mounts` |
| `battery` | Battery percentage & charging status | `/sys/class/power_supply/BAT*` |
| `power_adapter`| AC adapter connected status | `/sys/class/power_supply/AC*` |
| `audio` | Sound devices & audio server | `/proc/asound/cards`, ALSA/PipeWire |
| `local_ip` | Primary interface IP and CIDR subnet | `/proc/net/route`, `getifaddrs` |
| `locale` | System locale and encoding | `$LC_ALL`, `$LANG` |
| `command` | Run a command; show trimmed stdout | `std::process::Command` (optional `shell: true`), default 1.5s timeout |
| `custom` | Static keyed text (`key`+`text`) or decorative `format` line | Config only |
| `break` | Blank spacing line | Terminal newline |
| `colors` | 16 ANSI color palette blocks | 8 standard + 8 bright background blocks |
---
## Configuration (`config.jsonc`)
`rustfetch` uses the standard fastfetch JSON/JSONC configuration schema and automatically looks for configs in:
1. `--config <path>`
2. `$XDG_CONFIG_HOME/rustfetch/config.jsonc`
3. `~/.config/rustfetch/config.jsonc`
4. `~/.config/fastfetch/config.jsonc` (fastfetch fallback)
Generate a template configuration with:
```bash
rustfetch --gen-config > ~/.config/rustfetch/config.jsonc
```
### Import from fastfetch
Migrate an existing fastfetch JSON/JSONC config into rustfetch's config path:
```bash
# Auto-discover ~/.config/fastfetch/config.jsonc (or config.json / $XDG_CONFIG_HOME/...)
rustfetch --import-fastfetch
# Explicit source path
rustfetch --import-fastfetch ~/.config/fastfetch/config.jsonc
# Preview the mapped config without writing
rustfetch --import-fastfetch --dry-run
# Choose destination and overwrite if needed
rustfetch --import-fastfetch ./my-fastfetch.jsonc --config ~/.config/rustfetch/config.jsonc --force
```
Supported keys (`logo`, `display` separator/colors, `modules`, `disk_paths`, …) are mapped; unknown top-level keys and unsupported modules are skipped with a stderr warning. Disk `folders` inside a fastfetch `disk` module become `disk_paths`.
### Custom / script modules
Inject arbitrary lines (weather, now-playing, git user, etc.) into the fetch:
```jsonc
{
"modules": [
"title",
"separator",
{ "type": "os", "key": "OS" },
{ "type": "command", "key": "Weather", "command": "curl -s wttr.in/?format=3" },
{ "type": "command", "key": "Editor", "text": "echo $EDITOR", "shell": true, "timeout": 2000 },
{ "type": "custom", "key": "Git", "text": "zackmsa777-a11y" },
"break",
"colors"
]
}
```
- `command`: runs via `std::process::Command` (split on whitespace) unless `"shell": true` (`/bin/sh -c`). Fastfetch-compatible `"text"` is accepted as the command string. Default timeout is **1500ms**; hung commands are killed. Non-zero exit / timeout / empty stdout → hidden (same as other empty modules) unless `"showFailure": true` or `--show-empty` / `display.showEmpty`.
- `custom`: with `"key"` + `"text"` prints a normal keyed line; with only `"format"` (legacy) prints a decorative structural line (used by layout themes).
- Aliases: `exec` → `command`, `static` → `custom`. `--import-fastfetch` maps fastfetch `command` modules (copies `text` → `command`).
### Example `config.jsonc`
```jsonc
{
"$schema": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json",
"logo": {
"source": "auto",
"color": {
"1": "auto"
}
},
"display": {
"separator": ": ",
"color": {
"keys": "auto"
}
},
"modules": [
"title",
"separator",
{ "type": "os", "key": "OS" },
{ "type": "host", "key": "Host" },
{ "type": "kernel", "key": "Kernel" },
{ "type": "uptime", "key": "Uptime" },
{ "type": "packages", "key": "Packages" },
{ "type": "shell", "key": "Shell" },
{ "type": "display", "key": "Display" },
{ "type": "de", "key": "DE" },
{ "type": "wm", "key": "WM" },
{ "type": "theme", "key": "Theme" },
{ "type": "icons", "key": "Icons" },
{ "type": "font", "key": "Font" },
{ "type": "cursor", "key": "Cursor" },
{ "type": "terminal", "key": "Terminal" },
{ "type": "terminalfont", "key": "Terminal Font" },
{ "type": "cpu", "key": "CPU" },
{ "type": "gpu", "key": "GPU" },
{ "type": "memory", "key": "Memory" },
{ "type": "swap", "key": "Swap" },
{ "type": "disk", "key": "Disk" },
{ "type": "battery", "key": "Battery" },
{ "type": "poweradapter", "key": "Power Adapter" },
{ "type": "localip", "key": "Local IP" },
{ "type": "locale", "key": "Locale" },
"break",
"colors"
],
"disk_paths": ["/"]
}
```
### Kitty Graphics & Image Themes
Image logos support **Kitty**, **Sixel**, and **iTerm2** protocols. Sixel encoding accepts PNG/JPEG (decoded via the `image` crate), quantizes to a 6-level RGB palette (up to 216 colors), and targets roughly 10×20 pixels per terminal cell (capped for size). iTerm2 sends the original file bytes as base64 with cell width/height hints. If the chosen protocol is unsupported or encoding fails, rustfetch falls back to the ASCII distro logo.
`rustfetch` includes out-of-the-box Kitty image presets that work immediately:
```bash
# Sleek modern 2-column card with bundled/detected image logo
rustfetch --theme kitty-modern
# Boxed card frame with green accents
rustfetch --theme kitty-card
# Minimal compact 4-letter metrics
rustfetch --theme kitty-minimal
# Or pass your own image directly
rustfetch --kitty ~/Pictures/avatar.png
```
To configure a high-resolution image logo permanently in `~/.config/rustfetch/config.jsonc`:
```jsonc
{
"$schema": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json",
"logo": {
"source": "~/Pictures/avatar.png", // or "kitty:example" for bundled sample
"type": "kitty",
"width": 30,
"padding": {
"top": 1,
"left": 1,
"right": 4
}
}
}
```
---
## Platform Support
Info backends are selected at compile time via `#[cfg(target_os = ...)]` under `src/info/platform/`. Logos for macOS, Windows, and others already ship on every OS.
| **Linux** | **Full** | Default path: `procfs` / `sysfs` / `libc` for all modules (OS, host, kernel, uptime, packages, shell, DE/WM, terminal, CPU, GPU, memory, swap, disk, battery, audio, network, locale, …). |
| **macOS (Darwin)** | **Core** | OS, host (`hw.model`), kernel, uptime, CPU, memory, swap, packages (Homebrew / MacPorts), shell, terminal (`TERM_PROGRAM`), disk (`statfs` + `/Volumes`), battery (`pmset` with timeout). DE/WM, GPU, display, audio, and local IP are best-effort / empty for now. |
| **Windows** | **Core** | OS, host (BIOS registry), kernel/build (`RtlGetVersion`), uptime, CPU, memory, swap (page file), disk (`GetDiskFreeSpaceExW`), shell (PowerShell / `ComSpec`), terminal (Windows Terminal / env). Packages, battery, GPU, DE/WM, audio, and network left for later. |
| **Other** | **Logos / best-effort** | FreeBSD, OpenBSD, NetBSD, Haiku, Android, etc. get ASCII logos; probes fall through the non-macOS/non-Windows path where possible and otherwise hide empty modules. |
### Cross-checking Darwin / Windows from Linux
Rust does not compile foreign `#[cfg]` modules on the host target. To typecheck those backends:
```bash
./scripts/check-cross.sh
# or manually:
rustup target add aarch64-apple-darwin x86_64-apple-darwin x86_64-pc-windows-gnu x86_64-pc-windows-msvc
cargo check --target aarch64-apple-darwin
cargo check --target x86_64-pc-windows-gnu
```
Linking a full binary may fail without an Apple/Windows linker toolchain; a successful `cargo check` (or compile errors from the platform modules themselves) is enough to validate the source. Runtime verification still requires the real OS.
---
## Author & Maintainer
Created, designed, and maintained by **Zack** ([@zackmsa777-a11y](https://github.com/zackmsa777-a11y)).
---
## Contributing
Contributions, bug reports, and logo submissions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the zero-comment code standard, test requirements, and workflow.
---
## License
This project is dual-licensed under either:
- **MIT License** ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
- **Apache License, Version 2.0** ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
at your option.