.\" Automatically generated by Pandoc 3.6
.\"
.TH "leenfetch" "1" "" "leenfetch 1.4.2" "Manual"
.SH leenfetch \[em] User Commands
.SS NAME
leenfetch \[em] a modern, minimal, and the fastest system info tool,
written in Rust.
.SS SYNOPSIS
.IP
.EX
leenfetch [OPTIONS]
.EE
.SS DESCRIPTION
\f[B]leenfetch\f[R] is a modern, fast, and highly configurable system
information tool written in Rust.
It displays system information alongside a distribution logo, custom
ASCII art, or a local image logo, similar to Neofetch, and is designed
for both terminal enthusiasts and new users.
Piped input takes priority over configured logos, so
\f[CR]fortune | cowsay | leenfetch\f[R] will render the pipe contents
instead of a stored logo.
It can also fetch data from remote hosts over SSH and render it locally
in pretty or JSON form.
.PP
Configuration lives in a single JSON\-with\-comments file
(\f[CR]config.jsonc\f[R]), with inline explanations for every option.
.PP
leenfetch can also accept \f[B]piped input\f[R] to render as ASCII art.
This allows users to display custom text logos via standard input.
.SS OPTIONS
.IP \[bu] 2
\f[CR]\-v\f[R], \f[CR]\-\-version\f[R]
.PD 0
.P
.PD
Print version information and exit.
.IP \[bu] 2
\f[CR]\-h\f[R], \f[CR]\-\-help\f[R]
.PD 0
.P
.PD
Show usage information and exit.
.IP \[bu] 2
\f[CR]\-l\f[R], \f[CR]\-\-list\-options\f[R]
.PD 0
.P
.PD
List all configuration keys and accepted values.
.IP \[bu] 2
\f[CR]\-i\f[R], \f[CR]\-\-init\f[R]
.PD 0
.P
.PD
Open the config chooser when no config exists, then write the selected
preset.
.IP \[bu] 2
\f[CR]\-\-choose\-config\f[R]
.PD 0
.P
.PD
Open the config chooser and overwrite the existing config after
confirmation.
.IP \[bu] 2
\f[CR]\-r\f[R], \f[CR]\-\-reinit\f[R]
.PD 0
.P
.PD
Delete the configuration file and regenerate it with bundled defaults.
.IP \[bu] 2
\f[CR]\-\-config <PATH>\f[R]
.PD 0
.P
.PD
Load configuration from a custom JSONC file.
.IP \[bu] 2
\f[CR]\-\-no\-config\f[R]
.PD 0
.P
.PD
Ignore files and run with built\-in defaults.
.IP \[bu] 2
\f[CR]\-\-ascii_distro <DISTRO>\f[R]
.PD 0
.P
.PD
Override the ASCII art distribution for this run (e.g., \f[CR]arch\f[R],
\f[CR]ubuntu\f[R], \f[CR]debian\f[R]).
.IP \[bu] 2
\f[CR]\-\-ascii_colors <COLORS>\f[R]
.PD 0
.P
.PD
Override the ASCII palette (comma\-separated indices such as
\f[CR]1,2,3,4,5,6,7\f[R] or \f[CR]distro\f[R]).
.IP \[bu] 2
\f[CR]\-\-custom_logo_path <PATH>\f[R]
.PD 0
.P
.PD
Use a custom ASCII art file or image path for this run.
Local terminals with kitty\-style image support show the image inline;
others fall back to ASCII with a warning.
.IP \[bu] 2
\f[CR]\-\-logo_scale <FLOAT>\f[R]
.PD 0
.P
.PD
Scale image logos.
\f[CR]1.0\f[R] keeps original size.
Image logos stay capped to a terminal\-friendly width, and the info
column follows the rendered logo width.
.IP \[bu] 2
\f[CR]\-\-color_blocks <GLYPH>\f[R]
.PD 0
.P
.PD
Change the glyph used for the color swatch (default: \f[CR]●\f[R]).
.IP \[bu] 2
\f[CR]\-\-battery_display <MODE>\f[R]
.PD 0
.P
.PD
Switch battery output between \f[CR]off\f[R], \f[CR]bar\f[R],
\f[CR]infobar\f[R], and \f[CR]barinfo\f[R].
.IP \[bu] 2
\f[CR]\-\-disk_display <MODE>\f[R]
.PD 0
.P
.PD
Select disk output as a comma\-separated list of \f[CR]info\f[R],
\f[CR]percentage\f[R], and \f[CR]bar\f[R].
.IP \[bu] 2
\f[CR]\-\-disk_subtitle <MODE>\f[R]
.PD 0
.P
.PD
Choose disk labels (\f[CR]name\f[R], \f[CR]dir\f[R], \f[CR]none\f[R],
\f[CR]mount\f[R]).
.IP \[bu] 2
\f[CR]\-\-disk_percent <true|false>\f[R]
.PD 0
.P
.PD
Show or hide disk usage percentage.
.IP \[bu] 2
\f[CR]\-\-disk_show <PATH>\f[R]
.PD 0
.P
.PD
Which disks to display (comma\-separated mount points or paths).
.IP \[bu] 2
\f[CR]\-\-memory_unit <UNIT>\f[R]
.PD 0
.P
.PD
Force memory units (\f[CR]kib\f[R], \f[CR]mib\f[R], \f[CR]gib\f[R]).
.IP \[bu] 2
\f[CR]\-\-package_managers <MODE>\f[R]
.PD 0
.P
.PD
Control package summaries (\f[CR]off\f[R], \f[CR]on\f[R],
\f[CR]tiny\f[R]).
.IP \[bu] 2
\f[CR]\-\-uptime_shorthand <MODE>\f[R] /
\f[CR]\-\-os_age_shorthand <MODE>\f[R]
.PD 0
.P
.PD
Pick shorthand (\f[CR]full\f[R], \f[CR]tiny\f[R], \f[CR]seconds\f[R]).
.IP \[bu] 2
\f[CR]\-\-distro_shorthand <MODE>\f[R]
.PD 0
.P
.PD
Set OS detail level (e.g., \f[CR]name\f[R], \f[CR]name_version\f[R],
\f[CR]name_model_arch\f[R]).
.IP \[bu] 2
\f[CR]\-\-cpu_temp <UNIT>\f[R]
.PD 0
.P
.PD
Select CPU temperature units (\f[CR]C\f[R], \f[CR]F\f[R], or
\f[CR]off\f[R] to hide).
.IP \[bu] 2
\f[CR]\-\-gpu_brand <true|false>\f[R]
.PD 0
.P
.PD
Show or hide GPU vendor name.
.IP \[bu] 2
\f[CR]\-\-gpu_type <TYPE>\f[R]
.PD 0
.P
.PD
Which GPU to show (\f[CR]all\f[R], \f[CR]dedicated\f[R],
\f[CR]integrated\f[R]).
.IP \[bu] 2
\f[CR]\-\-kernel_shorthand <true|false>\f[R]
.PD 0
.P
.PD
Shorten kernel output.
.IP \[bu] 2
\f[CR]\-\-speed_shorthand <true|false>\f[R]
.PD 0
.P
.PD
Show CPU speed without decimals.
.IP \[bu] 2
\f[CR]\-\-format <pretty|json>\f[R]
.PD 0
.P
.PD
Choose human\-readable pretty output (default) or machine\-readable
JSON.
.IP \[bu] 2
\f[CR]\-\-ssh <HOST>...\f[R]
.PD 0
.P
.PD
Fetch system info from one or more hosts via SSH, then render locally.
Each host runs \f[CR]leenfetch \-\-format json\f[R] remotely; the output
is printed locally using the requested format.
.IP \[bu] 2
\f[CR]\-\-print_config\f[R]
.PD 0
.P
.PD
Print the default configuration to stdout and exit.
.IP \[bu] 2
\f[CR]\-\-only <LIST>\f[R]
.PD 0
.P
.PD
Render only the listed modules (comma\-separated).
.IP \[bu] 2
\f[CR]\-\-hide <LIST>\f[R]
.PD 0
.P
.PD
Hide specific modules (comma\-separated).
.IP \[bu] 2
\f[CR]\-\-disable <LIST>\f[R]
.PD 0
.P
.PD
Alias for \f[CR]\-\-hide\f[R].
.IP \[bu] 2
Boolean toggles use a single flag with an explicit value, for example
\f[CR]\-\-cpu_speed true\f[R], \f[CR]\-\-shell_path false\f[R], or
\f[CR]\-\-memory_percent true\f[R].
.SS REMOTE FETCHING OVER SSH
\f[CR]\-\-ssh\f[R] lets you pull data from remote hosts and render it
locally.
\f[B]leenfetch\f[R] connects with your system SSH client, runs
\f[CR]leenfetch\f[R] on each target, parses the remote payload, and
prints either pretty text (default) or JSON
(\f[CR]\-\-format json\f[R]).
.IP \[bu] 2
Requirements: the remote host must have \f[CR]leenfetch\f[R] in
\f[CR]PATH\f[R].
.IP \[bu] 2
Uses your SSH config/agent, honoring usernames/ports in the target
string; a short connect timeout is applied.
.IP \[bu] 2
Per\-host ASCII art, colors, module order, and toggles come from the
remote machine\[cq]s effective config.
.IP \[bu] 2
If the remote config file is missing, the remote host falls back to the
Neofetch\-style preset.
.IP \[bu] 2
JSON mode prints one JSON object per host (separated by blank lines).
.SS CONFIGURATION
leenfetch uses a single JSONC file for configuration, typically located
at:
.IP
.EX
$XDG_CONFIG_HOME/leenfetch/
\[ti]/.config/leenfetch/
.EE
.PP
The configuration file is: \- \f[B]config.jsonc\f[R]: Includes
\f[CR]flags\f[R], an ordered \f[CR]modules\f[R] (\f[CR]layout\f[R])
array, and an optional \f[CR]custom_logo_path\f[R] override.
Use strings like \f[CR]\[dq]break\[dq]\f[R] for spacers or objects with
\f[CR]type\f[R]/\f[CR]key\f[R] to control the output.
JSONC keeps comments intact so every option is documented in place.
.PP
Edit the file to adjust appearance, enabled modules, spacing, or output
order.
.SS EXAMPLES
.IP \[bu] 2
\f[CR]leenfetch\f[R]
.PD 0
.P
.PD
Display system information using the current configuration.
.IP \[bu] 2
\f[CR]leenfetch \-\-ascii_distro debian\f[R]
.PD 0
.P
.PD
Show system info with Debian ASCII art, regardless of detected distro.
.IP \[bu] 2
\f[CR]leenfetch \-\-init\f[R]
.PD 0
.P
.PD
Open the config chooser and create the selected preset if missing.
.IP \[bu] 2
\f[CR]leenfetch \-\-choose\-config\f[R]
.PD 0
.P
.PD
Open the config chooser and overwrite the existing config after
confirmation.
.IP \[bu] 2
\f[CR]leenfetch \-\-reinit\f[R]
.PD 0
.P
.PD
Delete and regenerate the config file.
.IP \[bu] 2
\f[CR]leenfetch \-\-ssh user\[at]server\f[R]
.PD 0
.P
.PD
.IP \[bu] 2
\f[CR]leenfetch \-\-ssh user\[at]server:port\f[R]
.PD 0
.P
.PD
.IP \[bu] 2
\f[CR]leenfetch \-\-ssh user\[at]server:port \-\-ssh user\[at]server:port\f[R]
.PD 0
.P
.PD
Fetch system info from a remote host over SSH and render locally using
the remote machine\[cq]s effective config.
.IP \[bu] 2
\f[CR]echo \[dq]Rustacean\[dq] | leenfetch\f[R]
.PD 0
.P
.PD
Display system info with a piped ASCII logo generated from the input
text.
.IP \[bu] 2
\f[CR]fortune | cowsay | leenfetch\f[R]
.PD 0
.P
.PD
fortune generates a random quote.
cowsay wraps it in a cow speech bubble (ASCII art).
leenfetch takes piped input and displays it as an ASCII logo.
.SS ENVIRONMENT
.IP \[bu] 2
\f[B]XDG_CONFIG_HOME\f[R]: Specifies the base directory for
user\-specific configuration files.
Defaults to \f[CR]\[ti]/.config\f[R] if not set.
.SS FILE
.IP \[bu] 2
\f[CR]\[ti]/.config/leenfetch/config.jsonc\f[R]
.SS WIKI
Please refer to the project wiki at:
.PD 0
.P
.PD
https://github.com/drunkleen/leenfetch/wiki
.SS BUGS
Please report bugs or feature requests at:
.PD 0
.P
.PD
https://github.com/drunkleen/leenfetch/issues
.SS AUTHOR
Written by DrunkLeen \c
.MT snape@drunkleen.com
.ME \c