A cross-platform system information fetching tool written in Rust.
More...
Linux / macOS (no sudo required):
curl -fsSL https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install.sh | bashThe installer asks automatically for anything missing (Rust, C compiler, git, curl) — sudo is only used to install those dependencies, after your confirmation. For non-interactive runs (CI):
curl -fsSL https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install.sh | bash -s -- --install-depsWindows (PowerShell):
# Prebuilt binary (no Rust needed) irm https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install-prebuilt.ps1 | iex # From source irm https://raw.githubusercontent.com/xfetch-cli/xfetch/main/install.ps1 | iex
Windows (winget):
winget install xfetch
Cargo (crates.io):
cargo install xfetch-cli
macOS (Homebrew):
brew tap xfetch-cli/tap && brew install xfetchArch Linux (AUR, via yay):
yay -S xfetch-core-bin # precompiled binary yay -S xfetch-git # build from source
For detailed installation steps — prerequisites, manual builds, package managers, and uninstallation — see the Installation Guide.
- 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). - Effects: Installable intro animations that reveal the info with style (e.g. a "decrypt" effect) — opt-in via
"effects"in the config. - Daemon mode: Pin an animated fetch at the top of the terminal and keep using the shell below.
- Live stats daemon: Turn the pinned fetch into a live panel — re-probes cpu/memory/battery/... every few seconds (
daemon_live), with hot reload of the config on the fly (daemon_live_reload). - Themes, plugins, extensions & commands: Switch visual themes, extend info with plugins, transform the config with extensions, and add CLI commands.
- WebAssembly guests: Plugins, effects and extensions can be sandboxed
.wasmartifacts written in Rust, Python, Go, C and more, with manifest-based capabilities. See docs/WASM.md.
- Scriptable CLI: JSON output,
--get, runtime overrides, templates, a stable schema, explicit exit codes, shell completions and a man page. - Command addons: install and run plain-text CLI addons with
xfetch commandandxfetch run. - Diagnostics and recovery:
doctor,paths,env,build-info, config validation, encrypted backups/restores andself-uninstall. - Addon lifecycle:
.install.jsonreceipts, update, rollback and--allinstalls for plugins, effects, extensions and commands. - Right-side logo layout:
layout: "right"keeps the info on the left and renders the logo on the right. - Windows: native self-update, winget detection and
winget install xfetch.
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.
// 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 }
Simply run xfetch in your terminal.
xfetch # render the fetch xfetch --json # machine-readable fetch xfetch --get os,cpu,memory # print specific values xfetch --modules os,kernel,cpu # override the rendered modules xfetch --layout right # runtime layout override xfetch --theme dracula # runtime theme override xfetch --format 'os={{os}}' # inline output template xfetch modules # list module keys xfetch doctor # diagnose config, terminal and addons xfetch doctor --fix # apply safe fixes xfetch doctor --bench --image # probe timings and logo preview xfetch paths # resolved config/addon/cache paths xfetch env # platform, environment and settings xfetch build-info # build profile and enabled features xfetch config validate # validate the config file xfetch config edit # edit and validate the config xfetch --backup # back up the current config xfetch --restore # restore the latest backup xfetch command install github # install a command addon xfetch run github -- owner/repo # run it xfetch theme search dark # search the remote theme registry xfetch logo preview arch # preview a catalog logo xfetch schema fetch # JSON Schema for machine output xfetch --log-json --log-level debug # structured logs on stderr xfetch completions zsh # shell completions xfetch man # man page xfetch --daemon # pin an animated fetch at the top (daemon mode) xfetch --daemon-stop # stop the daemon xfetch --no-daemon-live # disable the live stats daemon (config: "daemon_live": true) xfetch --daemon-live-stop # stop the live stats daemon xfetch --daemon-live-reload # hot reload the live stats daemon ("daemon_live_reload": true) 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 plugin install --all # install every catalog plugin xfetch plugin update --all # update every installed plugin xfetch plugin search <query> # search the plugin catalog xfetch plugin available # list the plugin catalog xfetch extension install <name> # install an extension xfetch extension search <query> # search the extension catalog xfetch theme list # list themes xfetch effects install <name> # install an intro effect (e.g. decrypt) xfetch effects search <query> # search the effect catalog xfetch update --check # check for a newer release xfetch update # update to the latest release
Full documentation: see the docs below.
Contribute to the project, report issues, or connect with the developer using the links around