NEOFETCH(1)

📦 version 7.1.0, in debian bookworm, epel 9, ubuntu jammy, ubuntu noble

💖 NAME 💖

Neofetch — a fast, highly customizable system info script 💅 (yep, that's neofetch(1), User Commands, and bestie we are on part 1 of 2, so buckle up 🦋)

✨ SYNOPSIS ✨

neofetch func_name --option "value" --option "value"

🌸 DESCRIPTION 🌸

Okay so Neofetch is a CLI system information tool written in BASH. It shows off info about your system right next to an image, your OS logo, or literally any ASCII file of your choosing. It's giving aesthetic terminal and honestly? Obsessed. 😭💖

NOTE: Every launch flag has a config option. Every single one. No cap. 👑

⭐ OPTIONS ⭐

🍓 INFO: 🍓

  • func_name — drop in a function name (the second part of info() from your config) and it'll quickly display only that function's info. Slay, focused queen. ✨

Example:

neofetch uptime --uptime_shorthand tiny

Example:

neofetch uptime disk wm memory

You can use this in bars and scripts like so:

memory="$(neofetch memory)"; memory="${memory##*: }"

For multiple outputs at once (each line of info in an array):

IFS=$'\n' read -d "" -ra info < <(neofetch memory uptime wm)
info=("${info[@]##*: }")
  • --disable infoname — lets you yeet an info line out of the output entirely. infoname is the function name from the print_info() function inside the config file. So like, info "Memory" memory would become --disable memory 🫶
NOTE: You can supply multiple args. eg. neofetch --disable cpu gpu — go off, disable whatever you want. 💅
  • --title_fqdn on/off — Hide/Show the Fully Qualified Domain Name in the title. 🌐
  • --package_managers on/off — Hide/Show Package Manager names. (on, tiny, off) 📦
  • --os_arch on/off — Hide/Show OS architecture. 🧠
  • --speed_type type — changes the type of cpu speed that gets displayed. Possible values: current, min, max, bios, scaling_current, scaling_min, scaling_max 🔥
NOTE: This only supports Linux with cpufreq.
  • --speed_shorthand on/off — whether or not to show decimals in CPU speed. 🧮
NOTE: This flag is not supported in systems with CPU speed less than 1 GHz.
  • --cpu_brand on/off — Enable/Disable the CPU brand in the output. 👑
  • --cpu_cores type — whether or not to display the number of CPU cores. Possible values: logical, physical, off
NOTE: 'physical' doesn't work on BSD. 😭
  • --cpu_speed on/off — Hide/Show cpu speed. ⚡
  • --cpu_temp C/F/off — Hide/Show cpu temperature. 🌡️
NOTE: This only works on Linux and BSD.
NOTE: For FreeBSD and NetBSD-based systems, you need to enable the coretemp kernel module. This only supports newer Intel processors. (iykyk)
  • --distro_shorthand on/off — Shorten the output of distro. (on, tiny, off) ✂️
NOTE: This option won't work in Windows (Cygwin).
  • --kernel_shorthand on/off — Shorten the output of kernel. ✂️
NOTE: This option won't work in BSDs (except PacBSD and PC-BSD).
  • --uptime_shorthand on/off — Shorten the output of uptime. (on, tiny, off) ⏰
  • --refresh_rate on/off — whether to display the refresh rate of each monitor. Unsupported on Windows. 🖥️
  • --gpu_brand on/off — Enable/Disable GPU brand in the output. (AMD/NVIDIA/Intel) 🎮
  • --gpu_type type — which GPU to display. (all, dedicated, integrated)
NOTE: This only supports Linux.
  • --de_version on/off — Show/Hide Desktop Environment version. 🪟
  • --gtk_shorthand on/off — Shorten the output of gtk theme/icons. ✂️
  • --gtk2 on/off — Enable/Disable gtk2 theme/font/icons output. 🎀
  • --gtk3 on/off — Enable/Disable gtk3 theme/font/icons output. 🎀
  • --shell_path on/off — Enable/Disable showing $SHELL path. 🐚
  • --shell_version on/off — Enable/Disable showing $SHELL version. 🐚
  • --disk_show value — which disks to display. Possible values: '/', '/dev/sdXX', '/path/to/mount point' 💾
NOTE: Multiple values can be given. (--disk_show '/' '/dev/sdc1')
  • --disk_subtitle type — what information to append to the Disk subtitle. Takes: name, mount, dir, none 🏷️
    • 'name' shows the disk's name (sda1, sda2, etc)
    • 'mount' shows the disk's mount point (/, /mnt/Local Disk, etc)
    • 'dir' shows the basename of the disk's path. (/, Local Disk, etc)
    • 'none' shows only 'Disk' or the configured title.
  • --disk_percent on/off — Hide/Show disk percent. 📊
  • --ip_host url — URL to query for public IP. 🌍
  • --ip_timeout int — Public IP timeout (in seconds). ⏳
  • --song_format format — print the song data in a specific format (see config file). 🎵
  • --song_shorthand on/off — print the Artist/Album/Title on separate lines. 🎤
  • --memory_percent on/off — display memory percentage. 🧠
  • --music_player player-name — manually specify a player to use. Available values are listed in the config file. 🎧

💅 TEXT FORMATTING: 💅

  • --colors x x x x x x — changes the text colors in this order: title, @, underline, subtitle, colon, info 🌈
  • --underline on/off — Enable/Disable the underline. ✏️
  • --underline_char char — character to use when underlining the title. 🔡
  • --bold on/off — Enable/Disable bold text. bold bestie. 😤
  • --separator string — changes the default ':' separator to the string you specify. ✂️

🎨 COLOR BLOCKS: 🎨

  • --color_blocks on/off — Enable/Disable the color blocks. 🟥🟧🟨🟩🟦🟪
  • --col_offset auto/num — left-padding of color blocks. ⬅️
  • --block_width num — width of color blocks in spaces. 📏
  • --block_height num — height of color blocks in lines. 📐
  • --block_range num num — range of colors to print as blocks. 🌈

📊 BARS: 📊

  • --bar_char 'elapsed char' 'total char' — characters to use when drawing bars. 🖌️
  • --bar_border on/off — whether or not to surround the bar with '[]'. 🖼️
  • --bar_length num — length in spaces to make the bars. 📏
  • --bar_colors num num — colors to make the bar. Set in this order: elapsed, total. 🎨
  • --cpu_display mode — Bar mode. Possible values: bar, infobar, barinfo, off 🔥
  • --memory_display mode — Bar mode. Possible values: bar, infobar, barinfo, off 🔥
  • --battery_display mode — Bar mode. Possible values: bar, infobar, barinfo, off 🔋
  • --disk_display mode — Bar mode. Possible values: bar, infobar, barinfo, off 🔥

🖼️ IMAGE BACKEND: 🖼️

  • --backend backend — which image backend to use. Possible values: 'ascii', 'caca', 'chafa', 'jp2a', 'iterm2', 'off', 'sixel', 'tycat', 'w3m', 'kitty' 🧚
  • --source source — which image or ascii file to use. Possible values: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/', 'command output' [ascii] 🌈
  • --ascii source — shortcut to use the 'ascii' backend. 🎀

NEW: neofetch --ascii "$(fortune | cowsay -W 30)" 🐄

  • --caca source — shortcut to use the 'caca' backend.
  • --chafa source — shortcut to use the 'chafa' backend.
  • --iterm2 source — shortcut to use the 'iterm2' backend.
  • --jp2a source — shortcut to use the 'jp2a' backend.
  • --kitty source — shortcut to use the 'kitty' backend.
  • --pixterm source — shortcut to use the 'pixterm' backend.
  • --sixel source — shortcut to use the 'sixel' backend.
  • --termpix source — shortcut to use the 'termpix' backend.
  • --tycat source — shortcut to use the 'tycat' backend.
  • --w3m source — shortcut to use the 'w3m' backend.
  • --off — shortcut to use the 'off' backend (Disable ascii art). 🚫
NOTE: 'source' can be any of the following: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'

🌈 ASCII: 🌈

  • --ascii_colors x x x x x x — colors to print the ascii art. 🎨
  • --ascii_distro distro — which Distro's ascii art to print. 👑
NOTE: AIX, Alpine, AlterLinux, Anarchy, Android, Antergos, antiX, "AOSC OS", "AOSC OS/Retro", Apricity, ArcoLinux, ArchBox, ARCHlabs, ArchStrike, XFerience, ArchMerge, Arch, Artix, Arya, Bedrock, Bitrig, BlackArch, BLAG, BlankOn, BlueLight, bonsai, BSD, BunsenLabs, Calculate, Carbs, CentOS, Chakra, ChaletOS, Chapeau, Chrom, Cleanjaro, ClearOS, Clear_Linux, Clover, Condres, Container_Linux, CRUX, Cucumber, Debian, Deepin, DesaOS, Devuan, DracOS, DragonFly, Drauger, Elementary, EndeavourOS, Endless, EuroLinux, Exherbo, Fedora, Feren, FreeBSD, FreeMiNT, Frugalware, Funtoo, GalliumOS, Gentoo, Pentoo, gNewSense, GNOME, GNU, GoboLinux, Grombyang, Guix, Haiku, Huayra, Hyperbola, janus, Kali, KaOS, KDE_neon, Kibojoe, Kogaion, Korora, KSLinux, Kubuntu, LEDE, LFS, Linux_Lite, LMDE, Lubuntu, Lunar, macos, Mageia, MagpieOS, Mandriva, Manjaro, Maui, Mer, Minix, LinuxMint, MX_Linux, Namib, Neptune, NetBSD, Netrunner, Nitrux, NixOS, Nurunner, NuTyX, OBRevenge, OpenBSD, OpenIndiana, openmamba, OpenMandriva, OpenStage, OpenWrt, osmc, Oracle, OS Elbrus, PacBSD, Parabola, Pardus, Parrot, Parsix, TrueOS, PCLinuxOS, Peppermint, popos, Porteus, PostMarketOS, Proxmox, Puppy, PureOS, Qubes, Radix, Raspbian, Reborn_OS, Redstar, Redcore, Redhat, Refracted_Devuan, Regata, Rosa, sabotage, Sabayon, Sailfish, SalentOS, Scientific, Septor, SereneLinux, SharkLinux, Siduction, Slackware, SliTaz, SmartOS, Solus, Source_Mage, Sparky, Star, SteamOS, SunOS, openSUSE_Leap, openSUSE_Tumbleweed, openSUSE, SwagArch, Tails, Trisquel, Ubuntu-Budgie, Ubuntu-GNOME, Ubuntu-MATE, Ubuntu-Studio, Ubuntu, Venom, Void, Obarun, windows10, Windows7, Xubuntu, Zorin, and IRIX have ascii logos. 😭 that's a lot of besties
NOTE: Arch, Ubuntu, Redhat, and Dragonfly have 'old' logo variants.
NOTE: Use '{distro name}_old' to use the old logos.
NOTE: Ubuntu has flavor variants.
NOTE: Change this to Lubuntu, Kubuntu, Xubuntu, Ubuntu-GNOME, Ubuntu-Studio, Ubuntu-Mate or Ubuntu-Budgie to use the flavors. 🧁
NOTE: Arcolinux, Dragonfly, Fedora, Alpine, Arch, Ubuntu, CRUX, Debian, Gentoo, FreeBSD, Mac, NixOS, OpenBSD, android, Antrix, CentOS, Cleanjaro, ElementaryOS, GUIX, Hyperbola, Manjaro, MXLinux, NetBSD, Parabola, POP_OS, PureOS, Slackware, SunOS, LinuxLite, OpenSUSE, Raspbian, postmarketOS, and Void have a smaller logo variant. 🐣
NOTE: Use '{distro name}_small' to use the small variants.
  • --ascii_bold on/off — whether or not to bold the ascii logo. iconic. 😤✨
  • -L, --logo — Hide the info text and only show the ascii logo. Just the art, no talking. 🤫🎨

🖼️ IMAGE: 🖼️

  • --loop — Redraw the image constantly until Ctrl+C is used. This fixes issues in some terminal emulators when using image mode. 🔁 (yes it goes forever, that's the point, hit Ctrl+C when you're done bestie)
  • --size 00px | --size 00% — how to size the image. Possible values: auto, 00px, 00%, none 📏
  • --crop_mode mode — bestie, this picks HOW we crop. It takes the values: normal, fit, fill. That's it, that's the whole vibe check. 💅
  • --crop_offset value — changes the crop offset but only for normal mode. Possible values are: northwest, north, northeast, west, center, east, southwest, south, southeast. Lowkey a whole compass, we love a direction moment. 🧭✨
  • --xoffset px — how close the image sits to the left edge of the window. Heads up tho: this only works with w3m. Not other backends. Just w3m. Periodt. 🙈
  • --yoffset px — how close the image sits to the top edge of the window. And yeah, same deal: this only works with w3m. 💀
  • --bg_color color — the background color shown behind a transparent image. Guess what, only works with w3m. (Are we sensing a theme? We are. 😭)
  • --gap num — the gap between the image and the text.
NOTE: --gap can take a negative value, which will move the text closer to the left side. Negative numbers doing the most, honestly. 😌
  • --clean — deletes cached files and thumbnails. Fresh start energy, we love to see it. 🧼✨

🫶 OTHER 🫶

  • --config /path/to/config — specify a path to a custom config file. Your config, your rules, main character behavior. 👑
  • --config none — launches the script with NO config file at all. Raw. Unfiltered. Feral, even. 🦋
  • --no_config — don't create the user config file. It simply does not get made. Respect. 💅
  • --print_config — prints the default config file to stdout. Great for peeking, bestie. 🔥
  • --stdout — turns off all colors AND disables any ASCII/image backend. Just pure text, no drama. 🌸
  • --help — print this text and exit. The classic. The icon. ✨
  • --version — show neofetch version. Quick little flex. 👑
  • -v — display error messages.
  • -vv — display a verbose log for error reporting. Double v for double the info when something's being dramatic. 😭

💜 DEVELOPER 💜

  • --gen-man — generates a manpage for Neofetch in your PWD. (Requires GNU help2man.) Look at you, being all meta and building docs. Nerd behavior and we support it. 🧚

🌈 REPORTING BUGS 🌈

Found a bug? Spill the tea, bestie — report bugs to https://github.com/dylanaraps/neofetch/issues. They wanna hear it fr fr. 🫶

And that's the whole page, babe! This was written against Neofetch 7.1.0, dated Aug 2020 (the manpage header literally says NEOFETCH(1) — iconic). Go forth and make your terminal cute. 💖🎀🦋✨

📦 where this page comes from