Skip to content
matkecnPublic

About

A cross-platform terminal system monitor written in Rust ๐Ÿฆ€

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

ย 

History

25 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ–ฅ๏ธ RMon โ€” Real-time System Monitor for the Terminal

Your computer's vitals, rendered in beautiful ANSI color, right inside your terminal. Think Task Manager, htop, and a NASA mission control display had a baby โ€” written in pure ๐Ÿฆ€ Rust.

Rust Platforms TUI License Status


๐Ÿš€ What Is RMon?

RMon is a cross-platform terminal system monitor. It watches your machine's CPU, memory, disk, and running processes โ€” and shows it all on one live dashboard that refreshes itself while you watch.

It runs on Windows, macOS, and Linux from a single codebase, and needs no GUI, no browser, and no cloud. Just you, a terminal, and a lot of colored block characters.

โœจ Features

  • ๐Ÿ”ฅ Live CPU usage โ€” overall gauge, per-core bars, a rolling history sparkline, and a real-time per-core line chart
  • ๐Ÿง  Memory & Swap โ€” used/free with color-coded gauges and sparkline
  • ๐ŸŒ Network panel โ€” live upload/download speeds (per second) plus lifetime traffic totals
  • ๐Ÿ’พ Disk usage โ€” every mounted disk with usage bar, filesystem, and disk type
  • ๐Ÿ“‹ Process list โ€” PID, CPU%, memory, status, and name, continuously refreshed
  • ๐Ÿ–ฑ๏ธ Mouse support โ€” click a process row to select it, scroll the wheel to move the selection
  • ๐ŸŽจ Themes โ€” pick from 6 built-in themes (or define your own colors in a config file)
  • โš™๏ธ Config file โ€” control theme, default sort order, refresh rate, and process-list size
  • โŒจ๏ธ Fully keyboard-driven โ€” no mouse required (but we love you anyway)
  • ๐ŸŽจ Fancy terminal UI โ€” rounded panels, color-coded urgency
  • โšก Adjustable refresh speed โ€” from 200 ms (adrenaline) to 5 s (zen mode)
  • ๐ŸงŠ Pause mode โ€” freeze the world when you need to stare at a number
  • ๐Ÿ”ช Kill processes โ€” right from the keyboard, with a safety confirmation dialog

๐Ÿ› ๏ธ How It Works

RMon is built on a handful of battle-tested Rust crates:

Crate Job
sysinfo Talks to the OS to fetch CPU, memory, disk, network, and process data on all three platforms
ratatui Renders the fancy terminal UI โ€” panels, gauges, charts, sparklines, tables
crossterm Handles raw-mode keyboard and mouse input and terminal size events
serde + toml Parses your config.toml and theme colors

The architecture is cleanly split into modules:

src/
โ”œโ”€โ”€ main.rs     โ†’ Boots the terminal (with mouse capture), runs the event/refresh loop
โ”œโ”€โ”€ app.rs      โ†’ The "brain": gathers system data, keeps UI state, sorts processes
โ”œโ”€โ”€ ui.rs       โ†’ The "eyes": draws every panel, gauge, chart, bar, and table
โ”œโ”€โ”€ handlers.rs โ†’ The "ears": maps every keypress and mouse event to an action
โ”œโ”€โ”€ config.rs   โ†’ Reads your TOML config file (theme, sort, refresh rate)
โ””โ”€โ”€ theme.rs    โ†’ The 6 built-in themes + custom hex-color overrides

