Skip to content

๐Ÿ–ฅ๏ธ TermBoard - a snazzy little terminal dashboard. CPU, memory, network stats, and even your GitHub stars. Itโ€™s brill.

Notifications You must be signed in to change notification settings

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