Skip to content
 
 

Repository files navigation

zenfetch

A minimal system information display tool featuring an animated bonsai tree.

zenfetch combines the beauty of cbonsai with system information display, similar to neofetch but with a zen twist.

Features

  • Animated bonsai tree growth on each run
  • System information: OS, uptime, CPU, memory, storage, network, IP, local time
  • Configurable owner, location, support contact, and documentation URL
  • Noir mode for monochrome terminals
  • Clickable hyperlinks for URLs and emails (OSC 8 compatible terminals)
  • Configuration via CLI flags or /etc/zenfetch/ config files

Screenshot

                          -=:. ... -=:.: ...
                            -=:.——=:. ...
                          ——=:.. :. ——=:....
                    -=:.  -=:.-=:.-=:-=:.. :.:..
                  -=:... -=:.. :.-=:.-=-:.:.:..:.
                    -=:-=:.. =:.#——-=-=:.-=:.
                        ## #-=:. %: -=:-=:.
                        #  -=:.. :.%:..
                      -=:.-#-=:.:..  -=%.
                    -=:..%=:.*%#     %#%
                      -=:.%-=:. % %#  #%
                    -=:....%#%%#  %#%
                      -=:.-=:.  %#%  %#**
                    -=:.-=:...*%#%##%**  -=:.-=:.              -=:.
                    -=:.. -=:..*  %*%###%  %  -=:.-=:.       -=:.
                    -=:.-=:.-=:.=:.-=:.  ####+*   -=:. ... -=:-=:.
                      -=:.            ###%*%+--=:..
                        -=:.          ###%  +* -=:.. :..
                                      ###       -=:.
                                      ###
                                      ###
                                     #####
                                    *#####*
                  . :: —— == ++ ****###########****++ == —— :: .

OS                 Ubuntu 22.04.3 LTS (5.15.0-91-generic)
UPTIME             14d 3h 22m
HARDWARE           Intel(R) Core(TM) i7-10700 CPU 8 core
MEMORY             4521 MB / 32000 MB
STORAGE            142.3G / 500.0G
NETWORK BANDWIDTH  1000 Mbps (Ethernet)
NODE IP            192.168.1.100
LOCATION           Data Center 1
LOCAL TIME         February 03 2026, 10:30:45 AM EST

SUPPORT            support@example.com
DOCS               docs.example.com

Installation

Linux / macOS

Dependencies

zenfetch requires ncurses. Install the development libraries for your system:

Debian/Ubuntu:

sudo apt install libncursesw5-dev

Fedora:

sudo dnf install ncurses-devel

macOS:

brew install ncurses

Build & Install

git clone https://github.com/punctuations/zenfetch
cd zenfetch
make

This installs both zenfetch and cbonsai to /usr/local/bin.

To install for the current user only:

make install PREFIX=~/.local

Windows

Option 1: Using vcpkg and CMake (Recommended)

  1. Install vcpkg and CMake

  2. Install PDCurses via vcpkg:

    vcpkg install pdcurses:x64-windows
  3. Build with CMake:

    mkdir build
    cd build
    cmake .. -DCMAKE_TOOLCHAIN_FILE=[vcpkg-root]/scripts/buildsystems/vcpkg.cmake
    cmake --build . --config Release
  4. The executables will be in build\Release\

Option 2: Using MSYS2/MinGW

  1. Install MSYS2

  2. In MSYS2 MINGW64 terminal:

    pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-pdcurses mingw-w64-x86_64-cmake make
  3. Build:

    mkdir build && cd build
    cmake .. -G "MinGW Makefiles"
    cmake --build .

Option 3: Visual Studio

  1. Install PDCurses (download from https://pdcurses.org/ or use vcpkg)

  2. Open the project in Visual Studio and configure include/library paths

  3. Build the solution

Usage

Usage: zenfetch [OPTIONS]

Display system info with a bonsai tree.

Options:
  -o, --owner TEXT      set owner name in welcome message
  -L, --location TEXT   set location
  -s, --support TEXT    set support contact info
  -d, --docs URL        set documentation URL
  -S, --no-support      hide support/docs section
  -I, --hide-ip         hide NODE IP field
  -p, --print           print mode
  -n, --noir            noir mode: no colors, bold labels
  -h, --help            show this help

Examples

Basic usage:

zenfetch

With custom owner and location:

zenfetch --owner "John Doe" --location "NYC Office"

Server MOTD with support info:

zenfetch -o "IT Department" -s "help@company.com" -d "wiki.company.com"

Noir mode (no colors):

zenfetch --noir

Hide sensitive info:

zenfetch --hide-ip --no-support

Configuration Files

For persistent configuration, create config files:

Linux/macOS: /etc/zenfetch/

sudo mkdir -p /etc/zenfetch
echo "Your Name" | sudo tee /etc/zenfetch/owner
echo "Building A, Room 101" | sudo tee /etc/zenfetch/location
echo "support@example.com" | sudo tee /etc/zenfetch/support
echo "docs.example.com" | sudo tee /etc/zenfetch/docs

Windows: C:\ProgramData\zenfetch\

mkdir C:\ProgramData\zenfetch
echo Your Name > C:\ProgramData\zenfetch\owner
echo Building A, Room 101 > C:\ProgramData\zenfetch\location
echo support@example.com > C:\ProgramData\zenfetch\support
echo docs.example.com > C:\ProgramData\zenfetch\docs

CLI options override config file values.

Add to Shell Profile

Display zenfetch on every terminal login by adding to ~/.bashrc or ~/.zshrc:

zenfetch

cbonsai

The standalone cbonsai tree generator is also included. See cbonsai --help for options including:

  • -l, --live - Animated growth mode
  • -i, --infinite - Continuously generate trees
  • -S, --screensaver - Screensaver mode
  • -m, --message - Attach a message to the tree
  • -n, --noir - Monochrome mode

Credits

  • cbonsai by jallbrit - The original bonsai tree generator

License

GPL-3.0

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages