Skip to content

Repository files navigation

XFetch banner

License Platform Build

A cross-platform system information fetching tool written in Rust.

Demo

Previews

Main preview

More previews
Preview 2 Preview 3

Quick Install

Linux / macOS:

curl -fsSL https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install.ps1 | iex

For detailed installation steps — prerequisites, manual builds, package managers, and uninstallation — see the Installation Guide.

Features

  • Cross-platform: Works on Linux, Windows, and macOS.
  • Customizable: Configure modules, layouts, icons and colors via config.jsonc.
  • Fast: Written in Rust for performance.
  • Animated logos: Animate the ASCII logo with plugins (e.g. animate-logo).
  • Daemon mode: Pin an animated fetch at the top of the terminal and keep using the shell below.
  • Themes, plugins & extensions: Switch visual themes, extend info with plugins, and transform the config with extensions.

Configuration

xfetch looks for a configuration file at:

  • Linux: ~/.config/xfetch/config.jsonc
  • Windows: %APPDATA%\xfetch\config.jsonc
  • macOS: ~/Library/Application Support/xfetch/config.jsonc

Additional curated presets and example configs are maintained in xfetch-cli/configs.

Example Config (config.jsonc)

// Configuration for xfetch
{
  // Path to custom ASCII art file (optional)
  "ascii": null, 
  // Modules to display
  "modules": [
    "os",
    "kernel",
    "wm",
    "packages",
    "shell",
    "cpu",
    "gpu",
    "memory",
    "disk",
    "battery",
    "uptime",
    "terminal"
  ],
  // Enable colors
  "show_colors": true
}

Usage

Simply run xfetch in your terminal.

xfetch                          # render the fetch
xfetch --daemon                 # pin an animated fetch at the top (daemon mode)
xfetch --daemon-stop            # stop the daemon
xfetch --config path/to/config.jsonc
xfetch --gen-config             # generate a starter config
xfetch --clean-cache            # clear the module cache
xfetch plugin install <name>    # install a plugin
xfetch extension install <name> # install an extension
xfetch theme list               # list themes

Full documentation: see the docs below.

Contribute to the project, report issues, or connect with the developer using the links around

X

X Web & X Github Profile & Xscriptor web