Skip to content

lemuray/rustfetch

Repository files navigation

Rustfetch

Top Language

Rustfetch is a CLI tool designed to fetch system information in the fastest and safest way possible while still keeping it visually appealing, inspired by neofetch and fastfetch.

          

Tests ran on identical hardware with default configs, using the runtime script (30 runs, 5 warmups).

Installation

You can copy and paste this command to use the install script:

curl -fsSL https://raw.githubusercontent.com/lemuray/rustfetch/main/install.sh | bash

If you're on NixOS, you can install it from nixpkgs (Special thanks to LeFaucheur0769!):

nix shell nixpkgs#rustfetch

Alternatively, you can build the latest release from source:

cargo install --git https://github.com/lemuray/rustfetch.git --tag v0.3.0

In case installation fails or you want to know more about the installation process, visit our guide to installation.

Tested on: macOS (Apple Silicon), Fedora 43, Arch Linux (x86_64). rustc 1.93.0

Usage

You can run the CLI with the default config by typing rustfetch

Here are some useful flags you can use:

  • --help / -h shows all commands and descriptions
  • --all / -a enables all config options, useful to try features out
  • --padding / -p x adds padding between the ascii logo and the system information, replace x with your value (0-255)
  • --config-file / -c PATH_TO_FILE uses a different config file, if the file does not exist it'll be created with defaults

This is a selected list of the most used flags, to learn about all the flags visit our flags guide.

Customization

Rustfetch relies on TOML files to parse the configuration, which makes them inherently user-friendly.

Modify it by accessing the default directory:

  • Linux: ~/.config/rustfetch/config.toml
  • MacOS: ~/Library/Application Support/rustfetch/config.toml

Any other questions?

In case you want to know the answer to a question that didn't get answered here or you want to start contributing to the project visit our extensive and user-friendly documentation.

Enjoy your stay!

About

A CLI tool that displays system info, written entirely in Rust!

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors