Awesome

<h1 align="center">fan2go-tui</h1> <h4 align="center">Terminal UI for <a href="https://github.com/markusressel/fan2go">fan2go</a>.</h4> <div align="center">

</div>

Features

Visualize detected and configured fans
Monitor curve values
Inspect sensor readings

How to use

Note: fan2go-tui depends on the API of the fan2go daemon.

Installation

Arch Linux

yay -S fan2go-tui-git

<details> <summary>Community Maintained Packages</summary>

None yet

</details>

Manual

Compile yourself:

git clone https://github.com/markusressel/fan2go-tui.git
cd fan2go-tui
make build
sudo cp ./bin/fan2go-tui /usr/bin/fan2go-tui
sudo chmod ug+x /usr/bin/fan2go-tui

Configuration

fan2go (daemon)

Open the configuration of fan2go and enable the api:

api:
  enabled: true

fan2go-tui

Note: The configuration is optional and sane defaults will be used if omitted.

Then configure fan2go-tui by creating a YAML configuration file in one of the following locations:

/etc/fan2go-tui/fan2go-tui.yaml (recommended)
/home/<user>/.config/fan2go-tui/fan2go-tui.yaml
./fan2go-tui.yaml

sudo mkdir -P ~/.config/fan2go-tui
sudo nano ~/.config/fan2go-tui/fan2go-tui.yaml

Example

An example configuration file including more detailed documentation can be found in fan2go-tui.yaml.

Dependencies

See go.mod

License

fan2go-tui
Copyright (C) 2023  Markus Ressel

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.