Git Product home page Git Product logo

termiboard's Introduction

Termiboard

Open Source Love svg1 GitHub license GitHub go.mod Go version of a Go module GitHub Workflow Build Passing GitHub Open Issues PRs Welcome

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/<your-github-username>/termiboard.git && cd termiboard

  • Checkout to a new branch to work on an issue:

git checkout -b my-amazing-feature

  • Run termiboard
go run .
  • Build termiboard
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 <my-amazing-feature>

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.

./termiboard

Output:
Complete Output SS

With Flag Options

If the flag options are passed, then the specific parameters of the System will be displayed.

./termiboard --cpu-usage

Output:
CPU Info Output SS

All Available Options

./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. New contributors are always welcome to support this project. Kindly consider leaving a โญ if you like the project :)

License

This project is licensed under MIT.

termiboard's People

Contributors

darthbenro008 avatar sjchoure avatar s-maciejewski avatar aryan9600 avatar arrwhidev avatar 0vj avatar mayankshah1607 avatar scanepa avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.