fastfetch README

The project's README from github.com/fastfetch-cli/fastfetch. As one markdown file: README.md.

Fastfetch

Benchmark GitHub Workflow Status (with event) GitHub license GitHub contributors GitHub top language GitHub commit activity (branch)
homebrew downloads GitHub all releases
GitHub release (with filter) latest packaged version(s) Packaging status Ask DeepWiki 中文README

Fastfetch is a neofetch-like tool for fetching system information and displaying it in a visually appealing way. It is written mainly in C, with a focus on performance and customizability. Currently, it supports Linux, macOS, Windows 8.1+, Android, FreeBSD, OpenBSD, NetBSD, DragonFly, Haiku and SunOS (illumos, Solaris).

Note: Fastfetch is only actively tested on x86-64 and aarch64 platforms. It may work on other platforms but is not guaranteed to do so.

According configuration files for examples are located here.

There are screenshots on different platforms.

Installation

Linux

Some distributions package outdated versions of fastfetch. Older versions receive no support, so please always try to use the latest version.

Packaging status

You may need sudo, doas, or sup to run these commands.

If fastfetch is not packaged for your distribution or an outdated version is packaged, linuxbrew is a good alternative: brew install fastfetch

macOS

Windows

You may also download the program directly from the GitHub releases page in the form of an archive file.

BSD systems

Android (Termux)

Nightly

https://nightly.link/fastfetch-cli/fastfetch/workflows/ci/dev?preview

Build from source

See the Wiki: https://github.com/fastfetch-cli/fastfetch/wiki/Building

Usage

Customization

Fastfetch uses JSONC (JSON with comments) for configuration. See the Wiki for details. There are some premade config files in the presets directory, including those used for the screenshots above. You can load them using -c <filename>. These files can serve as examples of the configuration syntax.

Logos can also be heavily customized; see the logo documentation for more information.

WARNING

Fastfetch supports a Command module that can run arbitrary shell commands. If you copy-paste a config file from an untrusted source, it may contain malicious commands that can harm your system or compromise your privacy. Please always review the config file before using it.

FAQ

Q: Neofetch is good enough. Why do I need fastfetch?

  1. Fastfetch is actively maintained.
  2. Fastfetch is faster, as the name suggests.
  3. Fastfetch has a greater number of features, though by default it only has a few modules enabled; use fastfetch -c all to discover what you want.
  4. Fastfetch is more configurable. You can find more information in the Wiki: https://github.com/fastfetch-cli/fastfetch/wiki/Configuration.
  5. Fastfetch is more polished. For example, neofetch prints 555 MiB in the Memory module and 23 G in the Disk module, whereas fastfetch prints 555.00 MiB and 22.97 GiB respectively.
  6. Fastfetch is more accurate. For example, neofetch never actually supports the Wayland protocol.

Q: Fastfetch shows my local IP address. Does it leak my privacy?

A local IP address (10.x.x.x, 172.x.x.x, 192.168.x.x) has nothing to do with privacy. It only has meaning if you are on the same network, for example, if you connect to the same Wi-Fi network.

Actually, the Local IP module is the most useful module for me personally. I (@CarterLi) have several VMs installed to test fastfetch and often need to SSH into them. With fastfetch running on shell startup, I never need to type ip addr manually.

If you really don't like it, you can disable the Local IP module in config.jsonc.

Q: Where is the config file? I can't find it.

Fastfetch does not generate a config file automatically. You can use fastfetch --gen-config to generate one. The config file will be saved in ~/.config/fastfetch/config.jsonc by default. See the Wiki for details.

Q: The configuration is so complex. Where is the documentation?

Fastfetch uses JSON (with comments) for configuration. I suggest using an IDE with JSON schema support (like VSCode) to edit it.

Alternatively, you can refer to the presets in the presets directory.

The correct way to edit the configuration:

This is an example that changes size prefix from MiB / GiB to MB / GB. Editor used: helix

asciicast

Q: I WANT THE DOCUMENTATION!

Here is the documentation. It is generated from the JSON schema, but you might not find it very user-friendly.

Q: How can I customize the module output?

Fastfetch uses format to generate output. For example, to make the GPU module show only the GPU name (leaving other information undisplayed), you can use:

{
    "modules": [
        {
            "type": "gpu",
            "format": "{name}" // See `fastfetch -h gpu-format` for details
        }
    ]
}

...which is equivalent to fastfetch -s gpu --gpu-format '{name}'

See fastfetch -h format for information on basic usage. For module-specific formatting, see fastfetch -h <module>-format

Q: I have my own ASCII art / image file. How can I show it with fastfetch?

Try fastfetch -l /path/to/logo. See the logo documentation for details.

If you just want to display the distro name in FIGlet text:

# install pyfiglet and jq first
pyfiglet -s -f small_slant $(fastfetch -s os --format json | jq -r '.[0].result.name') && fastfetch -l none

image

Q: My image logo behaves strangely. How can I fix it?

See the troubleshooting section: https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options#troubleshooting

Q: Fastfetch runs in black and white on shell startup. Why?

This issue usually occurs when using fastfetch with p10k. There are known incompatibilities between fastfetch and p10k instant prompt. The p10k documentation clearly states that you should NOT print anything to stdout after p10k-instant-prompt is initialized. You should put fastfetch before the initialization of p10k-instant-prompt (recommended).

You can always use fastfetch --pipe false to force fastfetch to run in colorful mode.

Q: Why do fastfetch and neofetch show different memory usage results?

See #1096.

