go application showing your system's info
Find a file
2024-12-19 18:38:29 -06:00
artwork artwork: add apple 2024-12-19 13:32:33 -05:00
modules cpu/memory/os: better error handling 2024-12-19 18:49:22 -05:00
.editorconfig initial commit 2024-11-19 10:43:08 -06:00
.gitignore fix memory module (no root needed) 2024-11-26 10:57:01 -06:00
artwork.go Refactor modules into platform-specific files 2024-12-19 18:45:13 -05:00
config.go change colors 'num' option to 'rows' 2024-12-12 13:47:35 -06:00
CONTRIBUTING.md os: replace sysinfo dep with modules/os 2024-12-19 13:32:17 -05:00
default.config.yml change colors 'num' option to 'rows' 2024-12-12 13:47:35 -06:00
example.config.yml change colors 'num' option to 'rows' 2024-12-12 13:47:35 -06:00
flake.lock update flake 2024-12-12 13:49:09 -06:00
flake.nix bump vendorHash in flake.nix 2024-12-19 18:38:29 -06:00
go.mod os: replace sysinfo dep with modules/os 2024-12-19 13:32:17 -05:00
go.sum os: replace sysinfo dep with modules/os 2024-12-19 13:32:17 -05:00
LICENSE initial commit 2024-11-19 10:43:08 -06:00
main.go refactor how modules are organized (separate files) 2024-11-27 19:38:49 -06:00
modules.go change colors 'num' option to 'rows' 2024-12-12 13:47:35 -06:00
preview.png update screenshot 2024-11-24 09:54:49 -06:00
README.md change colors 'num' option to 'rows' 2024-12-12 13:47:35 -06:00
util.go refactor how modules are organized (separate files) 2024-11-27 19:38:49 -06:00

μfetch

pretty system info printer with a focus on configurability

preview

using

you need:

  • a terminal
  • nerd font for icons
  • golang to build from source, or a pre-compiled binary (which contains everything it needs) to run

configuring

mewfetch is designed to be highly customizable using a configuration file. it has nice defaults, and they can be overridden with a YAML config file using the flag -c/--config <filename>, otherwise it will check $XDG_CONFIG_HOME/mewfetch.yml.

see the example, defaults, or the following for how to configure it:

artwork:

  • hide: bool - whether to hide the artwork
  • os: string - manually choose which artwork is used (or auto, the default)
  • custom: string - or set your own (yaml multi-line strings are a bit iffy)
  • color: int - 0-15 index from the terminal's color palette

gaps:

  • art: int - vertical gap (number of spaces) between artwork and modules
  • icon: int - width of the module icon column

modules:

array of any of the following module definitions with their own optional settings:

  • type: "blank" - newline
  • type: "colors" - color palette
    block: string - characters used to represent a swatch (single color) rows: int - number of rows, each with 8 colors (1 or 2)
  • type: "cpu" - CPU model
  • type: "custom" - print output of shell command (be careful with it!)
    command: string - shell command
    icon: rune - custom icon
  • type: "hostname" - computer's hostname
  • type: "memory" - total memory
  • type: "os" - shows OS version, uses major OS type (windows, linux, etc.) for icon
  • type: "uptime" - how long your computer has been running
  • type: "user" - current username

mewfetch is early in development. some options are subject to change.

contributing

take a look at CONTRIBUTING.md if you would like to aid in development!