This repository contains personal cheatsheets to be used with cheat.
brew install cheator check the cheat installation page.
First verify cheat's conf.yml file, generally at
~/.config/cheat/conf.yml. Runcheat -dto see the paths.
git clone https://github.com/sauljabin/cheatsheets.git ~/.config/cheat/cheatsheets/personal
cheat -l -p personalTo view a cheatsheet:
cheat tarTo view a cheatsheet inside a path:
cheat -p community tar
cheat -p personal tarTo view a cheatsheet inside all paths:
cheat -a tarTo view the configured cheatpaths:
cheat -dTo list all available cheatsheets:
cheat -lTo list all cheatsheets that are tagged with "networking":
cheat -l -t networkingTo list all cheatsheets on the "personal" path:
cheat -l -p personalTo search for the phrase "ssh" among cheatsheets:
cheat -s sshTo search (by regex) for cheatsheets that contain an IP address:
cheat -r -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'Flags may be combined in intuitive ways. Example: to search sheets on the "personal" cheatpath that are tagged with "networking" and match a regex:
cheat -p personal -t networking --regex -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'Cheatsheets are plain-text files that begin with an optional "front matter"
header in YAML format. The header may be used to assign "tags" to a sheet, and
to specify the sheet's syntax (bash, python, go, etc).
When possible, cheatsheets should conform to this format:
---
syntax: bash
tags: [ vcs, development ]
---
# To stage all changes in the current directory:
git add --all
# To commit staged changes:
git commit -m <message>As a guideline, it is preferred to use docopt syntax when specifying
parameter placeholders. In edge-cases where that syntax may cause confusion, it
is permissible to use placeholder values (foo.txt, example.com, etc.) as
necessary.
Cheatsheets are licensed under Creative Commons CC0 1.0. See LICENSE for the full license text.