Q: Fastfetch shows fewer dpkg packages than neofetch. Is it a bug?

  1. Neofetch incorrectly counts rc packages for apt (packages that have been removed but still have configuration files remaining). See bug: https://github.com/dylanaraps/neofetch/issues/2278
  2. Neofetch incorrectly counts gpg-pubkey as packages for rpm. You may check the results of dnf list --installed | wc -l and rpm -qa | wc -l to see the difference.

Q: I use Debian / Ubuntu / Debian-derived distro. My GPU is detected as XXXX Device XXXX (VGA compatible). Is this a bug?

Try upgrading pci.ids: Download https://pci-ids.ucw.cz/v2.2/pci.ids and overwrite the file /usr/share/hwdata/pci.ids. For AMD GPUs, you should also upgrade amdgpu.ids: Download https://gitlab.freedesktop.org/mesa/drm/-/raw/main/data/amdgpu.ids and overwrite the file /usr/share/libdrm/amdgpu.ids

Alternatively, you may try using fastfetch --gpu-driver-specific, which will make fastfetch attempt to ask the driver for the GPU name if supported.

Q: I get the error Authorization required, but no authorization protocol specified when running fastfetch as root

Try export XAUTHORITY=$HOME/.Xauthority

Q: Fastfetch cannot detect my awesome 3rd-party macOS window manager!

Try fastfetch --wm-detect-plugin. See also #984

Try fastfetch --logo-color-[1-9] <color>, where [1-9] is the index of color placeholders.

For example: fastfetch --logo-color-1 red --logo-color-2 green.

In JSONC, you can use:

{
    "logo": {
        "color": {
            "1": "red",
            "2": "green"
        }
    }
}

Q: How do I hide a key?

Set the key to a white space.

{
    "key": " "
}

Q: How can I display images on Windows?

As of April 2025:

mintty and Wezterm

mintty (used by Bash on Windows and MSYS2) and Wezterm (nightly build only) support the iTerm image protocol on Windows.

In config.jsonc:

{
  "logo": {
    "type": "iterm",
    "source": "C:/path/to/image.png",
    "width": <num-in-chars>
  }
}

Windows Terminal

Windows Terminal supports the sixel image protocol only.

{
  "logo": {
    "type": "sixel", // DO NOT USE "auto"
    "source": "C:/path/to/image.png", // Do NOT use `~` as fastfetch is a native Windows program and doesn't apply cygwin path conversion
    "width": <image-width-in-chars>, // Optional
    "height": <image-height-in-chars> // Optional
  }
}
{
  "logo": {
    "type": "raw", // DO NOT USE "auto"
    "source": "C:/path/to/image.sixel",
    "width": <image-width-in-chars>, // Required
    "height": <image-height-in-chars> // Required
  }
}

Q: I want feature A / B / C. Will fastfetch support it?

Fastfetch is a system information tool. We only accept hardware or system-level software feature requests. For most personal uses, I recommend using the Command module to implement custom functionality, which can be used to grab output from a custom shell script:

// This module shows the default editor
{
    "modules": [
        {
            "type": "command",
            "text": "$EDITOR --version | head -1",
            "key": "Editor"
        }
    ]
}

Otherwise, please open a feature request in GitHub Issues.

Q: I have questions. Where can I get help?

Donate

If you find Fastfetch useful, please consider donating.

Code signing

Star History

Give us a star to show your support!

Star History Chart

fastfetch (fastfetch-cli/fastfetch)

Searching Database…

25.1K ·GitHub
这是干什么的?一个类似 neofetch 的命令行工具,可以在终端里把你的系统信息(操作系统、硬件等)显示在 logo 旁边。它主要用 C 语言编写,注重性能和可定制性。
我系统上已经有 neofetch 了,为什么还要换成 fastfetch?按照它自己的 FAQ 说法:fastfetch 在积极维护,比 neofetch 更快(名字就是这么来的)、功能更丰富、可配置性也更强。默认只启用少数几个模块——运行 'fastfetch -c all' 可以看到它能显示的全部内容。
我在网上找了一个配置文件,直接加载安全吗?不一定安全。Command 模块可以运行任意 shell 命令,所以从不可信来源复制来的配置可能包含恶意代码——加载之前一定要先检查一遍。
它能运行在哪些系统上?我的 CPU 架构有影响吗?Linux、macOS、Windows 8.1+、Android、FreeBSD/OpenBSD/NetBSD/DragonFly、Haiku 以及 SunOS(illumos、Solaris)。注意只有 x86-64 和 aarch64 在积极测试——其他 CPU 架构也许能用,但不保证。
fastfetch 会把我的系统信息发送到别的地方吗?不会。README 里说明,除非用户主动要求,它不会向联网系统传输任何东西;Windows 版二进制文件还通过 SignPath.io 做了代码签名。
我可以自定义它显示什么、显示成什么样吗?可以。配置文件是 JSONC(带注释的 JSON):运行 'fastfetch --gen-config' 生成一个最简配置,用在线配置生成器做一个完整配置,或者用 '-c' 加载现成的预设——presets 目录里甚至有 README 截图所用的配置。Logo 的自定义空间也非常大。
我可以用自己的 ASCII 画或图片当 logo 吗?可以——'fastfetch -l /path/to/logo' 会显示你自己的文件。图片支持取决于你的终端:在 Windows 上,mintty 和 WezTerm 支持 iTerm 协议,而 Windows Terminal 只支持 sixel(请使用带 ImageMagick 的 MSYS2 版本,或者手动把图片转成 sixel)。
我请求什么功能,维护者都会加吗?不一定——README 说只接受硬件或系统级软件方面的功能请求,因为 fastfetch 是一个系统信息工具。如果是个性化需求,它建议你自己写个 shell 脚本获取输出,再通过 Command 模块显示出来。
Size
21.2 MB
Stars
25.1K
Age
5y
Commits · 90 Days