yoinky 0.1.2

TUI tool for monitoring system resources like CPU, RAM, and GPU.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# 🛰️ Yoinky :: System Monitor

![Yoinky Screenshot](https://i.imgur.com/YOUR_SCREENSHOT_ID.png) <!-- Replace with a real screenshot URL -->

A lightweight and efficient terminal-based system monitor for Linux, built with Rust 🦀. Yoinky provides a real-time, at-a-glance view of your system's key metrics in a clean and boxy terminal user interface.

## ✨ Features

- **💻 CPU Monitoring**: Tracks core count, temperature, and overall usage percentage.
- **🧠 RAM Monitoring**: Displays current memory usage with a progress gauge.
- **🎮 GPU Monitoring**: Detects GPU type (Nvidia/AMD) and shows its temperature.
- **💾 Disk Monitoring**: Shows total disk usage for your root partition.
- **🎨 Modern TUI**: A clean, segmented interface built with `ratatui`.
- **🚀 Lightweight**: Written in Rust for performance and low resource consumption.

## 🛠️ Technology Stack

- **[Rust](https://www.rust-lang.org/)**: The core programming language, chosen for its safety and performance.
- **[ratatui](https://ratatui.rs/)**: A TUI (Terminal User Interface) library for creating rich, interactive terminal applications.
- **[crossterm](https://github.com/crossterm-rs/crossterm)**: A terminal manipulation library used as a backend for `ratatui`.
- **[procfs](https://github.com/eminence/procfs)**: A library to access system and process information from the `/proc` filesystem on Linux.

## 🚀 Getting Started

### ✅ Prerequisites

- [Rust](https://www.rust-lang.org/tools/install) (and Cargo) installed on your system.
- On NVIDIA systems: `nvidia-smi` command-line tool must be installed and in your PATH.
- On AMD systems: `rocm-smi` may be required for temperature readings on newer cards.

### 📦 Easy Installation & Running

1.  Install Yoinky using Cargo:

    ```bash
    cargo install yoinky
    ```

2.  Run the application:

    ```bash
    yoinky
    ```

### 👨‍💻 Installation & Running from Source

1.  Clone the repository:

    ```bash
    git clone https://github.com/your-username/yoinky.git # Replace with your repo URL
    cd yoinky
    ```

2.  Run the application:

    ```bash
    cargo run
    ```

3.  Press `q` to exit the application.

---

## 🖼️ Screenshots

![yoinky](yoinkySS.png)

_This project is under active development. Future plans include process lists, network monitoring, and more detailed hardware information!_