Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markusressel/fan2go-tui
Terminal UI for fan2go.
https://github.com/markusressel/fan2go-tui
fan fan2go go golang golang-application graphs hacktoberfest terminal tui ui
Last synced: 3 months ago
JSON representation
Terminal UI for fan2go.
- Host: GitHub
- URL: https://github.com/markusressel/fan2go-tui
- Owner: markusressel
- License: agpl-3.0
- Created: 2023-10-03T12:24:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-28T00:53:21.000Z (3 months ago)
- Last Synced: 2024-10-28T02:27:51.335Z (3 months ago)
- Topics: fan, fan2go, go, golang, golang-application, graphs, hacktoberfest, terminal, tui, ui
- Language: Go
- Homepage:
- Size: 326 KB
- Stars: 21
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
fan2go-tui
Terminal UI for fan2go.
[![Programming Language](https://img.shields.io/badge/Go-00ADD8?logo=go&logoColor=white)]()
[![Latest Release](https://img.shields.io/github/release/markusressel/fan2go-tui.svg)](https://github.com/markusressel/fan2go-tui/releases)
[![License](https://img.shields.io/badge/license-AGPLv3-blue.svg)](/LICENSE)[![asciicast](https://asciinema.org/a/612087.svg)](https://asciinema.org/a/612087)
# Features
* [x] Visualize detected and configured fans
* [x] Monitor curve values
* [x] Inspect sensor readings# How to use
> **Note:**
> fan2go-tui depends on the API of the [fan2go](https://github.com/markusressel/fan2go) daemon.## Installation
### Arch Linux ![](https://img.shields.io/badge/Arch_Linux-1793D1?logo=arch-linux&logoColor=white)
```shell
yay -S fan2go-tui-git
```Community Maintained Packages
None yet
### Manual
Compile yourself:
```shell
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](https://github.com/markusressel/fan2go) and enable the api:
```yaml
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//.config/fan2go-tui/fan2go-tui.yaml`
* `./fan2go-tui.yaml````shell
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](/fan2go-tui.yaml).# Dependencies
See [go.mod](go.mod)
# License
```
fan2go-tui
Copyright (C) 2023 Markus ResselThis 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 .
```