README.md

🖥️ System Resource Monitor CLI

A modern, terminal-based system monitoring dashboard.
Built with Node.js, this CLI provides a clean, real-time visualization of your system’s CPU, memory, disk, and network usage — all right inside your terminal.

---

🚀 Features

• 📊 Real-time metrics for CPU, Memory, Network, and Disk
• ⚙️ Process monitoring with live updates
• 🧩 Cross-platform support (Linux, macOS, and Windows)
• 🎨 Interactive terminal UI with charts and gauges
• ⚡ Lightweight and fast — no external dependencies
• 🛠️ Easily extensible for custom modules and plugins

---

📦 Installation

From npm (recommended)

npm install -g system-resource-monitor

From source

git clone https://github.com/s1mer-ddc/system-monitor.git
cd system-monitor
npm install
npm start

---

🧠 Usage

After installation, simply run:

system-monitor

Or if running locally:

npm start

---

🧩 Development Setup

git clone https://github.com/s1mer-ddc/system-monitor.git
cd system-monitor
npm install
npm run dev

---

⚙️ Requirements

• Node.js ≥ 18
• Terminal with 256-color support
• UTF-8 locale

---

🧠 Tech Stack

• Node.js — core runtime
• Blessed / Blessed-Contrib — for terminal UI
• Systeminformation — system metrics collection
• ES Modules — modern async code

---

🧰 Troubleshooting

Broken characters or layout issues?

Try setting your terminal environment before running:

LANG=en_US.utf8 TERM=xterm-256color system-monitor

Metrics not updating on Windows?

Use WSL or a Linux VM for full functionality.

Permission issues?

Some metrics may require elevated privileges (especially on Linux).

---

📜 License

MIT License

Copyright (c) 2025 s1mer-ddc

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---

👤 Author

s1mer-ddc
🔗 https://github.com/s1mer-ddc

---

🧠 A sleek, developer-friendly system monitor for your terminal — built with Node.js and made for productivity.