v2.2.1

Version bump to 2.2.1. (Release contains new default cheatsheets.)

CHANGELOG

@@ -1,3 +0,0 @@
-Changelog
-=========
-

CONTRIBUTING.md

@@ -1,17 +1,29 @@
 Contributing
 ============
 If you would like to contribute cheetsheets or program functionality, please
-fork this repository, make your changes, and submit a pull request.
+fork this repository, make your changes, and submit a pull request against the
+`master` branch.
 
+
+## Python standards ##
 Python code should conform to [PEP 8][].
 
-Licensing
----------
-By contributing to the project, you agree to license your work under the same
-licenses as `cheat` itself. `cheat` is currently dual-licensed under the GPL3
-and MIT licenses, though that could change without notice in the future.
 
-`cheat`, however, will always remain free software (as in both "free as in
-freedom" and "free as in beer") and shall always be licensed accordingly.
+## Cheatsheet Format ##
+Please pattern your cheatsheets after the following:
+
+```sh
+# To extract an uncompressed archive:
+tar -xvf /path/to/foo.tar
+
+# To create an uncompressed archive:
+tar -cvf /path/to/foo.tar /path/to/foo/
+
+# To extract a .gz archive:
+tar -xzvf /path/to/foo.tgz
+```
+
+If you are submitting a cheatsheet that contains side-by-side columns of text,
+please align the columns using spaces rather than tabs.
 
 [PEP 8]: http://legacy.python.org/dev/peps/pep-0008/ 

README.md

@@ -1,5 +1,4 @@
 [![PyPI](https://img.shields.io/pypi/v/cheat.svg)](https://pypi.python.org/pypi/cheat/)
-[![PyPI](https://img.shields.io/pypi/dm/cheat.svg)](https://pypi.python.org/pypi/cheat/)
 
 cheat
 =====
@@ -74,7 +73,7 @@ variable set, you may edit cheatsheets with:
 cheat -e foo
 ```
 
-If the 'foo' cheatsheet already exists, it will be opened for editing.
+If the `foo` cheatsheet already exists, it will be opened for editing.
 Otherwise, it will be created automatically.
 
 After you've customized your cheatsheets, I urge you to track `~/.cheat/` along
@@ -110,13 +109,32 @@ export CHEATPATH="$CHEATPATH:/path/to/more/cheats"
 You may view which directories are on your `CHEATPATH` with `cheat -d`.
 
 ### Enabling Syntax Highlighting ###
-`cheat` can apply syntax highlighting to your cheatsheets if so desired. To
-enable this feature, set a `CHEATCOLORS` environment variable:
+`cheat` can optionally apply syntax highlighting to your cheatsheets. To enable
+syntax highlighting, export a `CHEATCOLORS` environment variable:
 
 ```sh
 export CHEATCOLORS=true
 ```
 
+#### Specifying a Syntax Highlighter ####
+You may manually specify which syntax highlighter to use for each cheatsheet by
+wrapping the sheet's contents in a [Github-Flavored Markdown code-fence][gfm].
+
+Example:
+
+<pre>
+```sql
+-- to select a user by ID
+SELECT *
+FROM Users
+WHERE id = 100
+```
+</pre>
+
+If no syntax highlighter is specified, the `bash` highlighter will be used by
+default.
+
+
 See Also:
 ---------
 - [Enabling Command-line Autocompletion][autocompletion]
@@ -125,5 +143,6 @@ See Also:
 
 [autocompletion]:   https://github.com/chrisallenlane/cheat/wiki/Enabling-Command-line-Autocompletion
 [dotfiles]:         http://dotfiles.github.io/
+[gfm]:              https://help.github.com/articles/creating-and-highlighting-code-blocks/
 [installing]:       https://github.com/chrisallenlane/cheat/wiki/Installing
 [related-projects]: https://github.com/chrisallenlane/cheat/wiki/Related-Projects

bin/cheat

@@ -2,6 +2,8 @@
 
 """cheat
 
+Create and view cheatsheets on the command line.
+
 Usage:
   cheat <cheatsheet>
   cheat -e <cheatsheet>
@@ -10,24 +12,26 @@ Usage:
   cheat -d
   cheat -v
 
-cheat allows you to create and view interactive cheatsheets on the
-command-line. It was designed to help remind *nix system
-administrators of options for commands that they use frequently,
-but not frequently enough to remember.
-
-Examples:
-  To look up 'tar':
-  cheat tar
-
-  To create or edit the cheatsheet for 'foo':
-  cheat -e foo
-
 Options:
   -d --directories  List directories on CHEATPATH
   -e --edit         Edit cheatsheet
   -l --list         List cheatsheets
   -s --search       Search cheatsheets for <keyword>
   -v --version      Print the version number
+
+Examples:
+
+  To view the `tar` cheatsheet:
+    cheat tar
+
+  To edit (or create) the `foo` cheatsheet:
+    cheat -e foo
+
+  To list all available cheatsheets:
+    cheat -l
+
+  To search for "ssh" among all cheatsheets:
+    cheat -s ssh
 """
 
 # require the dependencies
@@ -38,7 +42,7 @@ from docopt import docopt
 
 if __name__ == '__main__':
     # parse the command-line options
-    options = docopt(__doc__, version='cheat 2.1.27')
+    options = docopt(__doc__, version='cheat 2.2.1')
 
     # list directories
     if options['--directories']:

cheat/cheatsheets/7z

@@ -11,7 +11,7 @@ u       update
 x       extract with full paths
 
 Example:
-7z a -t7z -m0-lzma -mx=9 -mfb=64 -md=32m -ms=on archive.7z dir1
+7z a -t7z -m0=lzma -mx=9 -mfb=64 -md=32m -ms=on archive.7z dir1
 
 -t7z        7z archive
 -m0=lzma    lzma method

cheat/cheatsheets/cheat

@@ -0,0 +1,14 @@
+# To see example usage of a program:
+cheat <command>
+
+# To edit a cheatsheet
+cheat -e <command>
+
+# To list available cheatsheets
+cheat -l
+
+# To search available cheatsheets
+cheat -s <command>
+
+# To get the current `cheat' version
+cheat -v

cheat/cheatsheets/crontab

@@ -16,7 +16,7 @@ SHELL=/bin/bash
 */15 * * * * /home/user/command.sh
 
 # every midnight
-* 0 * * * /home/user/command.sh
+0 0 * * * /home/user/command.sh
 
 # every Saturday at 8:05 AM
 5 8 * * 6 /home/user/command.sh

cheat/cheatsheets/cryptsetup

@@ -0,0 +1,8 @@
+# open encrypted partition /dev/sdb1 (reachable at /dev/mapper/backup)
+cryptsetup open --type luks /dev/sdb1 backup
+
+# open encrypted partition /dev/sdb1 using a keyfile (reachable at /dev/mapper/hdd)
+cryptsetup open --type luks --key-file hdd.key /dev/sdb1 hdd
+
+# close luks container at /dev/mapper/hdd
+cryptsetup close hdd

cheat/cheatsheets/curl

@@ -33,3 +33,6 @@ curl http://ifconfig.me/all/json
 
 # Limit the rate of a download
 curl --limit-rate 1000B -O http://path.to.the/file
+
+# Get your global IP
+curl httpbin.org/ip 

cheat/cheatsheets/deb

@@ -1,3 +1,7 @@
 # Extract contents of a .deb file
 $ ar vx foo.deb    # -> data.tar.gz
 $ tar xf data.tar.gz
+
+# Install .deb file to a debian like system, e.g. ubuntu
+$ sudo dpkg -i foo.deb
+$ sudo apt-get install -f

cheat/cheatsheets/emacs

@@ -4,9 +4,11 @@
   Cut                 CTRL-w
   Copy                ALT-w
   Paste ("yank")      CTRL-y
+  Begin selection     CTRL-SPACE
   Search/Find         CTRL-s
   Replace             ALT-% (ALT-SHIFT-5)
   Save                CTRL-x CTRL-s
+  Save as             CTRL-x CTRL-w
   Load/Open           CTRL-x CTRL-f
   Undo                CTRL-x u
   Highlight all text  CTRL-x h
@@ -23,11 +25,21 @@
   Split screen horizontally with 24 column width  CTRL-u 24 CTRL-x 3
   Revert to single screen                         CTRL-x 1
   Hide the current screen                         CTRL-x 0
-  Kill the current screen                         CTRL-x k
-  Move to the next buffer                         CTRL-x O
+  Move to the next screen                         CTRL-x o
+  Kill the current buffer                         CTRL-x k
   Select a buffer                                 CTRL-x b
   Run command in the scratch buffer               CTRL-x CTRL-e
 
+# Navigation ( backward / forward )
+  
+  Character-wise                                  CTRL-b , CTRL-f
+  Word-wise                                       ALT-b  , ALT-f
+  Line-wise                                       CTRL-p , CTRL-n
+  Sentence-wise                                   ALT-a  , ALT-e
+  Paragraph-wise                                  ALT-{ , ALT-}
+  Function-wise                                   CTRL-ALT-a , CTRL-ALT-e
+  Line beginning / end                            CTRL-a , CTRL-e
+
 # Other stuff
 
   Open a shell         ALT-x eshell

cheat/cheatsheets/hg

@@ -0,0 +1,20 @@
+# Clone a directory
+hg clone
+
+# Add files to hg tracker
+hg add filename
+
+# Add all files in a folder to hg tracker
+hg add folder/
+
+# Create a commit with all tracked changes and a message
+hg commit -m "message"
+
+# Push commits to source repository
+hg push
+
+# Pull changes from source repository
+hg pull
+
+# Rebase local commits to disambiguate with remote repository
+hg pull --rebase

cheat/cheatsheets/openssl

@@ -15,6 +15,9 @@ openssl req -text -noout -in server.csr
 # To show certificate information for generated certificate
 openssl x509 -text -noout -in server.crt 
 
+# To get the sha256 fingerprint of a certificate
+openssl x509 -in server.crt -noout -sha256 -fingerprint
+
 # To view certificate expiration:
 echo | openssl s_client -connect <hostname>:443 2> /dev/null | \
 awk '/-----BEGIN/,/END CERTIFICATE-----/' | \

cheat/cheatsheets/pgrep

@@ -0,0 +1,5 @@
+# Get a list of PIDs matching the pattern 
+pgrep example
+
+# Kill all PIDs matching the pattern
+pgrep -f example | xargs kill

cheat/cheatsheets/pip

@@ -23,5 +23,8 @@ pip list --outdated
 # Upgrade all outdated packages, thanks to http://stackoverflow.com/a/3452888
 pip freeze --local | grep -v '^\-e' | cut -d = -f 1 | xargs -n1 pip install -U
 
+# Upgrade outdated packages on latest version of pip
+pip list --outdated --format=freeze | cut -d = -f 1 | xargs -n1 pip install -U
+
 # Install specific version of a package
 pip install -I SomePackage1==1.1.0 'SomePackage2>=1.0.4'

cheat/cheatsheets/pkill

@@ -0,0 +1,5 @@
+# To kill a process using it's full process name
+pkill <processname>
+
+# To kill a process by it's partial name
+pkill -f <string>

cheat/cheatsheets/popd

@@ -0,0 +1,2 @@
+# Returns to the directory at the top of the `pushd' stack
+popd

cheat/cheatsheets/psql

@@ -0,0 +1,26 @@
+# psql is the PostgreSQL terminal interface. The following commands were tested on version 9.5.
+# Connection options:
+# -U username (if not specified current OS user is used).
+# -p port.
+# -h server hostname/address.
+
+# Connect to a specific database:
+psql -U postgres -h serverAddress -d dbName
+
+# Get databases on a server:
+psql -U postgres -h serverAddress --list
+
+# Execute sql query and save output to file:
+psql -U postgres -d dbName -c 'select * from tableName;' -o fileName
+
+# Execute query and get tabular html output:
+psql -U postgres -d dbName -H -c 'select * from tableName;'
+
+# Execute query and save resulting rows to csv file:
+psql -U postgres -d dbName -t -A -P fieldsep=',' -c 'select * from tableName;' -o fileName.csv
+
+# Read commands from file:
+psql -f fileName
+
+# Restore databases from file:
+psql -f fileName.backup postgres

cheat/cheatsheets/pushd

@@ -0,0 +1,5 @@
+# Pushes your current directory to the top of a stack while changing to the specified directory
+pushd <directory>
+
+# To return use popd
+popd

cheat/cheatsheets/shutdown

@@ -0,0 +1,8 @@
+# Reboot the system immediately
+shutdown -r now
+
+# Shut system down immediately
+shutdown -h now
+
+# Reboot system after 5 minutes
+shutdown -r +5

cheat/cheatsheets/su

@@ -0,0 +1,2 @@
+# Switch to another user account
+su USERNAME

cheat/cheatsheets/tar

@@ -19,6 +19,9 @@ tar -xjvf /path/to/foo.tgz
 # To create a .bz2 archive:
 tar -cjvf /path/to/foo.tgz /path/to/foo/
 
+# To extract a .tar in specified Directory:
+tar -xvf /path/to/foo.tar -C /path/to/destination/
+
 # To list the content of an .bz2 archive:
 tar -jtvf /path/to/foo.tgz
 

cheat/cheatsheets/zsh

@@ -0,0 +1,82 @@
+# A plain old glob
+print -l *.txt
+print -l **/*.txt
+
+# Show text files that end in a number from 1 to 10
+print -l **/*<1-10>.txt
+
+# Show text files that start with the letter a
+print -l **/[a]*.txt
+
+# Show text files that start with either ab or bc
+print -l **/(ab|bc)*.txt
+
+# Show text files that don't start with a lower or uppercase c
+print -l **/[^cC]*.txt
+
+# Show only directories
+print -l **/*(/)
+
+# Show only regular files
+print -l **/*(.)
+
+# Show empty files
+print -l **/*(L0)
+
+# Show files greater than 3 KB
+print -l **/*(Lk+3)
+
+# Show files modified in the last hour
+print -l **/*(mh-1)
+
+# Sort files from most to least recently modified and show the last 3
+print -l **/*(om[1,3])
+
+# `.` show files, `Lm-2` smaller than 2MB, `mh-1` modified in last hour,
+# `om` sort by modification date, `[1,3]` only first 3 files
+print -l **/*(.Lm-2mh-1om[1,3])
+
+# Show every directory that contain directory `.git`
+print -l **/*(e:'[[ -d $REPLY/.git ]]':)
+
+# Return the file name (t stands for tail)
+print -l *.txt(:t)
+
+# Return the file name without the extension (r stands for remove_extension)
+print -l *.txt(:t:r)
+
+# Return the extension
+print -l *.txt(:e)
+
+# Return the parent folder of the file (h stands for head)
+print -l *.txt(:h)
+
+# Return the parent folder of the parent
+print -l *.txt(:h:h)
+
+# Return the parent folder of the first file
+print -l *.txt([1]:h)
+
+# Parameter expansion
+files=(*.txt)          # store a glob in a variable
+print -l $files
+print -l $files(:h)    # this is the syntax we saw before
+print -l ${files:h}
+print -l ${files(:h)}  # don't mix the two, or you'll get an error
+print -l ${files:u}    # the :u modifier makes the text uppercase
+
+# :s modifier
+variable="path/aaabcd"
+echo ${variable:s/bc/BC/}    # path/aaaBCd
+echo ${variable:s_bc_BC_}    # path/aaaBCd
+echo ${variable:s/\//./}     # path.aaabcd (escaping the slash \/)
+echo ${variable:s_/_._}      # path.aaabcd (slightly more readable)
+echo ${variable:s/a/A/}      # pAth/aaabcd (only first A is replaced)
+echo ${variable:gs/a/A/}     # pAth/AAAbcd (all A is replaced)
+
+# Split the file name at each underscore
+echo ${(s._.)file}
+
+# Join expansion flag, opposite of the split flag.
+array=(a b c d)
+echo ${(j.-.)array} # a-b-c-d

cheat/utils.py

@@ -13,14 +13,23 @@ def colorize(sheet_content):
 
     try:
         from pygments import highlight
-        from pygments.lexers import BashLexer
+        from pygments.lexers import get_lexer_by_name
         from pygments.formatters import TerminalFormatter
 
     # if pygments can't load, just return the uncolorized text
     except ImportError:
         return sheet_content
 
-    return highlight(sheet_content, BashLexer(), TerminalFormatter())
+    first_line = sheet_content.splitlines()[0]
+    lexer      = get_lexer_by_name('bash')
+    if first_line.startswith('```'):
+        sheet_content = '\n'.join(sheet_content.split('\n')[1:-2])
+        try:
+            lexer = get_lexer_by_name(first_line[3:])
+        except Exception:
+            pass
+
+    return highlight(sheet_content, lexer, TerminalFormatter())
 
 
 def die(message):

setup.py

@@ -3,7 +3,7 @@ import os
 
 setup(
     name         = 'cheat',
-    version      = '2.1.27',
+    version      = '2.2.1',
     author       = 'Chris Lane',
     author_email = 'chris@chris-allen-lane.com',
     license      = 'GPL3',