# Neofetch
[](https://gitter.im/dylanaraps/fetch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
This is the home of my fetch script! This script gathers info
about your system and prints it to the terminal next to an image,
your distro's logo or any ascii art of your choice!
## Table of Contents
- [Screenshots](#screenshots)
- [Features](#features)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Arch Linux](#arch)
- [Gentoo / Funtoo](#gentoo--funtoo)
- [CRUX](#crux)
- [Debian / Ubuntu](#debian--ubuntu)
- [Mac OS X](#mac-os-x)
- [Fedora](#fedora)
- [Others](#others)
- [Post Install](#post-install)
- [Usage](#usage)
- [Frequently Asked Questions](#frequently-asked-questions)
- [Issues and Workarounds](#issues-and-workarounds)
- [Thanks](#thanks)
## Screenshots
## Features
- Supports **Linux**, **Mac OS X**, **BSD (FreeBSD, OpenBSD & NetBSD)** and **Windows** (Cygwin)
- Display a **full color image**, a file containing **ascii art** or your **distro's logo** in ascii next to the info.
- The script is **fast**. We use bash builtins wherever possible and only spawn external processes when necessary.
- Take a screenshot of your desktop on script finish.
- Customize **which** info is displayed, **where** it's displayed and **when** it's displayed.
- See this **[wiki page](https://github.com/dylanaraps/neofetch/wiki/Customizing-Info)**
## Dependencies
### Required dependencies:
- `Bash 3.0+`
- Alpine Linux: You also need `ncurses`.
- `xprop` \[1\]
- `procps-ng`
- Not required on OS X
### Optional dependencies:
- Displaying images: `w3m-img` \[2\] \[3\] or `iTerm2` \[4\]
- Thumbnail creation: `imagemagick`
##### Linux / BSD
- Wallpaper: `feh`, `nitrogen` or `gsettings`
- Current Song: `mpc` or `cmus`
- Resolution: `xorg-xdpyinfo`
- Screenshot: `scrot` \[5\]
\[1\] See **[#79](https://github.com/dylanaraps/neofetch/issues/79)** about why this is now a required dependency.
\[2\] `w3m-img` is sometimes bundled together with `w3m`.
\[3\] Image support only works in certain terminal emulators. The script will fallback to ascii mode on
terminal emulators that don't support the xterm escape sequences we're using for image sizing.
\[4\] You can enable the `iTerm2` image backend by using the launch flag `--image_backend iterm2` or by
changing the config option `$image_backend` to `iterm2`.
\[5\] You can use the launch flag `--scrot_cmd` or change the config option `$scrot_cmd` to your screenshot
program's cmd and neofetch will use it instead of scrot.
## Installation
Those using a git version of neofetch should check this page after
updating, this page lists any breaking changes that were made and
how you can workaround them.
https://github.com/dylanaraps/neofetch/wiki/Following-HEAD
- [Arch Linux](#arch)
- [Gentoo / Funtoo](#gentoo--funtoo)
- [CRUX](#crux)
- [Debian / Ubuntu](#debian--ubuntu)
- [Mac OS X](#mac-os-x)
- [Others](#others)
### Arch
1. Install **[neofetch-git](https://aur.archlinux.org/packages/neofetch-git/)** from the aur.
### Gentoo / Funtoo
1. Add the 3rd party repo
- `layman -o https://gist.githubusercontent.com/z1lt0id/24d45b15800b98975260/raw/2fdf6645cdc3c1ca0b0af83a7bf8f86598e386ae/fs0ciety.xml -f -a fs0ciety`
2. Sync the repos
- `layman -S`
3. To enable w3m and scrot support, enable the appropriate flags.
- `echo "x11-apps/neofetch" >> /etc/portage/package.use`
4. Install the package
- `emerge -a x11-apps/neofetch`
### CRUX
1. Install git and the git ports(8) driver
- `sudo prt-get depinst git`
2. Add the 3rd party repo
- `sudo wget -O /etc/ports/arcetera.git https://arcetera.moe/sync`
3. Sync the repos
- `sudo ports -u`
4. Install the package
- `sudo prt-get depinst neofetch`
### Debian / Ubuntu
1. Add the 3rd party repo
- `echo "deb http://dl.bintray.com/dawidd6/neofetch jessie main" | sudo tee -a /etc/apt/sources.list`
2. If you don't have curl, install it with this command
- `sudo apt-get install curl`
3. Add public key and update your repos
- `curl -L https://bintray.com/user/downloadSubjectPublicKey?username=bintray -o Release-neofetch.key && sudo apt-key add Release-neofetch.key && rm Release-neofetch.key && sudo apt-get update`
4. Install the package
- `sudo apt-get install neofetch`
### Mac OS X
1. Install `neofetch` with Homebrew
- `brew install neofetch`
### Fedora
1. Make sure you have installed `dnf-plugins-core`
- `sudo dnf install dnf-plugins-core`
2. Enable COPR repository
- `sudo dnf copr enable konimex/neofetch`
3. Install the package
- `sudo dnf install neofetch`
### Others
1. Download the latest source at https://github.com/dylanaraps/neofetch
2. Run `make install` inside the script directory to install the script.
- **El Capitan**: `PREFIX=/usr/local make install`
**NOTE:** Neofetch can be uninstalled easily using `make uninstall`.
**NOTE:** Neofetch can also be run from any directory like a normal script,
you'll just be missing the ascii distro logos and automatic config file creation.
## Post Install
#### Using the config file
Neofetch will by default create a config file at `$HOME/.config/neofetch/config` and this file
contains all of the script's options/settings. The config file allows you to keep your
customizations between script versions and allows you to easily share your customizations
with other people.
You can launch the script without a config file by using the flag `--config none` and you can
specify a custom config location using `--config path/to/config`.
#### Setting the prompt height
If your shell prompt's height is greater than 1 line high, you'll need to change a config
option to avoid issues with the top lines in the script output getting cut off. Set the variable
`$prompt_height` to your shell prompt's height in lines or use the launch flag `--prompt_height`.
#### Customizing what info gets displayed
In the config file there's a function that allows you to customize all of the info that
gets displayed.
Here's what you can do:
- Add new info lines
- Change the ordering of the info
- Remove unwanted info lines
- Use bash syntax to control when info gets displayed
See this wiki page that goes more in-depth about it:
https://github.com/dylanaraps/fetch/wiki/Customizing-Info
#### Customizing the script using a custom alias
If you don't want to use the config file you can customize almost everything using launch flags!
Here's what my fetch alias looks like:
```sh
alias fetch2="fetch \
--block_range 1 8 \
--line_wrap off \
--bold off \
--uptime_shorthand on \
--gtk_shorthand on \
--colors 4 1 8 8 8 7 \
"
```
## Usage
usage: fetch --option "value" --option "value"
Info:
--disable infoname Allows you to disable an info line from appearing
in the output.
NOTE: You can supply multiple args. eg.
'fetch --disable cpu gpu disk shell'
--osx_buildversion on/off Hide/Show Mac OS X build version.
--os_arch on/off Hide/Show Windows architecture.
--speed_type type Change the type of cpu speed to display.
Possible values: current, min, max, bios,
scaling_current, scaling_min, scaling_max
NOTE: This only support Linux with cpufreq.
--cpu_shorthand type Shorten the output of CPU
Possible values: name, speed, tiny, on, off
--kernel_shorthand on/off Shorten the output of kernel
--uptime_shorthand on/off Shorten the output of uptime (tiny, on, off)
--gpu_shorthand on/off Shorten the output of GPU
--gtk_shorthand on/off Shorten output of gtk theme/icons
--gtk2 on/off Enable/Disable gtk2 theme/icons output
--gtk3 on/off Enable/Disable gtk3 theme/icons output
--shell_path on/off Enable/Disable showing \$SHELL path
--shell_version on/off Enable/Disable showing \$SHELL version
--battery_num num Which battery to display, default value is 'all'
--battery_shorthand on/off Whether or not each battery gets its own line/title
--ip_host url Url to ping for public IP
--song_shorthand on/off Print the Artist/Title on seperate lines
--birthday_shorthand on/off Shorten the output of birthday
--birthday_time on/off Enable/Disable showing the time in birthday output
--birthday_format format Format the birthday output. (Uses 'date' cmd format)
Text Formatting:
--colors x x x x x x Changes the text colors in this order:
title, @, underline, subtitle, colon, info
--underline_char char Character to use when underlining title
--line_wrap on/off Enable/Disable line wrapping
--bold on/off Enable/Disable bold text
--prompt_height num Set this to your prompt height to fix issues with
the text going off screen at the top
Color Blocks:
--color_blocks on/off Enable/Disable the color blocks
--block_width num Width of color blocks
--block_range start end Range of colors to print as blocks
Image:
--image type Image source. Where and what image we display.
Possible values: wall, shuffle, ascii,
/path/to/img, off
--size 20px | --size 20% Size to make the image, takes pixels or a percentage.
--image_backend w3m/iterm2 Which program to use to draw images.
--shuffle_dir path/to/dir Which directory to shuffle for an image.
--image_position left/right Where to display the image: (Left/Right)
--crop_mode mode Which crop mode to use
Takes the values: normal, fit, fill
--crop_offset value Change the crop offset for normal mode.
Possible values: northwest, north, northeast,
west, center, east, southwest, south, southeast
--xoffset px How close the image will be to the left edge of the
window. This only works with w3m.
--yoffset px How close the image will be to the top edge of the
window. This only works with w3m.
--gap num Gap between image and text.
NOTE: --gap can take a negative value which will
move the text closer to the left side.
--clean Remove all cropped images
Ascii:
--ascii value Where to get the ascii from, Possible values:
distro, /path/to/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
Stdout:
--stdout info info Launch fetch in stdout mode which prints the info
in a plain-text format that you can use with
lemonbar etc.
--stdout_separator string String to use as a separator in stdout mode.
Screenshot:
--scrot /path/to/img Take a screenshot, if path is left empty the screen-
shot function will use \$scrot_dir and \$scrot_name.
--scrot_cmd cmd Screenshot program to launch
Other:
--config /path/to/config Specify a path to a custom config file
--config none Launch the script without a config file
--help Print this text and exit
## Frequently Asked Questions
#### How do I enable screenfetch mode?
Launching the script with `--ascii` or setting `ascii="distro"` and `image="ascii"`
inside the config file will launch the script in "screenfetch mode". The script will
display your distro's ascii next to the info, exactly like screenfetch.
**NOTE:** If you **don't** have `w3m-img` or `imagemagick` installed screenfetch mode will be
used automatically
#### Why doesn't Neofetch support my wallpaper setter?
It's hard to add support for other wallpaper setters as they don't provide a way of
getting the current wallpaper from the cli.
If your wallpaper setter **does** provide a way of getting the current wallpaper or you
know where it's stored then adding support won't be a problem!
## Issues and Workarounds
#### The text is too long for my terminal window and wraps to the next line
There are a few ways to fix this.
* Disable line wrapping with `line_wrap=off` in the script or with the launch flag `--line_wrap off`
* The uptime and gtk info lines each have a shorthand option that makes their output smaller. You can
enable them by changing these variables or using these flags.
```sh
# Config options
uptime_shorthand="on"
gtk_shorthand="on"
gpu_shorthand="on"
birthday_shorthand="on"
# Launch flags
--uptime_shorthand on
--gtk_shorthand on
--gpu_shorthand on
--birthday_shorthand on
```
* Edit the config to make the subtitles shorter
* Resizing the terminal so that the lines don't wrap.
#### The text is pushed over too far to the right
The easiest way to fix this is to change the value of `--gap` or `$gap`
to a negative value. For example `--gap -10` will move the text 10 spaces to the left.
#### getgpu doesn't show my exact video card name
If your `lspci | grep "VGA"` output looks like this:
```
01:00.0 VGA compatible controller: NVIDIA Corporation Device 1401 (rev a1)
```
Instead of this:
```
01:00.0 VGA compatible controller: NVIDIA Corporation GM206 [GeForce GTX 960] (rev a1)
```
Then you're affected by the issue.
This is caused by your `/usr/share/misc/pci.ids\*` files being outdated and you can fix it
by running this command as root.
```
sudo update-pciids
```
## Thanks
Thanks to:
- [Screenfetch](https://github.com/KittyKatt/screenFetch):
- I've used some snippets as a base for a few functions in this script.
- Most of the ascii art.
- [ufetch](https://github.com/jschx/ufetch): Tiny ascii logos
- [@metakirby5](https://github.com/metakirby5): Providing great feedback as well as ideas for the script.
- [@jrgz](https://github.com/jrgz): Helping me test the Mac OS X version.
- [@mclado](https://github.com/mclado): Helping me with Max OS X testing
- [@xDemonessx](https://github.com/xDemonessx): Helping me test the Windows version.
- [@tudurom](https://github.com/tudurom): Helping me test **everything**.
- Everyone else who has helped test the script, given feedback or reported bugs.