/cmdtop

⌨️ A tool for showing your top commands

Primary LanguageGoMIT LicenseMIT

cmdtop

Analyze your command history.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Have you ever wondered what commands you're running the most for work or personal projects? cmdtop lets you show off your history as a way of showcasing favorite tools, processes, or just plain habits.

Here's my cmdtop:

Top 5 commands:
1: ls (46)
2: cd (40)
3: vi (25)
4: yay (20)
5: go (15)

At the top is ls (pretty common) and I've used it 46 times.

(back to top)

Getting Started

Prerequisites

Follow the instructions for downloading and installing Go.

Installation

  1. Clone the repo 
    git clone https://github.com/quentinlintz/cmdtop.git
  2. Change directory and run the command 
    cd cmdtop
go run .

(back to top)

Usage

  • Use the -h flag to list detailed flag usage
  • Use the -top {int} flag to choose how many top commands to display
  • Use the -version flag to check the version
  • Use the -license flag to view the software license

(back to top)

Roadmap

  • Add zsh parser
  • Add bash parser
  • Add fish parser
  • Enhance output format (open to creative ideas!)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Quentin Lintz - @quentinlintz - quentinlintz@outlook.com

Project Link: https://github.com/quentinlintz/cmdtop

(back to top)