https://github.com/martialblog/cheatsheet

Cool command-line cheatsheet. Open format, grep-able, where you need them most.
https://github.com/martialblog/cheatsheet

cheatsheet cli custom-cheatsheets python shortcut

Last synced: 5 months ago
JSON representation

Cool command-line cheatsheet. Open format, grep-able, where you need them most.

• Host: GitHub
• URL: https://github.com/martialblog/cheatsheet
• Owner: martialblog
• License: mit
• Created: 2016-03-01T16:42:08.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2020-12-03T13:36:42.000Z (over 5 years ago)
• Last Synced: 2025-01-21T00:44:25.692Z (over 1 year ago)
• Topics: cheatsheet, cli, custom-cheatsheets, python, shortcut
• Language: Python
• Size: 101 KB
• Stars: 66
• Watchers: 8
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.com/martialblog/cheatsheet.svg?branch=master)](https://travis-ci.com/martialblog/cheatsheet) [![Coverage Status](https://coveralls.io/repos/github/martialblog/cheatsheet/badge.svg?branch=master)](https://coveralls.io/github/martialblog/cheatsheet?branch=master)

# 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!

- Cheatsheets directly in your terminal

- Open-Format so you can customize/add/share

- Grep-able!

## 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:

```bash

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

```

For usability you can set an alias:

```bash

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

```

For Python 2:

```bash

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

```

And away we go!

```bash

user@computer$ cheat git

```

![Cheat Screenshot](cheat-screenshot.png?raw=true "Cheat Screenshot")

To list all available cheatsheets:

```bash

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:

```bash

python3 -m unittest -v

```