retch-cli 0.3.21

.\" Automatically generated by Pandoc 3.7.0.2
.\"
.TH "RETCH" "1" "June 2026" "retch 0.3.21" "System Information Fetcher"
.SH NAME
retch \- a fast, feature\-rich system information fetcher
.SH SYNOPSIS
\f[B]retch\f[R] [\f[I]OPTIONS\f[R]]
.SH DESCRIPTION
\f[B]retch\f[R] is a fast system information tool written in Rust.
It displays detailed information about your system including OS, CPU,
memory, audio, disks, network, Wi\-Fi, Bluetooth, and more, with support
for high\-quality ASCII and graphical logos.
.SH OPTIONS
.TP
\f[B]\-h, \(enhelp\f[R]
Show help information.
.TP
\f[B]\-V, \(enversion\f[R]
Print version information.
.TP
\f[B]\-m, \(enmode\f[R] \f[I]MODE\f[R]
Select output mode (\f[CR]short\f[R], \f[CR]long\f[R], or
\f[CR]custom\f[R]).
.TP
\f[B]\-c, \(enconfig\f[R] \f[I]FILE\f[R]
Path to a custom configuration file instead of the default.
.TP
\f[B]\(enascii\-logo\f[R]
Force ASCII logo output, disabling graphical and Chafa rendering.
.TP
\f[B]\(enchafa\-logo\f[R]
Force Chafa symbols output, disabling high\-res graphical protocols
(Kitty, Sixel, iTerm2).
.TP
\f[B]\(enno\-logo\f[R]
Disable the logo entirely.
.TP
\f[B]\(enlogo\f[R] \f[I]LOGO\f[R]
Force a specific distribution logo by name/ID (e.g.\ \f[CR]pop\f[R],
\f[CR]manjaro\f[R], \f[CR]endeavouros\f[R], \f[CR]opensuse\f[R],
\f[CR]ubuntu\f[R], \f[CR]fedora\f[R], \f[CR]macos\f[R],
\f[CR]windows\f[R]).
.TP
\f[B]\(entheme\f[R] \f[I]THEME\f[R]
Use a specific theme (e.g.\ \f[CR]default\f[R], \f[CR]dark\f[R],
\f[CR]light\f[R], or community themes).
.TP
\f[B]\(enlist\-themes\f[R]
List all available built\-in themes.
.TP
\f[B]\(enprint\-theme\-template\f[R]
Print an example custom theme template to stdout.
.TP
\f[B]\(enprint\-logos\f[R]
Print all available logos.
.TP
\f[B]\(enlist\-distros\f[R]
List known supported distributions.
.TP
\f[B]\(encompletions\f[R] \f[I]SHELL\f[R]
Generate shell completion scripts for the specified shell.
Supported shells are: \f[CR]bash\f[R], \f[CR]elvish\f[R],
\f[CR]fish\f[R], \f[CR]power\-shell\f[R], \f[CR]zsh\f[R],
\f[CR]nushell\f[R].
.TP
\f[B]\(engenerate\-config\f[R]
Print a default configuration file to stdout.
.TP
\f[B]\(enwrite\-config\f[R] [\f[I]PATH\f[R]]
Write the default configuration to a file (uses
\f[CR]\(ti/.config/retch/config.toml\f[R] if no path is given).
.TP
\f[B]\(enmerge\-config\f[R]
Merge default configuration settings (as comments) into an existing
config file at the default path (or custom path if \f[CR]\-\-config\f[R]
is supplied).
.TP
\f[B]\(enfields\f[R] \f[I]FIELDS\f[R]
Comma\-separated list of fields to display, overriding the config
file\(cqs default list.
.TP
\f[B]\-s, \(enshort\f[R]
Short output mode.
Equivalent to \f[CR]\-\-mode short\f[R].
Shows: OS, Kernel, Host, CPU, GPU, Memory, Disk.
.TP
\f[B]\-l, \(enlong\f[R]
Long output mode.
Equivalent to \f[CR]\-\-mode long\f[R].
Shows all available fields.
.SH CONFIGURATION
retch reads its configuration from:
.IP
.EX
$XDG_CONFIG_HOME/retch/config.toml
.EE
.PP
or
.IP
.EX
\(ti/.config/retch/config.toml
.EE
.PP
You can generate a starting configuration with:
.IP
.EX
retch \-\-generate\-config > \(ti/.config/retch/config.toml
.EE
.SS Available Configuration Keys
.IP \(bu 2
\f[B]theme\f[R]: Theme name to use.
(default: \f[CR]\(dqauto\(dq\f[R]).
.IP \(bu 2
\f[B]show_logo\f[R]: Boolean indicating whether to show the logo
(default: \f[CR]true\f[R]).
.IP \(bu 2
\f[B]ascii_only\f[R]: Boolean indicating whether to restrict logo to
ASCII representation.
.IP \(bu 2
\f[B]chafa\f[R]: Boolean indicating whether to force Chafa symbols
output.
.IP \(bu 2
\f[B]logo\f[R]: Distro name/ID to force override logo detection.
.IP \(bu 2
\f[B]fields\f[R]: Array of strings representing active fields and their
display order.
Available fields are:
.RS 2
.IP \(bu 2
\f[CR]os\f[R]: Operating system name.
.IP \(bu 2
\f[CR]kernel\f[R]: Kernel version.
.IP \(bu 2
\f[CR]host\f[R]: System host/product name.
.IP \(bu 2
\f[CR]arch\f[R]: System architecture.
.IP \(bu 2
\f[CR]cpu\f[R]: CPU model name.
.IP \(bu 2
\f[CR]cpu\-freq\f[R]: CPU current/max/min frequencies.
.IP \(bu 2
\f[CR]gpu\f[R]: GPU model(s) and VRAM.
.IP \(bu 2
\f[CR]motherboard\f[R]: Motherboard manufacturer and model.
.IP \(bu 2
\f[CR]bios\f[R]: BIOS vendor and version.
.IP \(bu 2
\f[CR]display\f[R]: Connected monitor displays with refresh rates and
resolution.
.IP \(bu 2
\f[CR]audio\f[R]: Audio card controller and active sound servers
(PipeWire, PulseAudio, ALSA, CoreAudio, Windows Audio).
.IP \(bu 2
\f[CR]camera\f[R]: Connected camera/webcam names.
.IP \(bu 2
\f[CR]gamepad\f[R]: Connected gamepad/controller names.
.IP \(bu 2
\f[CR]memory\f[R]: System RAM usage and capacity.
.IP \(bu 2
\f[CR]swap\f[R]: System SWAP usage and capacity.
.IP \(bu 2
\f[CR]uptime\f[R]: System uptime.
.IP \(bu 2
\f[CR]procs\f[R]: Active process count.
.IP \(bu 2
\f[CR]load\f[R]: Average system load.
.IP \(bu 2
\f[CR]disk\f[R]: Mounted disk capacity, usage, and mountpoint.
.IP \(bu 2
\f[CR]temp\f[R]: System temperature sensors.
.IP \(bu 2
\f[CR]net\f[R]: Active network interfaces and local/public IP addresses.
.IP \(bu 2
\f[CR]wifi\f[R]: Active Wi\-Fi SSID, band frequency, channel, and link
rates.
.IP \(bu 2
\f[CR]bluetooth\f[R]: Bluetooth adapter details and connected device
count/names.
.IP \(bu 2
\f[CR]battery\f[R]: Battery capacity, vendor/model, time remaining, and
health.
.IP \(bu 2
\f[CR]shell\f[R]: Shell name and version (e.g.\ bash, zsh, fish, nu).
.IP \(bu 2
\f[CR]terminal\f[R]: Terminal emulator name and version.
.IP \(bu 2
\f[CR]terminal_font\f[R]: Terminal emulator active font.
.IP \(bu 2
\f[CR]desktop\f[R]: Desktop environment or window manager.
.IP \(bu 2
\f[CR]theme\f[R]: UI Theme settings.
.IP \(bu 2
\f[CR]icons\f[R]: UI icon pack.
.IP \(bu 2
\f[CR]cursor\f[R]: UI mouse cursor settings.
.IP \(bu 2
\f[CR]font\f[R]: UI system font.
.IP \(bu 2
\f[CR]users\f[R]: Current logged in users.
.IP \(bu 2
\f[CR]packages\f[R]: Installed package counts (supporting dpkg, rpm,
pacman, flatpak, snap, homebrew, scoop, chocolatey, etc.).
.RE
.SH THEMES
retch supports multiple built\-in themes as well as custom color
overrides.
.PP
The following themes are available:
.IP \(bu 2
\f[B]auto\f[R] (default): Automatically follows your system dark/light
preference.
.IP \(bu 2
\f[B]neutral\f[R]: A balanced neutral theme (cyan labels, white values).
.IP \(bu 2
\f[B]dark\f[R] and \f[B]light\f[R]: Basic dark and light themes.
.IP \(bu 2
Popular community themes: \f[B]catppuccin\-latte\f[R],
\f[B]catppuccin\-frappe\f[R], \f[B]catppuccin\-macchiato\f[R],
\f[B]catppuccin\-mocha\f[R], \f[B]solarized\-light\f[R],
\f[B]solarized\-dark\f[R].
.PP
You can also define custom colors using the \f[CR][custom_theme]\f[R]
section in your configuration file.
.PP
Colors can be specified using names
(e.g.\ \f[CR]\(dqbright_cyan\(dq\f[R]) or hex values
(e.g.\ \f[CR]\(dq#89b4fa\(dq\f[R]).
.PP
Example:
.IP
.EX
[custom_theme]
label_color = \(dqbright_cyan\(dq
value_color = \(dq#cdd6f4\(dq
accent_color = \(dqbright_green\(dq
.EE
.SH LOGOS
retch supports both ASCII and graphical logos.
.IP \(bu 2
ASCII logos are adapted from Fastfetch.
.IP \(bu 2
Graphical logos are rendered using Chafa when available, or via the
Kitty, iTerm2, or Sixel inline image protocols.
.PP
Use \f[CR]\-\-ascii\-only\f[R] to force text\-only output.
.SH EXIT STATUS
\f[B]retch\f[R] exits with status 0 on success, and non\-zero on error.
.SH SEE ALSO
\f[B]fastfetch\f[R](1), \f[B]neofetch\f[R](1)
.SH AUTHORS
Maintained by the retch developers.
See the project repository for more information:
.IP
.EX
https://github.com/l1a/retch
.EE
.SH AUTHORS
retch developers.