applefetch

applefetch is a CLI system information tool for macOS, inspired by neofetch.

Motivation

I wanted to create a neofetch clone for macOS that uses native C++ code and, where possible, system calls, rather than relying on the shell.

It looks like this:

OS: macOS 14.6.1 (arm64)
Model: MacBookPro18,3
Uptime: 17d 23h 52m
Packages: 138 (brew)
Shell: /bin/zsh
Display: 1512x982 @ 120 Hz
CPU: Apple M1 Pro
Memory: 10.16GiB / 16.00GiB (63%)

Please note that more advanced projects (e.g., fastfetch) are already available, this is merely a learning exercise for me.

Features

• Written in modern C++ (C++17).
• Comprehensive documentation with doxygen-style comments.
• Automatic third-party dependency management using CMake's FetchContent.
• No missing STL headers thanks to header-warden.

Tested Systems

This project has been tested on the following systems:

• macOS 14.6 (Sonoma)

Automated testing is also performed on the latest version of macOS using GitHub Actions.

Pre-built Binaries

Pre-built binaries are available for macOS (ARM64). You can download the latest version from the Releases page.

Requirements

To build and run this project, you'll need:

• C++17 or higher
• CMake

Build

Follow these steps to build the project:

1. Clone the repository:

   git clone https://github.com/ryouze/applefetch.git

2. Generate the build system:

   cd applefetch
   mkdir build && cd build
   cmake ..

   Optionally, you can disable compile warnings by setting ENABLE_COMPILE_FLAGS to OFF:

   cmake .. -DENABLE_COMPILE_FLAGS=OFF

3. Compile the project:

   To compile the project, use the following command:

   make

   If you want to use all available cores when compiling with make, you can pass the -j flag along with the number of cores available on your system:

   • macOS:

     make -j$(sysctl -n hw.ncpu)

   • 8-core CPU:

     make -j8

After successful compilation, you can run the program using ./applefetch. However, it is highly recommended to install the program, so that it can be run from any directory. Refer to the Install section below.

Note: The mode is set to Release by default. To build in Debug mode, use cmake .. -DCMAKE_BUILD_TYPE=Debug.

Install

If not already built, follow the steps in the Build section and ensure that you are in the build directory.

To install the program, use the following command:

sudo cmake --install .

Usage

To run the program, use the following command:

applefetch

On startup, the program will display system information akin to the following:

OS: macOS 14.6.1 (arm64)
Model: MacBookPro18,3
Uptime: 17d 23h 52m
Packages: 138 (brew)
Shell: /bin/zsh
Display: 1512x982 @ 120 Hz
CPU: Apple M1 Pro
Memory: 10.16GiB / 16.00GiB (63%)

If the NO_COLOR environment variable is set, the program will not use any color codes in the output.

NO_COLOR=1 applefetch

Flags

[~] $ applefetch --help
Usage: applefetch [-h] [-v]

CLI system information tool for macOS, inspired by neofetch.

Optional arguments:
  -h, --help     prints help message and exits
  -v, --version  prints version and exits

Testing

Tests are included in the project but are not built by default.

To enable and build the tests manually, run the following commands:

cmake .. -DBUILD_TESTS=ON
make
ctest --output-on-failure

Credits

• fmt

Contributing

All contributions are welcome.

License

This project is licensed under the MIT License.