https://github.com/IEEE-VIT/termiboard
A smart CLI Dashboard to fetch cpu, memory and network stats!
https://github.com/IEEE-VIT/termiboard
cli cli-dashboard cpu-monitoring golang memory-monitoring system terminal
Last synced: 6 months ago
JSON representation
A smart CLI Dashboard to fetch cpu, memory and network stats!
- Host: GitHub
- URL: https://github.com/IEEE-VIT/termiboard
- Owner: IEEE-VIT
- License: mit
- Created: 2020-09-30T09:35:24.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-04T00:07:09.000Z (over 4 years ago)
- Last Synced: 2024-08-10T11:02:39.241Z (10 months ago)
- Topics: cli, cli-dashboard, cpu-monitoring, golang, memory-monitoring, system, terminal
- Language: Go
- Homepage:
- Size: 169 KB
- Stars: 35
- Watchers: 4
- Forks: 16
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Termiboard
[](https://github.com/IEEE-VIT/termiboard/)
[](https://github.com/IEEE-VIT/termiboard/blob/master/LICENSE)
[](https://github.com/IEEE-VIT/termiboard)
[](https://github.com/IEEE-VIT/termiboard)
[](https://github.com/IEEE-VIT/termiboard/issues?q=is%3Aopen+is%3Aissue)
[](https://github.com/IEEE-VIT/termiboard/issues/new/choose)
The cross platform CLI Dashboard which shows all your system stats and info in an instant.
## Getting Started
* Fork it.
* Clone your forked repo and move inside it:
`git clone https://github.com//termiboard.git && cd termiboard`
* Checkout to a new branch to work on an issue:
`git checkout -b my-amazing-feature`
* Run termiboard
```console
go run .
```
* Build termiboard
```console
go build
./termiboard
```
* Once you're all done coding, it's time to open a PR :)
Run the following commands from the root of the project directory:
`git add .`
`git commit -m "A short description about the feature."`
`git push origin `
Open your forked repo in your browser and then raise a PR to the `master` branch of this repository!
## Usage
Once the executable file is created, the program can be executed as:
### Without Flag Options
This will by default show all the parameters of the System.
```console
./termiboard
```
Output:
### With Flag Options
If the flag options are passed, then the specific parameters of the System will be displayed.
```console
./termiboard --cpu-usage
```
Output:
#### All Available Options
```console
./termiboard --help
```
| Flag | Function |
|-------------|-------------------------------------------------|
| --all | Show all stats |
| --cpu-info | Show CPU information |
| --cpu-usage | Show CPU usage |
| --disk | Show disk usage |
| --local-ip | Show local IP address |
| --public-ip | Show public IP address |
| --ram | Show RAM usage |
| --top5-ram | Show top 5 process that consume the most memory |
## Contributing
To start contributing, check out [CONTRIBUTING.md](https://github.com/IEEE-VIT/termiboard/blob/master/CONTRIBUTING.md). New contributors are always welcome to support this project. Kindly consider leaving a :star: if you like the project :)
## License
This project is licensed under [MIT](https://github.com/IEEE-VIT/termiboard/blob/master/LICENSE).