The loop (it's simpler than it sounds):

  1. Refresh โ€” sysinfo grabs fresh CPU, memory, disk, network, and process data (~every 1 s).
  2. Render โ€” ratatui redraws the dashboard with the new numbers.
  3. Listen โ€” crossterm waits for your keypresses and mouse moves, so RMon is instant to interact with.

Repeat forever. That's it. That's the whole job. ๐Ÿ’ค


๐Ÿ“ฆ Installation

โœ… Requirements

Supported platforms:

Platform Notes
๐ŸชŸ Windows 10 / 11 โ€” works natively; .sh installers run in Git Bash / MSYS2
๐ŸŽ macOS 12+ (Monterey and newer)
๐Ÿง Linux Most modern distributions (kernel 4.x+); uses /proc, /sys, and statvfs

Software:

  • Rust & Cargo (edition 2021, Rust 1.70+) โ€” install from rustup.rs if you don't have them
  • A terminal that likes ANSI colors โ€” pretty much any of them (Terminal.app, iTerm2, Windows Terminal, GNOME Terminal, Alacritty, Kitty, VS Code integrated terminalโ€ฆ)

Recommended terminal setup:

  • ๐Ÿ–ฅ๏ธ Minimum size 80 ร— 30 (the dashboard adapts to smaller sizes, but it gets cozy)
  • ๐Ÿ”ค A font with box-drawing, block, and braille glyphs (โ–ˆ โ–‘ โ–’ โ–“ โ”€ โ”‚ โฃฟ) โ€” most modern terminal fonts include these; Nerd Fonts look best
  • ๐ŸŒˆ Truecolor / 256-color enabled for the full fancy experience (RMon falls back gracefully if not)

Build resources (only needed if building from source):

  • ~1.5 GB free disk space (Rust toolchain + dependencies)
  • An internet connection on first build (crates are downloaded once, then cached)

Runtime footprint:

  • ๐Ÿœ Tiny โ€” a single ~800 KB binary, no runtime dependencies, no daemon, no cloud.

๐Ÿงฐ Option A โ€” One-line installer (macOS / Linux)

./install.sh

This will:

  1. ๐Ÿ—๏ธ Build the release binary (cargo build --release)
  2. ๐Ÿ“ Install it to ~/.local/bin/rmon
  3. ๐Ÿงญ Print a hint if that folder isn't on your PATH

Install to a custom location:

PREFIX="$HOME/bin" ./install.sh

๐Ÿงฐ Option B โ€” Install with Cargo (all platforms, including Windows)

cargo install --path .

๐Ÿงฐ Option C โ€” Just run it (no install at all)

cargo run            # development build
./target/release/rmon  # if you've already built once

๐Ÿ’ก Windows users: the .sh installers work great in Git Bash / MSYS2. Or skip them entirely and use cargo install โ€” RMon is fully Windows-native.


๐ŸŽฎ How to Use

rmon

That's it. The dashboard appears and starts live-refreshing. Now take control:

Key Action
q / Esc / Ctrl+C ๐Ÿ‘‹ Quit
โ†‘ / โ†“ or j / k Navigate the process list
PgUp / PgDn Jump 10 processes at a time
Home / End Jump to first / last process
d / Delete ๐Ÿ”ช Kill the selected process (asks for confirmation)
y / n Confirm / cancel the kill
s Cycle sort: CPU% โ†’ Memory โ†’ Name โ†’ PID
p โธ๏ธ Pause / resume the live refresh
- / [ ๐Ÿข Slow down refresh (up to 5 s)
+ / ] ๐Ÿ‡ Speed up refresh (down to 200 ms)
r ๐Ÿ”„ Force an immediate refresh

Mouse:

Action Effect
๐Ÿ–ฑ๏ธ Click a row in the process table Select that process
๐Ÿ–ฑ๏ธ Scroll wheel up / down Move the selection through the process list

Pro tips:

  • The gauge colors tell you how stressed things are: ๐ŸŸข green = chill ยท ๐ŸŸก yellow = getting warm ยท ๐Ÿ”ด red = panic mode
  • Sort by Memory and pause (p) to catch that sneaky RAM hog in the act.
  • The per-core line chart under CPU shows every core's last ~2 minutes of history.
  • The sparklines under CPU/Memory show your last ~2 minutes of activity.

โš™๏ธ Configuration

RMon reads a TOML config file on startup, if one exists:

Platform Location
๐ŸŽ macOS / ๐Ÿง Linux ~/.config/rmon/config.toml (or $XDG_CONFIG_HOME/rmon/config.toml)
๐ŸชŸ Windows %APPDATA%\rmon\config.toml

You can point it anywhere with the RMON_CONFIG env var:

RMON_CONFIG="$HOME/my-rmon.toml" rmon

Example config

[monitor]
refresh_ms = 1000   # refresh every second (200โ€“5000)
sort = "cpu"        # default sort: cpu | memory | name | pid
max_processes = 300 # how many processes the table shows

[theme]
name = "dracula"    # see theme list below

๐ŸŽจ Themes

RMon ships with 6 built-in themes โ€” set one with name:

dark ยท light ยท gruvbox ยท dracula ยท solarized ยท nord

Want your own colors? Leave name out (or keep it as a base) and override any slot with hex values:

[theme]
name = "dark"

[theme.colors]
bg     = "#0d1117"
panel  = "#161b22"
accent = "#58a6ff"
title  = "#79c0ff"
text   = "#c9d1d9"
dim    = "#8b949e"
ok     = "#3fb950"
warn   = "#d29922"
danger = "#f85149"

Any field you omit keeps the theme's default. Bad hex values or unknown theme names are ignored (with a warning) and RMon falls back to dark.


๐Ÿ—‘๏ธ Uninstall

"Goodbyes are hard. This one is easy."

The polite way (macOS / Linux)

./uninstall.sh

This removes the rmon binary from ~/.local/bin and asks if you'd also like to delete the build artifacts in target/ (yes, that's where we keep the spare bits).

