Skip to content

A system information tool written in POSIX sh, forked from pfetch

License

Notifications You must be signed in to change notification settings

bradthornborrow/bfetch

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

bfetch

A pretty system information tool written in POSIX sh


The goal of this project is to implement a simple system information tool in POSIX sh using features built into the language itself (where possible).

The source code is highly documented and I hope it will act as a learning resource for POSIX sh and simple information detection across various different operating systems.

If anything in the source code is unclear or is lacking in its explanation, open an issue. Sometimes you get too close to something and you fail to see the "bigger picture"!





OS support

  • Linux
    • Alpine Linux, Arch Linux, Arco Linux, Artix Linux, CentOS, Dahlia, Debian, Devuan, Elementary, EndeavourOS, Fedora, Garuda Linux, Gentoo, Guix, Hyperbola, instantOS, KISS Linux, Linux Lite, Linux Mint, Mageia, Manjaro, MX Linux, NixOS, OpenSUSE, Parabola, Pop!_OS, PureOS, Slackware, Solus, Ubuntu and Void Linux.
    • All other distributions are supported with a generic penguin logo.
  • Android
  • BSD
    • DragonflyBSD, FreeBSD, NetBSD and OpenBSD.
  • Windows
    • Windows subsystem for Linux.
  • Haiku
  • MacOS
  • Minix
  • Solaris
  • IRIX
  • SerenityOS

Configuration

bfetch is configured through environment variables.

# Which information to display.
# NOTE: If 'ascii' will be used, it must come first.
# Default: first example below
# Valid: space separated string
#
# OFF by default: shell editor wm de palette
BF_INFO="ascii title os host kernel uptime pkgs memory"

# Example: Only ASCII.
BF_INFO="ascii"

# Example: Only Information.
BF_INFO="title os host kernel uptime pkgs memory"

# A file to source before running bfetch.
# Default: unset
# Valid: A shell script
BF_SOURCE=""

# Separator between info name and info data.
# Default: unset
# Valid: string
BF_SEP=":"

# Enable/Disable colors in output:
# Default: 1
# Valid: 1 (enabled), 0 (disabled)
BF_COLOR=1

# Color of info names:
# Default: unset (auto)
# Valid: 0-9
BF_COL1=4

# Color of info data:
# Default: unset (auto)
# Valid: 0-9
BF_COL2=9

# Color of title data:
# Default: unset (auto)
# Valid: 0-9
BF_COL3=1

# Alignment padding.
# Default: unset (auto)
# Valid: int
BF_ALIGN=""

# Which ascii art to use.
# Default: unset (auto)
# Valid: string
BF_ASCII="openbsd"

# The below environment variables control more
# than just 'bfetch' and can be passed using
# 'HOSTNAME=cool_pc bfetch' to restrict their
# usage solely to 'bfetch'.

# Which user to display.
USER=""

# Which hostname to display.
HOSTNAME=""

# Which editor to display.
EDITOR=""

# Which shell to display.
SHELL=""

# Which desktop environment to display.
XDG_CURRENT_DESKTOP=""

About

A system information tool written in POSIX sh, forked from pfetch

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 99.7%
  • Makefile 0.3%