macchina

Fast, minimal and customizable system information frontend. Linux • macOS • Windows • NetBSD • FreeBSD • OpenWrt • Android Matrix Version Downloads CI Preview

Table of Contents

About

macchina lets you view system information, like your kernel version, uptime, memory usage, processor load and much more. macchina is basic by default and extensible by design.

If you're interested in the library macchina uses to fetch system information, have a look at [libmacchina]; fetching-related issues should be filed on that repository.

Benchmarks

Execution time is measured using hyperfine

macchina is lightning fast, see for yourself:

Linux

This benchmark was performed on an Intel® Core™ i5-8265U

| Command | Mean [ms] | Min [ms] | Max [ms] | | :--------- | --------: | -------: | -------: | | macchina | 2.8 ± 0.4 | 2.3 | 4.6 |

macOS

| Command | Mean [ms] | Min [ms] | Max [ms] | | :--------- | --------: | -------: | -------: | | macchina | 5.0 ± 0.2 | 4.7 | 5.9 |

NetBSD

This benchmark was performed inside a virtual machine on an Intel® Core™ i5-8265U

| Command | Mean [ms] | Min [ms] | Max [ms] | | :--------- | ---------: | -------: | -------: | | macchina | 17.7 ± 1.6 | 16.8 | 27.2 |

Windows

| Command | Mean [ms] | Min [ms] | Max [ms] | | :--------- | --------: | -------: | -------: | | macchina | 9.0 ± 0.4 | 8.2 | 11.7 |

Features

Themes

macchina has a theming system which you can use to customize pretty much any visual aspect of the program. Themes live outside the configuration file, so you can create a bunch of them and switch between them at any time.

Why are they separate?

Learn how to make your own, and maybe have a look at the documentation while you're at it.

Doctor

[libmacchina] can sometimes fail to fetch certain readouts, and macchina has a feature in place that describes why they failed. You don't have to guess what went wrong, --doctor has your back!

Configuration

The configuration file defines the behavior of macchina, it does not allow for much customization. See macchina.toml for an example configuration file.

In order for macchina to be able to read the configuration file, you need to place macchina.toml inside:

If macchina is not utilizing your configuration file, despite you placing it in the correct location, you should tell macchina where to find it by passing the file's path to --config.

Customization

Themes are TOML files that describe the layout and styling of macchina. See Hydrogen.toml for an example theme.

In order for macchina to be able to find your themes, you need to place them in:

To start using your theme:

  1. Run macchina --list-themes to verify that macchina has listed your theme.

  2. If all goes well, you should see one or more themes listed.

  3. In macchina.toml, set theme to one of the listed themes, e.g.:

bash theme = "Helium" # case-sensitive!

  1. You're good to go! macchina will start using your theme.

Dependencies

Build dependencies

The following are required dependencies if you're building from source or installing through cargo:

Runtime dependencies

The following are optional dependencies, they only extend what macchina can fetch:

Linux:

NetBSD:

Installation

Cargo

cargo install macchina

Pkgsrc

pkgin install macchina

openSUSE Tumbleweed

zypper in macchina

Homebrew

brew install macchina

Termux

pkg install macchina

Windows

scoop install macchina

Nix

bash nix-env -iA <channel>.macchina

Arch Linux

bash git clone https://aur.archlinux.org/macchina.git cd macchina makepkg -si

bash git clone https://aur.archlinux.org/macchina-git.git cd macchina makepkg -si

The installation wiki page lists some other ways you can install the program or the steps to compile from source.

You might prefer running the prebuilt binary that corresponds with your operating system.

Packaging Status

Packaging status

Contributors

Crates.io

macchina, like many other open-source projects, would not be where it is right now without the help of its contributors — Thank you all so much!

Looking to help? Read this first.

The following are some awesome people that have helped make macchina a really cool fetcher:

ASCII Art

Some of the ASCII art displayed in macchina is not our own.

If you (the artist) are not okay with us using your ASCII art, please contact me.