To also clean a custom install location:

PREFIX="$HOME/bin" ./uninstall.sh

The blunt way (everything, everywhere, all at once)

rm ~/.local/bin/rmon     # remove the binary
rm -rf ~/Desktop/projects/RMon/target   # remove build artifacts
rm -rf ~/Desktop/projects/RMon          # remove the project entirely

โš ๏ธ Heads up: like a breakup, this one's permanent. You can always git clone / re-download and start the romance again, though. ๐Ÿ’”โ†’โค๏ธ

The Cargo way

cargo uninstall rmon

๐Ÿ†˜ Troubleshooting

Problem Fix
rmon: command not found ~/.local/bin isn't on your PATH. Add it (the installer prints how) or use the full path.
Everything looks like a wall of boxes Your terminal font is missing block glyphs. Try a Nerd Font or any modern terminal font.
The per-core chart is just dots Braille glyphs (โฃฟ) missing from your font โ€” same fix as above.
CPU shows 0% on the first frame Normal โ€” RMon needs two samples to compute usage. It corrects itself on the next tick.
Terminal looks scrambled after an accident RMon always restores your terminal (including mouse capture) on exit and on panics. If something weird happens, just run reset.
You can't kill a process Some processes need elevated privileges. That's the OS protecting itself โ€” and occasionally you.
My config file is ignored Double-check the path (see the Configuration section), or set RMON_CONFIG to force a location. Invalid TOML prints a warning at startup and falls back to defaults.

๐Ÿงญ Roadmap

  • CPU, memory, disk, and process monitoring
  • Keyboard navigation + process kill
  • Live sparkline graphs
  • Per-core graph history (proper line charts)
  • Network upload/download speed panel
  • Config file for colors, sorting, and refresh rate
  • Mouse support
  • Themes
  • Process search / filtering
  • Per-network-interface breakdown
  • GPU and temperature sensors
  • Custom keybindings

๐Ÿค Contributing

Found a bug? Want a feature? Open an issue or submit a PR. Fork it, break it, fix it, love it.

๐Ÿ“œ License

MIT. Do whatever you want, just don't blame us when you kill your own browser in the process table. ๐Ÿ˜„


Made with ๐Ÿ’™, ๐Ÿฆ€, and an unhealthy amount of `โ–ˆโ–‘โ–’โ–“` characters.

About

A cross-platform terminal system monitor written in Rust ๐Ÿฆ€

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages