cbaron3/topcmds

CLI that displays the 100 most useful commands for Linux-based machines.

topcmds

Simple CLI built to list out the Top 100 most useful commands in Linux-based operating systems.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

This project is simple. After invoking the executable from the command line, 100 of the most useful commands will be listed out in the terminal for your reference. Commands can also be filtered based on category (second column) using command line arguments.

Built With

• C++
• CLI11
• termcolor

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is a list things you need to use to run topcmds.

• cmake

sudo apt install cmake

Installation

1. Clone the repo

git clone https://github.com/cbaron3/topcmds.git

2. Build the executable

mkdir build
cd build
cmake ..
make

3. Run topcmds

./topcmds --all

4. [Optional] Add the executable to bin

chmod +x topcmds
sudo cp /path/to/executable/topcmds /bin

Usage

Usage instructions are found by running

topcmds --help

OR

topcmds -h

[]

Roadmap

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

Contributing

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

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

License

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

Contact

Carl Baron - carbaro196@gmail.com

Project Link: https://github.com/cbaron3/topcmds