martialblog / cheatsheet

Cool command-line cheatsheet. Open format, grep-able, where you need them most.
MIT License
65 stars 12 forks source link
cheatsheet cli custom-cheatsheets python shortcut

Build Status Coverage Status

Commandline Cheatsheets

Everybody likes cheatsheets. If you're like me and use lots of different tools but you can't remember all those cool shortcuts to impress your colleagues.

Sure, there are lots of PDFs out there with everything you need. But are you really gonna have an PDF reader next to your terminal to look up shortcuts? Come on, who are we kidding?

I'm trying to solve that problem by putting the cheatsheets where they belong. The terminal you're working in!

Requirements

Nothing but good old Python (3.x), it's not rocketscience.

I also provided a Python 2.x version. However, main branch is 3.x.

Setup

Clone this repository to ~/cheat.d. Like so:

git clone https://github.com/martialblog/cheatsheet.git ~/.cheat.d

For usability you can set an alias:

alias cheat="python3 ~/.cheat.d/cheat/cheat.py"

For Python 2:

alias cheat="python2 ~/.cheat.d/cheat/cheat.py2"

And away we go!

user@computer$ cheat git

Cheat Screenshot

To list all available cheatsheets:

user@computer$ cheat --list

Custom cheatsheets

You can add custom cheatsheet that will be "gitgnored" by using the prexif my-

Contributing

Every Pull Request is welcome, either to extend features or to add new cheatsheets.

Unittest

To run the Unittests simply run the Python Unittest Module within the repository:

python3 -m unittest -v