Skip to content

🖥️ TermBoard - a snazzy little terminal dashboard. CPU, memory, network stats, and even your GitHub stars. It’s brill.

Rayaan2009/TermBoard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🖥️ TermBoard - A colourful terminal dashboard for devs

Live CPU • Memory • Network • GitHub stars • Clock - right in your terminal, powered by Rich.

Gameplay demo


✨ Features

  • Live system monitor — CPU %, memory usage, network I/O
  • GitHub flex — sums up total stargazers across public repos ⭐
  • Beautiful TUI — clean panels, colours, and a neat clock
  • Cross‑platform — just run it anywhere Python works

🚀 Quick Start

Requires Python 3.8+

git clone https://github.com/Rayaan2009/termboard.git
cd termboard

python -m venv .venv && source .venv/bin/activate  # Windows: .venv\Scripts\activate

pip install -r requirements.txt

python termboard.py

Press Q or Ctrl+C to exit.


🔧 Configuration

Edit the config section near the top of termboard.py:

REFRESH_SEC = 1.0
GITHUB_USER = "Rayaan2009"

🧠 How it Works

  • psutil grabs CPU, memory, and network data
  • requests pulls GitHub repo data and sums stars
  • rich lays everything out in a live dashboard

🕹 Controls

  • Q or Ctrl+C — quit

📦 Requirements

rich
psutil
requests

🧪 Troubleshooting

  • Stars show N/A: you might be offline or rate‑limited
  • Network numbers are cumulative since boot — that’s normal
  • On Windows, use Windows Terminal or PowerShell 7+ for best colours

🗺 Roadmap

  • CLI flags: --user, --refresh
  • Per‑core CPU view
  • Disk usage panel
  • Authenticated GitHub support
  • Tiny sparklines for CPU/memory

🤝 Contributing

Fork, branch, commit, PR. Keep code clean and commented.


📝 License

MIT License, see LICENSE file.


🙌 Credits


📂 Project Structure

termboard/
├─ termboard.py
└─ README.md

Made with ❤️ by Rayaan2009

Happy hacking - smash that ⭐ if you enjoy TermBoard!

About

🖥️ TermBoard - a snazzy little terminal dashboard. CPU, memory, network stats, and even your GitHub stars. It’s brill.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages