Version bump

Update cheat ssh

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+Contributing
+============
+If you would like to contribute cheetsheets or program functionality, please
+fork this repository, make your changes, and send me a pull request.
+
+Python code show follow the standards laid out by [PEP 8][].
+
+
+[PEP 8]: http://legacy.python.org/dev/peps/pep-0008/ 

README.md

@@ -9,6 +9,10 @@ remember.
 
 `cheat` depends only on `python` and `pip`.
 
+PyPI status:
+
+[![Latest Version](https://pypip.in/version/cheat/badge.png)](https://pypi.python.org/pypi/cheat/)
+[![Downloads](https://pypip.in/download/cheat/badge.png)](https://pypi.python.org/pypi/cheat/)
 
 Example
 -------
@@ -45,6 +49,17 @@ to store notes on your favorite cookie recipes, feel free.
 
 Installing
 ----------
+    
+### Using pip ###
+
+    sudo pip install cheat
+
+### Using homebrew ###
+
+    brew install cheat
+    
+### Manually ###
+
 First install the required python dependencies with:
 
     sudo pip install docopt pygments
@@ -104,6 +119,13 @@ enable this feature, set a `CHEATCOLORS` environment variable:
 
     export CHEATCOLORS=true
 
+### Enabling Command-line Autocompletion ###
+The `cheat/autocompletion` directory contains scripts to enable command-line
+autocompletion for various shells. To activate autocompletion, simply copy the
+appropriate script to the appropriate path on your system. (The "appropriate
+path" will vary on a per-platform basis, so this documentation shall not
+speculate as to where that may be.)
+
 
 Related Projects
 ----------------
@@ -119,6 +141,8 @@ Related Projects
 - [`cheat` RubyGem][3]: A clever gem from 2006 that clearly had similar
   motivations. It is unclear whether or not it is currently maintained.
 
+- [`tldr`][tldr]: "Simplified and community-driven man pages".
+
 
 [dotfiles]:  http://dotfiles.github.io/
 [jahendrie]: https://github.com/jahendrie
@@ -126,3 +150,4 @@ Related Projects
 [2]:         https://github.com/jahendrie/cheat
 [3]:         http://errtheblog.com/posts/21-cheat
 [4]:         https://github.com/chrisallenlane/cheat/pull/77
+[tldr]:      https://github.com/tldr-pages/tldr

bin/cheat

@@ -38,7 +38,7 @@ from docopt import docopt
 
 if __name__ == '__main__':
     # parse the command-line options
-    options = docopt(__doc__, version='cheat 2.0.3')
+    options = docopt(__doc__, version='cheat 2.1.2')
 
     # list directories
     if options['--directories']:

cheat/__init__.py

@@ -1,3 +1,3 @@
-import sheet
-import sheets
-import utils
+from . import sheet
+from . import sheets
+from . import utils

cheat/cheatsheets/apt-get

@@ -4,7 +4,7 @@
 apt-get update
 
 # To download and install updates without installing new package.
-apt-get update
+apt-get upgrade
 
 # To download and install the updates AND install new necessary packages
 apt-get dist-upgrade

cheat/cheatsheets/bash

@@ -1,5 +1,5 @@
 # To implement a for loop:
-for file in `ls .`;
+for file in *;
 do 
     echo $file found;
 done
@@ -12,3 +12,9 @@ in
     2) echo "two found";;
     3*) echo "something beginning with 3 found";;
 esac
+
+# Turn on debugging:
+set -x
+
+# Turn off debugging:
+set +x

cheat/cheatsheets/docker

@@ -0,0 +1,26 @@
+# Start docker daemon
+docker -d
+
+# start a container with an interactive shell
+docker run -ti <image_name> /bin/bash
+
+# inspect a running container
+docker inspect <container_name> (or <container_id>)
+
+# Get the process ID for a container
+# Source: https://github.com/jpetazzo/nsenter
+docker inspect --format {{.State.Pid}} <container_name_or_ID>
+
+# List the current mounted volumes for a container (and pretty print)
+# Source:
+# http://nathanleclaire.com/blog/2014/07/12/10-docker-tips-and-tricks-that-will-make-you-sing-a-whale-song-of-joy/
+docker inspect --format='{{json .Volumes}}' <container_id> | python -mjson.tool
+
+# list currently running containers
+docker ps
+
+# list all containers
+docker ps -a
+
+# list all images
+docker images

cheat/cheatsheets/du

@@ -0,0 +1,2 @@
+# To sort directories/files by size
+du -sk *| sort -rn

cheat/cheatsheets/find

@@ -20,10 +20,10 @@ find ./path/ -name '*.txt' -exec rm '{}' \;
 find ./path/ -name '*.txt' | xargs grep 'string'
 
 # To find files with size bigger than 5 Mb and sort them by size:
-find ./ -size +5M -type f -print0 | xargs -0 ls -Ssh
+find . -size +5M -type f -print0 | xargs -0 ls -Ssh | sort -z
 
 # To find files bigger thank 2 MB and list them:
-find / -type f -size +20000k -exec ls -lh {} \; | awk '{ print $9 ": " $5 }'
+find . -type f -size +20000k -exec ls -lh {} \; | awk '{ print $9 ": " $5 }'
 
 # To find files modified more than 7 days ago and list file information
 find . -type f -mtime +7d -ls
@@ -41,4 +41,4 @@ find . -maxdepth 2 -name build -type d
 find . ! -iwholename '*.git*' -type f
 
 # Find all files that have the same node (hard link) as MY_FILE_HERE
-find / -type f -samefile MY_FILE_HERE 2>/dev/null
+find . -type f -samefile MY_FILE_HERE 2>/dev/null

cheat/cheatsheets/grep

@@ -24,3 +24,6 @@ grep -rnw 'directory' -e "pattern"
 # Exclude grep from your grepped output of ps.
 # Add [] to the first letter. Ex: sshd -> [s]shd
 ps aux | grep '[h]ttpd'
+
+# Colour in red {bash} and keep all other lines
+ps aux | grep -E --color 'bash|$'

cheat/cheatsheets/hub

@@ -0,0 +1,74 @@
+As a contributor to open-source
+-------------------------------
+
+# clone your own project
+$ git clone dotfiles
+→ git clone git://github.com/YOUR_USER/dotfiles.git
+
+# clone another project
+$ git clone github/hub
+→ git clone git://github.com/github/hub.git
+
+# see the current project's issues
+$ git browse -- issues
+→ open https://github.com/github/hub/issues
+
+# open another project's wiki
+$ git browse mojombo/jekyll wiki
+→ open https://github.com/mojombo/jekyll/wiki
+
+## Example workflow for contributing to a project:
+$ git clone github/hub
+$ cd hub
+# create a topic branch
+$ git checkout -b feature
+→ ( making changes ... )
+$ git commit -m "done with feature"
+# It's time to fork the repo!
+$ git fork
+→ (forking repo on GitHub...)
+→ git remote add YOUR_USER git://github.com/YOUR_USER/hub.git
+# push the changes to your new remote
+$ git push YOUR_USER feature
+# open a pull request for the topic branch you've just pushed
+$ git pull-request
+→ (opens a text editor for your pull request message)
+
+
+As an open-source maintainer
+----------------------------
+
+# fetch from multiple trusted forks, even if they don't yet exist as remotes
+$ git fetch mislav,cehoffman
+→ git remote add mislav git://github.com/mislav/hub.git
+→ git remote add cehoffman git://github.com/cehoffman/hub.git
+→ git fetch --multiple mislav cehoffman
+
+# check out a pull request for review
+$ git checkout https://github.com/github/hub/pull/134
+→ (creates a new branch with the contents of the pull request)
+
+# directly apply all commits from a pull request to the current branch
+$ git am -3 https://github.com/github/hub/pull/134
+
+# cherry-pick a GitHub URL
+$ git cherry-pick https://github.com/xoebus/hub/commit/177eeb8
+→ git remote add xoebus git://github.com/xoebus/hub.git
+→ git fetch xoebus
+→ git cherry-pick 177eeb8
+
+# `am` can be better than cherry-pick since it doesn't create a remote
+$ git am https://github.com/xoebus/hub/commit/177eeb8
+
+# open the GitHub compare view between two releases
+$ git compare v0.9..v1.0
+
+# put compare URL for a topic branch to clipboard
+$ git compare -u feature | pbcopy
+
+# create a repo for a new project
+$ git init
+$ git add . && git commit -m "It begins."
+$ git create -d "My new thing"
+→ (creates a new project on GitHub with the name of current directory)
+$ git push origin master

cheat/cheatsheets/ip

@@ -0,0 +1,32 @@
+# Display all interfaces with addresses
+ip addr
+
+# Take down / up the wireless adapter
+ip link set dev wlan0 {up|down}
+
+# Set a static IP and netmask
+ip addr add 192.168.1.100/32 dev eth0
+
+# Remove a IP from an interface
+ip addr del 192.168.1.100/32 dev eth0
+
+# Remove all IPs from an interface
+ip address flush dev eth0
+
+# Display all routes
+ip route
+
+# Display all routes for IPv6
+ip -6 route
+
+# Add route via gateway IP
+ip route add 192.168.0.0/24 via 192.168.1.1
+
+# Add route via interface
+ip route add 192.168.0.0/24 dev eth0
+
+# Change your mac address 
+ip link set dev eth0 address aa:bb:cc:dd:ee:ff
+
+# View neighbors (using ARP and NDP) 
+ip neighbor show

cheat/cheatsheets/lvm

@@ -0,0 +1,7 @@
+#Exclusive Activation of a Volume Group in a Cluster 
+#Link --> https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/High_Availability_Add-On_Administration/s1-exclusiveactive-HAAA.html 
+1> vgs --noheadings -o vg_name
+2> volume_list = [ "rhel_root", "rhel_home" ]
+3> dracut -H -f /boot/initramfs-$(uname -r).img $(uname -r)
+4> Reboot the node
+5> uname -r to verify the correct initrd image

cheat/cheatsheets/mount

@@ -1,6 +1,9 @@
 # To mount / partition as read-write in repair mode:
 mount -o remount,rw /
 
+# Bind mount path to a second location
+mount --bind /origin/path /destination/path
+
 # To mount Usb disk as user writable:
 mount -o uid=username,gid=usergroup /dev/sdx /mnt/xxx
 

cheat/cheatsheets/nc

@@ -0,0 +1,20 @@
+# To open a TCP connection to port 42 of host.example.com, using port 31337 as the source port, with a timeout of 5 seconds:
+nc -p 31337 -w 5 host.example.com 42
+
+# To open a UDP connection to port 53 of host.example.com:
+nc -u host.example.com 53
+
+# To open a TCP connection to port 42 of host.example.com using 10.1.2.3 as the IP for the local end of the connection:
+nc -s 10.1.2.3 host.example.com 42
+
+# To create and listen on a UNIX-domain stream socket:
+nc -lU /var/tmp/dsocket
+
+# To connect to port 42 of host.example.com via an HTTP proxy at 10.2.3.4, port 8080. This example could also be used by ssh(1); see the ProxyCommand directive in ssh_config(5) for more information.
+nc -x10.2.3.4:8080 -Xconnect host.example.com 42
+
+# The same example again, this time enabling proxy authentication with username "ruser" if the proxy requires it:
+nc -x10.2.3.4:8080 -Xconnect -Pruser host.example.com 42
+
+# To choose the source IP for the testing using the -s option
+nc -zv -s source_IP target_IP Port

cheat/cheatsheets/nmap

@@ -23,13 +23,15 @@ nmap -source-port [port] [target]
 nmap -A [target]
 
 # Speedup your scan:
-nmap -T5 --min-parallelism=50 [target]
+# -n => disable ReverseDNS
+# --min-rate=X => min X packets / sec
+nmap -T5 --min-parallelism=50 -n --min-rate=300 [target]
 
 # Traceroute:
 nmap -traceroute [target]
 
 # Ping scan only: -sP
-# Don't ping:     -PN
+# Don't ping:     -PN <- Use full if a host don't reply to a ping.
 # TCP SYN ping:   -PS
 # TCP ACK ping:   -PA
 # UDP ping:       -PU
@@ -38,6 +40,9 @@ nmap -traceroute [target]
 # Example: Ping scan all machines on a class C network
 nmap -sP 192.168.0.0/24
 
+# Force TCP scan: -sT
+# Force UDP scan: -sU
+
 # Use some script:
 nmap --script default,safe
 
@@ -55,3 +60,10 @@ nmap --script "default and safe"
 
 # Loads scripts in the default, safe, or intrusive categories, except for those whose names start with http-.
 nmap --script "(default or safe or intrusive) and not http-*"
+
+# Scan for the heartbleed
+# -pT:443 => Scan only port 443 with TCP (T:)
+nmap -T5 --min-parallelism=50 -n --script "ssl-heartbleed" -pT:443 127.0.0.1
+
+# Show all informations (debug mode)
+nmap -d ...

cheat/cheatsheets/ping6

@@ -0,0 +1,2 @@
+# get all ipv6 neighbors via broadcast ping
+ping6 -I eth0 ff02::1

cheat/cheatsheets/readline

@@ -0,0 +1,49 @@
+    Moving around
+Ctrl-b      Move the cursor             one character               ⇦ to the left
+Ctrl-f      Move the cursor             one character               ⇨ to the right
+Alt-b       Move the cursor             one word                    ⇦ to the left
+Alt-f       Move the cursor             one word                    ⇨ to the right
+Ctrl-a      Move the cursor                                         ⇤ to the start of the line
+Ctrl-e      Move the cursor                                         ⇥ to the end of the line
+Ctrl-x-x    Move the cursor                                         ⇤⇥ to the start, and to the end again
+
+    Cut, copy and paste
+Backspace   Delete                      the character               ⇦ to the left of the cursor
+DEL
+Ctrl-d      Delete                      the character               underneath the cursor
+Ctrl-u      Delete                      everything                  ⇤ from the cursor back to the line start
+Ctrl-k      Delete                      everything                  ⇥ from the cursor to the end of the line
+Alt-d       Delete                      word                        ⇨ until before the next word boundary
+Ctrl-w      Delete                      word                        ⇦ until after the previous word boundary
+Ctrl-y      Yank/Paste                  prev. killed text           at the cursor position
+Alt-y       Yank/Paste                  prev. prev. killed text     at the cursor position
+
+    History
+Ctrl-p      Move in history             one line                    ⇧ before this line
+Ctrl-n      Move in history             one line                    ⇩ after this line
+Alt->       Move in history             all the lines               ⇩ to the line currently being entered
+Ctrl-r      Incrementally search        the line history            ⇧ backwardly
+Ctrl-s      Incrementally search        the line history            ⇩ forwardly
+Ctrl-J      End an incremental search
+Ctrl-G      Abort an incremental search and restore the original line
+Alt-Ctrl-y  Yank/Paste                  arg. 1 of prev. cmnd        at the cursor position
+Alt-.
+Alt-_       Yank/Paste                  last arg of prev. cmnd      at the cursor position
+
+    Undo
+Ctrl-_
+Ctrl-x
+Ctrl-u      Undo the last editing command; you can undo all the way back to an empty line
+Alt-r       Undo all changes made to this line
+Ctrl-l      Clear the screen, reprinting the current line at the top
+Ctrl-l      Clear the screen, reprinting the current line at the top
+
+    Completion
+TAB         Auto-complete a name
+Alt-/       Auto-complete a name (without smart completion)
+Alt-?       List the possible completions of the preceeding text
+Alt-*       Insert all possible completions of the preceeding text
+
+    Transpose
+Ctrl-t      Transpose/drag              char. before the cursor     ↷ over the character at the cursor
+Alt-t       Transpose/drag              word before the cursor      ↷ over the word at/after the cursor

cheat/cheatsheets/rm

@@ -3,3 +3,6 @@ rm -rf path/to/the/target/
 
 # Ignore non existent files
 rm -f path/to/the/target
+
+# Remove a file with his inode
+find /tmp/ -inum 6666 -exec rm -i '{}' \;

cheat/cheatsheets/route

@@ -0,0 +1,29 @@
+# To display routing table IP addresses instead of host names:
+route -n
+
+# To add a default gateway:
+route add default gateway 192.168.0.1
+
+# To add the normal loopback entry, using netmask 255.0.0.0 and associated with the "lo" device (assuming this device was previously set up correctly with ifconfig(8)).
+route add -net 127.0.0.0 netmask 255.0.0.0 dev lo
+
+# To add a route to the local network 192.56.76.x via "eth0".  The word "dev" can be omitted here.
+route add -net 192.56.76.0 netmask 255.255.255.0 dev eth0
+
+# To delete the current default route, which is labeled "default" or 0.0.0.0 in the destination field of the current routing table.
+route del default
+
+# To add a default  route (which will be used if no other route matches).  All packets using this route will be gatewayed through "mango-gw". The device which will actually be used for that route depends on how we can reach "mango-gw" - the static route to "mango-gw" will have to be set up before.
+route add default gw mango-gw
+
+# To add the route to the "ipx4" host via the SLIP interface (assuming that "ipx4" is the SLIP host).
+route add ipx4 sl0
+
+# To add the net "192.57.66.x" to be gateway through the former route to the SLIP interface.
+route add -net 192.57.66.0 netmask 255.255.255.0 gw ipx4
+
+# To install a rejecting route for the private network "10.x.x.x."
+route add -net 10.0.0.0 netmask 255.0.0.0 reject
+
+# This is an obscure one documented so people know how to do it. This sets all of the class D (multicast) IP routes to go via "eth0". This is the correct normal configuration line with a multicasting kernel
+route add -net 224.0.0.0 netmask 240.0.0.0 dev eth0

cheat/cheatsheets/rpm

@@ -0,0 +1,14 @@
+# To install a package:
+rpm -ivh <rpm>
+
+# To remove a package:
+rpm -e <package>
+
+# To find what package installs a file:
+rpm -qf </path/to/file>
+
+# To find what files are installed by a package:
+rpm -qpl <rpm>
+
+# To list all installed packages:
+rpm -qa

cheat/cheatsheets/rsync

@@ -1,6 +1,14 @@
-# copy files from remote to local, maintaining file propertires and sym-links (-a), zipping for faster transfer (-z), verbose (-v).  
+# To copy files from remote to local, maintaining file properties and sym-links (-a), zipping for faster transfer (-z), verbose (-v).  
 rsync -avz host:file1 :file1 /dest/
 rsync -avz /source host:/dest
 
-# Copy files using checksum (-c), rather than time, to detect if the file has changed. (Useful for validating backups). 
+# Copy files using checksum (-c) rather than time to detect if the file has changed. (Useful for validating backups). 
 rsync -avc /source/ /dest/
+
+# Copy contents of /src/foo to destination:
+
+# This command will create /dest/foo if it does not already exist
+rsync -auv /src/foo /dest
+
+# Explicitly copy /src/foo to /dest/foo
+rsync -auv /src/foo/ /dest/foo

cheat/cheatsheets/sed

@@ -10,5 +10,8 @@ echo 'It is daytime' | sed 's/day/night/g'
 # To remove leading spaces
 sed -i -r 's/^\s+//g' file.txt
 
-# Remove empty lines and print results to stdout:
+# To remove empty lines and print results to stdout:
 sed '/^$/d' file.txt
+
+# To replace newlines in multiple lines
+sed ':a;N;$!ba;s/\n//g'  file.txt

cheat/cheatsheets/smbclient

@@ -0,0 +1,5 @@
+# To display public shares on the server:
+smbclient -L <hostname> -U%
+
+# To connect to a share:
+smbclient //<hostname>/<share> -U<username>%<password>

cheat/cheatsheets/snmpwalk

@@ -0,0 +1,5 @@
+# To retrieve all of the variables under system for host zeus
+snmpwalk -Os -c public -v 1 zeus system
+
+# To retrieve the scalar values, but omit the sysORTable for host zeus
+snmpwalk -Os -c public -v 1 -CE sysORTable zeus system

cheat/cheatsheets/ss

@@ -0,0 +1,18 @@
+ss
+Utility to investigate sockets
+
+Args
+-4/-6 list ipv4/ipv6 sockets
+-n numeric addresses instead of hostnames
+-l list listing sockets
+-u/-t/-x list udp/tcp/unix sockets
+-p Show process(es) that using socket
+
+# show all listing tcp sockets including the corresponding process
+ss -tlp
+
+# show all sockets connecting to 192.168.2.1 on port 80
+ss -t dst 192.168.2.1:80
+
+# show all ssh related connection
+ss -t state established '( dport = :ssh or sport = :ssh )'

cheat/cheatsheets/ssh

@@ -4,6 +4,9 @@ ssh -i /path/to/file.pem user@example.com
 # To connect on an non-standard port:
 ssh -p 2222 user@example.com
 
+# To connect and forward the authentication agent
+ssh -A user@example.com
+
 # To execute a command on a remote server:
 ssh -t user@example.com 'the-remote-command'
 

cheat/cheatsheets/tee

@@ -0,0 +1,5 @@
+# To tee stdout to a file:
+ls | tee outfile.txt
+
+# To tee stdout and append to a file:
+ls | tee -a outfile.txt

cheat/cheatsheets/wget

@@ -30,3 +30,6 @@ wget -r -l1 -A.extension http://myserver.com/directory
 
 # Allows you to download just the headers of responses (-S --spider) and display them on Stdout (-O -).
 wget -S --spider -O - http://google.com
+
+# Change the User-Agent to 'User-Agent: toto'
+wget -U 'toto' http://google.com

cheat/sheets.py

@@ -2,16 +2,16 @@ from cheat import cheatsheets
 from cheat.utils import *
 import os
 
+# @kludge: it breaks the functional paradigm to a degree, but declaring this
+# var here (versus within get()) gives us a "poor man's" memoization on the
+# call to get(). This, in turn, spares us from having to call out to the
+# filesystem more than once.
+cheats = {}
+
 
 def default_path():
     """ Returns the default cheatsheet path """
 
-    # the default path becomes confused when cheat is run as root, so fail
-    # under those circumstances. (There is no good reason to need to run cheat
-    # as root.)
-    if os.name != 'nt' and os.geteuid() == 0:
-        die('Please do not run this application as root.');
-
     # determine the default cheatsheet dir
     default_sheets_dir = os.environ.get('DEFAULT_CHEAT_DIR') or os.path.join(os.path.expanduser('~'), '.cheat')
 
@@ -35,10 +35,15 @@ def default_path():
     return default_sheets_dir
 
 
-# @todo: memoize result
 def get():
     """ Assembles a dictionary of cheatsheets as name => file-path """
-    cheats = {}
+
+    # if we've already reached out to the filesystem, just return the result
+    # from memory
+    if cheats:
+        return cheats
+
+    # otherwise, scan the filesystem
     for cheat_dir in reversed(paths()):
         cheats.update(
             dict([

cheat/utils.py

@@ -1,3 +1,4 @@
+from __future__ import print_function
 import os
 import sys
 
@@ -23,7 +24,7 @@ def colorize(sheet_content):
 
 def die(message):
     """ Prints a message to stderr and then terminates """
-    warn (message)
+    warn(message)
     exit(1)
 
 
@@ -47,10 +48,18 @@ def editor():
 
 def prompt_yes_or_no(question):
     """ Prompts the user with a yes-or-no question """
+    # Support Python 2 and 3 input
+    # Default to Python 2's input()
+    get_input = raw_input
+ 
+    # If this is Python 3, use input()
+    if sys.version_info[:2] >= (3, 0):
+        get_input = input
+
     print(question)
-    return raw_input('[y/n] ') == 'y'
+    return get_input('[y/n] ') == 'y'
 
 
 def warn(message):
     """ Prints a message to stderr """
-    print >> sys.stderr, (message)
+    print((message), file=sys.stderr)

setup.py

@@ -1,18 +1,9 @@
 from distutils.core import setup
 import os
 
-data = [
-       ('/usr/share/zsh/site-functions', ['cheat/autocompletion/_cheat.zsh']),
-       ('/etc/bash_completion.d'       , ['cheat/autocompletion/cheat.bash']),
-       ('/usr/share/fish/completions'  , ['cheat/autocompletion/cheat.fish'])
-       ]
-
-if os.name == 'nt':
-    data = []
-
 setup(
     name         = 'cheat',
-    version      = '2.0.3',
+    version      = '2.1.2',
     author       = 'Chris Lane',
     author_email = 'chris@chris-allen-lane.com',
     license      = 'GPL3',
@@ -30,7 +21,6 @@ setup(
         'cheat.cheatsheets': [f for f in os.listdir('cheat/cheatsheets') if '.' not in f]
     },
     scripts          = ['bin/cheat'],
-    data_files   = data,
     install_requires = [
         'docopt >= 0.6.1',
         'pygments >= 1.6.0',