merge with master

This commit is contained in:
Brutus 2015-12-02 12:52:41 +01:00
commit eac69c6f6b
76 changed files with 1062 additions and 101 deletions

3
.gitignore vendored
View File

@ -1,2 +1,5 @@
*.pyc *.pyc
MANIFEST
build build
cheat.egg-info
dist

View File

@ -9,6 +9,10 @@ remember.
`cheat` depends only on `python` and `pip`. `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 Example
------- -------
@ -45,6 +49,17 @@ to store notes on your favorite cookie recipes, feel free.
Installing Installing
---------- ----------
### Using pip ###
sudo pip install cheat
### Using homebrew ###
brew install cheat
### Manually ###
First install the required python dependencies with: First install the required python dependencies with:
sudo pip install docopt pygments sudo pip install docopt pygments
@ -126,6 +141,8 @@ Related Projects
- [`cheat` RubyGem][3]: A clever gem from 2006 that clearly had similar - [`cheat` RubyGem][3]: A clever gem from 2006 that clearly had similar
motivations. It is unclear whether or not it is currently maintained. motivations. It is unclear whether or not it is currently maintained.
- [`tldr`][tldr]: "Simplified and community-driven man pages".
[dotfiles]: http://dotfiles.github.io/ [dotfiles]: http://dotfiles.github.io/
[jahendrie]: https://github.com/jahendrie [jahendrie]: https://github.com/jahendrie
@ -133,3 +150,4 @@ Related Projects
[2]: https://github.com/jahendrie/cheat [2]: https://github.com/jahendrie/cheat
[3]: http://errtheblog.com/posts/21-cheat [3]: http://errtheblog.com/posts/21-cheat
[4]: https://github.com/chrisallenlane/cheat/pull/77 [4]: https://github.com/chrisallenlane/cheat/pull/77
[tldr]: https://github.com/tldr-pages/tldr

View File

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

23
cheat/cheatsheets/apt Normal file
View File

@ -0,0 +1,23 @@
# To search a package:
apt search package
# To show package informations:
apt show package
# To fetch package list:
apt update
# To download and install updates without installing new package:
apt upgrade
# To download and install the updates AND install new necessary packages:
apt dist-upgrade
# Full command:
apt update && apt dist-upgrade
# To install a new package(s):
apt install package(s)
# To uninstall package(s)
apt remove package(s)

View File

@ -4,7 +4,7 @@
apt-get update apt-get update
# To download and install updates without installing new package. # 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 # To download and install the updates AND install new necessary packages
apt-get dist-upgrade apt-get dist-upgrade
@ -23,3 +23,6 @@ apt-get -o Dir::Cache="/path/to/destination/dir/" -o Dir::Cache::archives="./" i
# Show apt-get installed packages. # Show apt-get installed packages.
grep 'install ' /var/log/dpkg.log grep 'install ' /var/log/dpkg.log
# Silently keep old configuration during batch updates
apt-get update -o DPkg::Options::='--force-confold' ...

View File

@ -1,2 +1,11 @@
# sum integers from a file or stdin, one integer per line: # sum integers from a file or stdin, one integer per line:
printf '1\n2\n3\n' | awk '{ sum += $1} END {print sum}' printf '1\n2\n3\n' | awk '{ sum += $1} END {print sum}'
# using specific character as separator to sum integers from a file or stdin
printf '1:2:3' | awk -F ":" '{print $1+$2+$3}'
# print a multiplication table
seq 9 | sed 'H;g' | awk -v RS='' '{for(i=1;i<=NF;i++)printf("%dx%d=%d%s", i, NR, i*NR, i==NR?"\n":"\t")}'
# Specify output separator character
printf '1 2 3' | awk 'BEGIN {OFS=":"}; {print $1,$2,$3}'

View File

@ -1,5 +1,5 @@
# To implement a for loop: # To implement a for loop:
for file in `ls .`; for file in *;
do do
echo $file found; echo $file found;
done done
@ -12,3 +12,16 @@ in
2) echo "two found";; 2) echo "two found";;
3*) echo "something beginning with 3 found";; 3*) echo "something beginning with 3 found";;
esac esac
# Turn on debugging:
set -x
# Turn off debugging:
set +x
# Retrieve N-th piped command exit status
printf 'foo' | fgrep 'foo' | sed 's/foo/bar/'
echo ${PIPESTATUS[0]} # replace 0 with N
# Lock file:
( set -o noclobber; echo > my.lock ) || echo 'Failed to create lock file'

26
cheat/cheatsheets/bower Normal file
View File

@ -0,0 +1,26 @@
# Install a package locally
bower install <package-name>
# Install a package locally directly from github
bower install <user>/<repo>
# Install a specific package locally
bower install <package-name>#<version>
# Install a package locally and save installed package into bower.json
bower install <package-name> --save
# Retrieve info of a particular package
bower info <package-name>
# List local packages
bower list
# Search for a package by name
bower search <package-name>
# Update a package to their newest version
bower update <package-name>
# Remove a local package
bower uninstall <package-name>

5
cheat/cheatsheets/csplit Normal file
View File

@ -0,0 +1,5 @@
# Split a file based on pattern
csplit input.file '/PATTERN/'
# Use prefix/suffix to improve resulting file names
csplit -f 'prefix-' -b '%d.extension' input.file '/PATTERN/' '{*}'

22
cheat/cheatsheets/cups Normal file
View File

@ -0,0 +1,22 @@
# Manage printers through CUPS:
http://localhost:631 (in web browser)
# Print file from command line
lp myfile.txt
# Display print queue
lpq
# Remove print job from queue
lprm 545
or
lprm -
# Print log location
/var/log/cups
# Reject new jobs
cupsreject printername
# Accept new jobs
cupsaccept printername

View File

@ -1,2 +1,5 @@
# Printout date in format suitable for affixing to file names # Print date in format suitable for affixing to file names
date +"%Y%m%d_%H%M%S" date +"%Y%m%d_%H%M%S"
# Convert Unix timestamp to Date
date -d @1440359821

16
cheat/cheatsheets/dnf Normal file
View File

@ -0,0 +1,16 @@
# To install the latest version of a package:
dnf install <package name>
# To search package details for the given string
dnf search <string>
# To find which package provides a binary
dnf provides <path to binary>
# The following are available after installing "dnf-plugins-core"
# Download a package
dnf download <package name>
# install the build dependencies for a SRPM or from a .spec file
dnf builddep <srpm/.spec file>

32
cheat/cheatsheets/docker Normal file
View File

@ -0,0 +1,32 @@
# Start docker daemon
docker -d
# start a container with an interactive shell
docker run -ti <image_name> /bin/bash
# "shell" into a running container (docker-1.3+)
docker exec -ti <container_name> 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
# Copy files/folders between a container and your host
docker cp foo.txt mycontainer:/foo.txt
# list currently running containers
docker ps
# list all containers
docker ps -a
# list all images
docker images

11
cheat/cheatsheets/dpkg Normal file
View File

@ -0,0 +1,11 @@
# Install the package or upgrade it
dpkg -i test.deb
# Remove a package including configuration files
dpkg -P test.deb
# List all installed packages with versions and details
dpkg -I
# Find out if a Debian package is installed or not
dpkg -s test.deb | grep Status

5
cheat/cheatsheets/du Normal file
View File

@ -0,0 +1,5 @@
# To sort directories/files by size
du -sk *| sort -rn
# To show cumulative humanreadable size
du -sh

12
cheat/cheatsheets/ffmpeg Normal file
View File

@ -0,0 +1,12 @@
# Print file metadata etc.
ffmpeg -i path/to/file.ext
# Convert all m4a files to mp3
for f in *.m4a; do ffmpeg -i "$f" -acodec libmp3lame -ab 320k "${f%.m4a}.mp3"; done
# Listen to 10 seconds of audio from a video file
#
# -ss : start time
# -t : seconds to cut
# -autoexit : closes ffplay as soon as the audio finishes
ffmpeg -ss 00:34:24.85 -t 10 -i path/to/file.mp4 -f mp3 pipe:play | ffplay -i pipe:play -autoexit

View File

@ -20,10 +20,10 @@ find ./path/ -name '*.txt' -exec rm '{}' \;
find ./path/ -name '*.txt' | xargs grep 'string' find ./path/ -name '*.txt' | xargs grep 'string'
# To find files with size bigger than 5 Mb and sort them by size: # 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: # 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 # To find files modified more than 7 days ago and list file information
find . -type f -mtime +7d -ls find . -type f -mtime +7d -ls
@ -41,4 +41,4 @@ find . -maxdepth 2 -name build -type d
find . ! -iwholename '*.git*' -type f find . ! -iwholename '*.git*' -type f
# Find all files that have the same node (hard link) as MY_FILE_HERE # 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

View File

@ -1,4 +1,4 @@
# To set your identify: # To set your identity:
git config --global user.name "John Doe" git config --global user.name "John Doe"
git config --global user.email johndoe@example.com git config --global user.email johndoe@example.com
@ -17,9 +17,25 @@ git commit -m "Your commit message"
# To edit previous commit message # To edit previous commit message
git commit --amend git commit --amend
# Git commit in the past
git commit --date="`date --date='2 day ago'`"
git commit --date="Jun 13 18:30:25 IST 2015"
# more recent versions of Git also support --date="2 days ago" directly
# To change the date of an existing commit
git filter-branch --env-filter \
'if [ $GIT_COMMIT = 119f9ecf58069b265ab22f1f97d2b648faf932e0 ]
then
export GIT_AUTHOR_DATE="Fri Jan 2 21:38:53 2009 -0800"
export GIT_COMMITTER_DATE="Sat May 19 01:01:01 2007 -0700"
fi'
# To removed staged and working directory changes # To removed staged and working directory changes
git reset --hard git reset --hard
# To go 2 commits back
git reset --hard HEAD~2
# To remove untracked files # To remove untracked files
git clean -f -d git clean -f -d
@ -35,6 +51,9 @@ git push git@github.com:username/project.git
# To delete the branch "branch_name" # To delete the branch "branch_name"
git branch -D branch_name git branch -D branch_name
# To make an exisiting branch track a remote branch
git branch -u upstream/foo
# To see who commited which line in a file # To see who commited which line in a file
git blame filename git blame filename
@ -51,3 +70,37 @@ git show 83fb499:path/fo/file.ext # Shows the file as it a
git diff branch_1 branch_2 # Check difference between branches git diff branch_1 branch_2 # Check difference between branches
git log # Show all the commits git log # Show all the commits
git status # Show the changes from last commit git status # Show the changes from last commit
# Commit history of a set of files
git log --pretty=email --patch-with-stat --reverse --full-index -- Admin\*.py > Sripts.patch
# Import commits from another repo
git --git-dir=../some_other_repo/.git format-patch -k -1 --stdout <commit SHA> | git am -3 -k
# View commits that will be pushed
git log @{u}..
# View changes that are new on a feature branch
git log -p feature --not master
git diff master...feature
# Interactive rebase for the last 7 commits
git rebase -i @~7
# Diff files WITHOUT considering them a part of git
# This can be used to diff files that are not in a git repo!
git diff --no-index path/to/file/A path/to/file/B
# To pull changes while overwriting any local commits
git fetch --all
git reset --hard origin/master
# Update all your submodules
git submodule update --init --recursive
# Perform a shallow clone to only get latest commits
# (helps save data when cloning large repos)
git clone --depth 1 <remote-url>
# To unshallow a clone
git pull --unshallow

View File

@ -1,13 +1,13 @@
# Basic: # Search a file for a pattern
grep pattern file grep pattern file
# case nonsensitive research: # Case insensitive search (with line numbers)
grep -i pattern file grep -in pattern file
# Recursively grep for string <pattern> in folder: # Recursively grep for string <pattern> in folder:
grep -R pattern folder grep -R pattern folder
# Getting pattern from file (one by line): # Read search patterns from a file (one per line)
grep -f pattern_file file grep -f pattern_file file
# Find lines NOT containing pattern # Find lines NOT containing pattern
@ -17,10 +17,13 @@ grep -v pattern file
grep "^00" file #Match lines starting with 00 grep "^00" file #Match lines starting with 00
grep -E "[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}" file #Find IP add grep -E "[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}" file #Find IP add
# Find all files who contain {pattern} in the directory {directory}. # Find all files which match {pattern} in {directory}
# This will show: "file:line my research" # This will show: "file:line my research"
grep -rnw 'directory' -e "pattern" grep -rnw 'directory' -e "pattern"
# Exclude grep from your grepped output of ps. # Exclude grep from your grepped output of ps.
# Add [] to the first letter. Ex: sshd -> [s]shd # Add [] to the first letter. Ex: sshd -> [s]shd
ps aux | grep '[h]ttpd' ps aux | grep '[h]ttpd'
# Colour in red {bash} and keep all other lines
ps aux | grep -E --color 'bash|$'

17
cheat/cheatsheets/gzip Normal file
View File

@ -0,0 +1,17 @@
# To create a *.gz compressed file
gzip test.txt
# To create a *.gz compressed file to a specific location using -c option (standard out)
gzip -c test.txt > test_custom.txt.gz
# To uncompress a *.gz file
gzip -d test.txt.gz
# Display compression ratio of the compressed file using gzip -l
gzip -l *.gz
# Recursively compress all the files under a specified directory
gzip -r documents_directory
# To create a *.gz compressed file and keep the original
gzip < test.txt > test.txt.gz

View File

@ -0,0 +1,32 @@
# Display all hardware details
sudo lshw
# List currently loaded kernel modules
lsmod
# List all modules available to the system
find /lib/modules/$(uname -r) -type f -iname "*.ko"
# Load a module into kernel
modprobe modulename
# Remove a module from kernel
modprobe -r modulename
# List devices connected via pci bus
lspci
# Debug output for pci devices (hex)
lspci -vvxxx
# Display cpu hardware stats
cat /proc/cpuinfo
# Display memory hardware stats
cat /proc/meminfo
# Output the kernel ring buffer
dmesg
# Ouput kernel messages
dmesg --kernel

74
cheat/cheatsheets/hub Normal file
View File

@ -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

32
cheat/cheatsheets/ip Normal file
View File

@ -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 default route via gateway IP
ip route add default 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

View File

@ -19,3 +19,14 @@ journalctl /usr/bin/dbus-daemon
# Filter by PID # Filter by PID
journalctl _PID=123 journalctl _PID=123
# Filter by Command, e.g., sshd
journalctl _COMM=sshd
# Filter by Command and time period
journalctl _COMM=crond --since '10:00' --until '11:00'
# List all available boots
journalctl --list-boots
# Filter by specific User ID e.g., user id 1000
journalctl _UID=1000

13
cheat/cheatsheets/jq Normal file
View File

@ -0,0 +1,13 @@
# Pretty print the json
jq "." < filename.json
# Access the value at key "foo"
jq '.foo'
# Access first list item
jq '.[0]'
# Slice & Dice
jq '.[2:4]'
jq '.[:3]'
jq '.[-2:]'

25
cheat/cheatsheets/jrnl Normal file
View File

@ -0,0 +1,25 @@
# Add entry to default jrnl (from your configured text editor)
jrnl
# Add entry to default jrnl
jrnl Write entry here.
# List of tags
jrnl --tags
# Entries per tag
jrnl @tag
# Export jrnl as json
jrnl --export json
# Entries in a timeframe
jrnl -from 2009 -until may
# Add Sublime text to .jrnl_config
# Windows
"editor": "F:\\Powerpack\\Sublime\\sublime_text.exe -w"
# Linux
"editor": "/usr/bin/sublime -w"

23
cheat/cheatsheets/lib Normal file
View File

@ -0,0 +1,23 @@
# Display available libraries
ldconfig -p
# Update library resources
ldconfig
# Display libraries and file location
ldd
# Libraries available to apps in real-time
"Dynamic Libraries" (.so.)
# Libraries only available to apps when installed (imported)
"Static Libraries" (.a.)
# Standard (usual) library file location
/lib
# Sofware-accessible source for library info
/etc/ld.so.cache # (binary)
# Human-readable source for library info
/etc/ld.so.conf # (points to /etc/ld.so.conf.d)

View File

@ -1,2 +1,5 @@
# To create a symlink: # To create a symlink:
ln -s path/to/the/target/directory name-of-symlink ln -s path/to/the/target/directory name-of-symlink
# Symlink, while overwriting existing destination files
ln -sf /some/dir/exec /usr/bin/exec

View File

@ -9,3 +9,9 @@ ls -lh
# Display files, sorted by size # Display files, sorted by size
ls -S ls -S
# Display directories only
ls -d */
# Display directories only, include hidden
ls -d .*/ */

7
cheat/cheatsheets/lvm Normal file
View File

@ -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

5
cheat/cheatsheets/man Normal file
View File

@ -0,0 +1,5 @@
# Convert a man page to pdf
man -t bash | ps2pdf - bash.pdf
# View the ascii chart
man 7 ascii

View File

@ -35,6 +35,9 @@ ___
# links # links
This is [an example](http://example.com "Title") inline link. This is [an example](http://example.com "Title") inline link.
# image
![Alt Text](/path/to/file.png)
# emphasis # emphasis
*em* _em_ *em* _em_

3
cheat/cheatsheets/more Normal file
View File

@ -0,0 +1,3 @@
# To show the file start at line number 5
more +5 file

View File

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

View File

@ -12,3 +12,8 @@ CREATE DATABASE owa CHARACTER SET utf8 COLLATE utf8_general_ci;
# To add a user and give rights on the given database # To add a user and give rights on the given database
GRANT ALL PRIVILEGES ON database.* TO 'user'@'localhost'IDENTIFIED BY 'password' WITH GRANT OPTION; GRANT ALL PRIVILEGES ON database.* TO 'user'@'localhost'IDENTIFIED BY 'password' WITH GRANT OPTION;
# To list the privileges granted to the account that you are using to connect to the server. Any of the 3 statements will work.
SHOW GRANTS FOR CURRENT_USER();
SHOW GRANTS;
SHOW GRANTS FOR CURRENT_USER;

View File

@ -1,16 +1,16 @@
# To dump a database to a file (Note that your password will appear in your command history!): # To dump a database to a file (Note that your password will appear in your command history!):
mysqldump -uusername -ppassword the-database > db.sql mysqldump -uusername -ppassword the-database > db.sql
# To dump a database to a file: # To dump a database to a file:
mysqldump -uusername -p the-database > db.sql mysqldump -uusername -p the-database > db.sql
# To dump a database to a .tgz file (Note that your password will appear in your command history!): # To dump a database to a .tgz file (Note that your password will appear in your command history!):
mysqldump -uusername -ppassword the-database | gzip -9 > db.sql mysqldump -uusername -ppassword the-database | gzip -9 > db.sql
# To dump a database to a .tgz file: # To dump a database to a .tgz file:
mysqldump -uusername -p the-database | gzip -9 > db.sql mysqldump -uusername -p the-database | gzip -9 > db.sql
# To dump all databases to a file (Note that your password will appear in your command history!): # To dump all databases to a file (Note that your password will appear in your command history!):
mysqldump -uusername -ppassword --all-databases > all-databases.sql mysqldump -uusername -ppassword --all-databases > all-databases.sql
# To dump all databases to a file: # To dump all databases to a file:

20
cheat/cheatsheets/nc Normal file
View File

@ -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

View File

@ -23,13 +23,15 @@ nmap -source-port [port] [target]
nmap -A [target] nmap -A [target]
# Speedup your scan: # 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: # Traceroute:
nmap -traceroute [target] nmap -traceroute [target]
# Ping scan only: -sP # 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 SYN ping: -PS
# TCP ACK ping: -PA # TCP ACK ping: -PA
# UDP ping: -PU # UDP ping: -PU
@ -38,6 +40,9 @@ nmap -traceroute [target]
# Example: Ping scan all machines on a class C network # Example: Ping scan all machines on a class C network
nmap -sP 192.168.0.0/24 nmap -sP 192.168.0.0/24
# Force TCP scan: -sT
# Force UDP scan: -sU
# Use some script: # Use some script:
nmap --script default,safe 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-. # 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-*" 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 ...

20
cheat/cheatsheets/nova Normal file
View File

@ -0,0 +1,20 @@
# To list VMs on current tenant:
nova list
# To list VMs of all tenants (admin user only):
nova list --all-tenants
# To boot a VM on a specific host:
nova boot --nic net-id=<net_id> \
--image <image_id> \
--flavor <flavor> \
--availability-zone nova:<host_name> <vm_name>
# To stop a server
nova stop <server>
# To start a server
nova start <server>
# To attach a network interface to a specific VM:
nova interface-attach --net-id <net_id> <server>

33
cheat/cheatsheets/ntp Normal file
View File

@ -0,0 +1,33 @@
# Verify ntpd running:
service ntp status
# Start ntpd if not running:
service ntp start
# Display current hardware clock value:
sudo hwclock -r
# Apply system time to hardware time:
sudo hwclock --systohc
# Apply hardware time to system time:
sudo hwclock --hctosys
# Set hwclock to local time:
sudo hwclock --localtime
# Set hwclock to UTC:
sudo hwclock --utc
# Set hwclock manually:
sudo hwclock --set --date="8/10/15 13:10:05"
# Query surrounding stratum time servers
ntpq -pn
# Config file:
/etc/ntp.conf
# Driftfile:
location of "drift" of your system clock compared to ntp servers
/var/lib/ntp/ntp.drift

2
cheat/cheatsheets/numfmt Normal file
View File

@ -0,0 +1,2 @@
# Convert bytes to Human readable format
numfmt --to=iec --suffix=B --padding=7 1048576

View File

@ -19,3 +19,6 @@ openssl x509 -text -noout -in server.crt
echo | openssl s_client -connect <hostname>:443 2> /dev/null | \ echo | openssl s_client -connect <hostname>:443 2> /dev/null | \
awk '/-----BEGIN/,/END CERTIFICATE-----/' | \ awk '/-----BEGIN/,/END CERTIFICATE-----/' | \
openssl x509 -noout -enddate openssl x509 -noout -enddate
# Generate Diffie-Hellman parameters:
openssl dhparam -outform PEM -out dhparams.pem 2048

5
cheat/cheatsheets/p4 Normal file
View File

@ -0,0 +1,5 @@
# Print details related to Client and server configuration
p4 info
# Open a file and add it to depot
p4 add <filename>

15
cheat/cheatsheets/paste Normal file
View File

@ -0,0 +1,15 @@
# Concat columns from files
paste file1 file2 ...
# List the files in the current directory in three columns:
ls | paste - - -
# Combine pairs of lines from a file into single lines:
paste -s -d '\t\n' myfile
# Number the lines in a file, similar to nl(1):
sed = myfile | paste -s -d '\t\n' - -
# Create a colon-separated list of directories named bin,
# suitable for use in the PATH environment variable:
find / -name bin -type d | paste -s -d : -

8
cheat/cheatsheets/ping Normal file
View File

@ -0,0 +1,8 @@
# ping a host with a total count of 15 packets overall.
ping -c 15 www.example.com
# ping a host with a total count of 15 packets overall, one every .5 seconds (faster ping).
ping -c 15 -i .5 www.example.com
# test if a packet size of 1500 bytes is supported (to check the MTU for example)
ping -s 1500 -c 10 -M do www.example.com

2
cheat/cheatsheets/ping6 Normal file
View File

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

21
cheat/cheatsheets/pip Normal file
View File

@ -0,0 +1,21 @@
# Search for packages
pip search SomePackage
# Install some packages
pip install SomePackage
# Output and install packages in a requirement file
pip freeze > requirements.txt
pip install -r requirements.txt
# Show details of a package
pip show SomePackage
# List outdated packages
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
# Install specific version of a package
pip install -I SomePackage1==1.1.0 'SomePackage2>=1.0.4'

View File

@ -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

View File

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

29
cheat/cheatsheets/route Normal file
View File

@ -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

31
cheat/cheatsheets/rpm Normal file
View File

@ -0,0 +1,31 @@
# To install a package:
rpm -ivh <rpm>
# To remove a package:
rpm -e <package>
# To remove a package, but not its dependencies
rpm -e --nodeps <package>
# To find what package installs a file:
rpm -qf </path/to/file>
# To find what files are installed by a package:
rpm -ql <package>
rpm -qpl <rpm>
# To find what packages require a package or file:
rpm -q --whatrequires <package>
rpm -q --whatrequires <file>
# To list all installed packages:
rpm -qa
# To find a pkg's dependencies
rpm -i --test <package>
# Display checksum against source
rpm -K <package>
# Verify a package
rpm -V <package>

View File

@ -0,0 +1,21 @@
'rss2email -- converts rss feeds and emails them to your inbox'
# List all feeds
r2e list
# Convert RSS entries to email
r2e run
# Add a new feed
r2e add <feed address>
# Add a new feed with new email address
r2e add <feed address> [newemail address]
# Delete a feed
r2e delete <# of feed in list/>
# Help
r2e -h

View File

@ -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 host:file1 :file1 /dest/
rsync -avz /source host:/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/ 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

View File

@ -10,5 +10,8 @@ echo 'It is daytime' | sed 's/day/night/g'
# To remove leading spaces # To remove leading spaces
sed -i -r 's/^\s+//g' file.txt 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 sed '/^$/d' file.txt
# To replace newlines in multiple lines
sed ':a;N;$!ba;s/\n//g' file.txt

View File

@ -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>

View File

@ -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

18
cheat/cheatsheets/ss Normal file
View File

@ -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 )'

View File

@ -4,12 +4,19 @@ ssh -i /path/to/file.pem user@example.com
# To connect on an non-standard port: # To connect on an non-standard port:
ssh -p 2222 user@example.com 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: # To execute a command on a remote server:
ssh -t user@example.com 'the-remote-command' ssh -t user@example.com 'the-remote-command'
# To tunnel an x session over SSH: # To tunnel an x session over SSH:
ssh -X user@example.com ssh -X user@example.com
# Redirect traffic with a tunnel between local host (port 8080) and a remote
# host (remote.example.com:5000) through a proxy (personal.server.com):
ssh -f -L 8080:remote.example.com:5000 user@personal.server.com -N
# To launch a specific x application over SSH: # To launch a specific x application over SSH:
ssh -X -t user@example.com 'chromium-browser' ssh -X -t user@example.com 'chromium-browser'
@ -21,3 +28,7 @@ ssh user@example.com -C -c blowfish -X
# For more information, see: # For more information, see:
# http://unix.stackexchange.com/q/12755/44856 # http://unix.stackexchange.com/q/12755/44856
# Copy files and folders through ssh from remote host to pwd with tar.gz compression
# when there is no rsync command available
ssh user@example.com "cd /var/www/Shared/; tar zcf - asset1 asset2" | tar zxf -

18
cheat/cheatsheets/systemd Normal file
View File

@ -0,0 +1,18 @@
# Display process startup time
systemd-analyze
# Display process startup time at service level
systemd-analyze blame
# List running units
systemctl list-units
# Load a unit at startup
systemctl enable foo.service
# Start or Stop a unit
systemctl <start | stop> foo.service
# Unit file locations
/etc/systemd/system
/usr/lib/systemd/system

View File

@ -24,3 +24,8 @@ tar -jtvf /path/to/foo.tgz
# To create a .gz archive and exclude all jpg,gif,... from the tgz # To create a .gz archive and exclude all jpg,gif,... from the tgz
tar czvf /path/to/foo.tgz --exclude=\*.{jpg,gif,png,wmv,flv,tar.gz,zip} /path/to/foo/ tar czvf /path/to/foo.tgz --exclude=\*.{jpg,gif,png,wmv,flv,tar.gz,zip} /path/to/foo/
# To use parallel (multi-threaded) implementation of compression algorithms:
tar -z ... -> tar -Ipigz ...
tar -j ... -> tar -Ipbzip2 ...
tar -J ... -> tar -Ipixz ...

5
cheat/cheatsheets/tee Normal file
View File

@ -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

22
cheat/cheatsheets/tr Normal file
View File

@ -0,0 +1,22 @@
#replace : with new line
echo $PATH|tr ":" "\n" #equivalent with:
echo $PATH|tr -t ":" \n
#remove all occurance of "ab"
echo aabbcc |tr -d "ab"
#ouput: cc
#complement "aa"
echo aabbccd |tr -c "aa" 1
#output: aa11111 without new line
#tip: Complement meaning keep aa,all others are replaced with 1
#complement "ab\n"
echo aabbccd |tr -c "ab\n" 1
#output: aabb111 with new line
#Preserve all alpha(-c). ":-[:digit:] etc" will be translated to "\n". sequeeze mode.
echo $PATH|tr -cs "[:alpha:]" "\n"
#ordered list to unordered list
echo "1. /usr/bin\n2. /bin" |tr -cs " /[:alpha:]\n" "+"

View File

@ -0,0 +1,11 @@
# Get info about block device
udisksctl info -b <block_device>
# Mounting device
udisksctl mount --block-device <block_device>
# Unmounting device
udisksctl unmount --block-device <block_device>
# Get help
udisksctl help

18
cheat/cheatsheets/uniq Normal file
View File

@ -0,0 +1,18 @@
# show all lines without duplication
# `sort -u` and `uniq` is the same effect.
sort file | uniq
# show not duplicated lines
sort file | uniq -u
# show duplicated lines only
sort file | uniq -d
# count all lines
sort file | uniq -c
# count not duplicated lines
sort file | uniq -uc
# count only duplicated lines
sort file | uniq -dc

8
cheat/cheatsheets/unzip Normal file
View File

@ -0,0 +1,8 @@
# Extract archive
unzip archive.zip
# Test integrity of archive
unzip -tq archive.zip
# List files and directories in a file
unzip -l archive.zip

33
cheat/cheatsheets/vagrant Normal file
View File

@ -0,0 +1,33 @@
# Initate Vagrant
mkdir vag-vm; cd vag-vm
vagrant init
# Add a box to vagrant repo
vagrant box add hashicorp/precise32
# Add a box Vagrant file
config.vm.box = "hashicorp/precise32"
# Add vm to public network as host
config.vm.network "public_network"
# Add provision script to vagrant file
config.vm.provision :shell, path: "provision.sh"
# Start vm
vagrant up
# Connect to started instance
vagrant ssh
# Shutdown vm
vagrant halt
# Hibernate vm
vagrant suspend
# Set vm to initial state by cleaning all data
vagrant destroy
# Restart vm with new provision script
vagran reload --provision

16
cheat/cheatsheets/weechat Normal file
View File

@ -0,0 +1,16 @@
# Set unread marker on all windows
Ctrl-s Ctrl-u
# Switch buffer left
Ctrl-p, Alt-left
# Switch buffer right
Ctrl-n, Alt-right
# Next buffer with activity
Alt-a
# Switch buffers
Alt-0...9
# Scroll buffer title
F9/F10
# Scroll nick list
F11/F12

View File

@ -2,7 +2,7 @@
wget http://path.to.the/file wget http://path.to.the/file
# To download a file and change its name # To download a file and change its name
wget http://path.to.the/file -o newname wget http://path.to.the/file -O newname
# To download a file into a directory # To download a file into a directory
wget -P path/to/directory http://path.to.the/file wget -P path/to/directory http://path.to.the/file
@ -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 -). # Allows you to download just the headers of responses (-S --spider) and display them on Stdout (-O -).
wget -S --spider -O - http://google.com wget -S --spider -O - http://google.com
# Change the User-Agent to 'User-Agent: toto'
wget -U 'toto' http://google.com

View File

@ -22,6 +22,9 @@ yum info <package name>
# List currently enabled repositories: # List currently enabled repositories:
yum repolist yum repolist
# List packages containing a certain keyword:
yum list <package_name_or_word_to_search>
# To download the source RPM for a package: # To download the source RPM for a package:
yumdownloader --source <package name> yumdownloader --source <package name>

5
cheat/cheatsheets/zip Normal file
View File

@ -0,0 +1,5 @@
# Create zip file
zip archive.zip file1 directory/
# To list, test and extract zip archives, see unzip
cheat unzip

21
cheat/cheatsheets/zoneadm Normal file
View File

@ -0,0 +1,21 @@
# Halt zone
zoneadm -z <zone_name> halt
# Delete Zone
zoneadm -z <zone_name> halt
zoneadm -z <zone_name> uninstall
# Verify Zone
zoneadm -z <zone_name> verify
# Installing Zone
zoneadm -z <zone_name> install
# Boot Zone
zoneadm -z <zone_name> boot
# Reboot Zone
zoneadm -z <zone_name> reboot
# List Zones
zoneadm list -cv

View File

@ -25,28 +25,16 @@ def create_or_edit(sheet):
# if the cheatsheet does not exist # if the cheatsheet does not exist
if not exists(sheet): if not exists(sheet):
create(sheet) create(sheet)
# if the cheatsheet exists and is writeable... # if the cheatsheet exists but not in the default_path, copy it to the
elif exists(sheet) and is_writable(sheet): # default path before editing
elif exists(sheet) and not exists_in_default_path(sheet):
copy(path(sheet), os.path.join(sheets.default_path(), sheet))
edit(sheet) edit(sheet)
# if the cheatsheet exists but is not writable... # if it exists and is in the default path, then just open it
elif exists(sheet) and not is_writable(sheet): else:
# ... ask the user if we should copy the cheatsheet to her home directory for editing edit(sheet)
yes = prompt_yes_or_no(
'The ' + sheet + ' sheet is not editable. Do you want to copy it to '
'your user cheatsheets directory before editing? Keep in mind that '
'your sheet will always be used before system-wide one.'
)
# if yes, copy the cheatsheet to the home directory before editing
if yes:
copy(path(sheet), os.path.join(sheets.default_path(), sheet))
edit(sheet)
# if no, just abort
else:
die('Aborting.')
def create(sheet): def create(sheet):
@ -75,6 +63,12 @@ def exists(sheet):
return sheet in sheets.get() and os.access(path(sheet), os.R_OK) return sheet in sheets.get() and os.access(path(sheet), os.R_OK)
def exists_in_default_path(sheet):
""" Predicate that returns true if the sheet exists in default_path"""
default_path_sheet = os.path.join(sheets.default_path(), sheet)
return sheet in sheets.get() and os.access(default_path_sheet, os.R_OK)
def is_writable(sheet): def is_writable(sheet):
""" Predicate that returns true if the sheet is writeable """ """ Predicate that returns true if the sheet is writeable """
return sheet in sheets.get() and os.access(path(sheet), os.W_OK) return sheet in sheets.get() and os.access(path(sheet), os.W_OK)

View File

@ -2,24 +2,11 @@ from cheat import cheatsheets
from cheat.utils import * from cheat.utils import *
import os 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(): def default_path():
""" Returns the full path to the default cheatsheet directory """ """ Returns the full path to the default cheatsheet directory """
# 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 # determine the default cheatsheet dir
default_sheets_dir = get_default_data_dir() default_sheets_dir = os.environ.get('DEFAULT_CHEAT_DIR') or os.path.join(os.path.expanduser('~'), '.cheat')
# create the DEFAULT_CHEAT_DIR if it does not exist # create the DEFAULT_CHEAT_DIR if it does not exist
if not os.path.isdir(default_sheets_dir): if not os.path.isdir(default_sheets_dir):
@ -43,11 +30,7 @@ def default_path():
def get(): def get():
""" Assembles a dictionary of cheatsheets as name => file-path """ """ 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 # otherwise, scan the filesystem
for cheat_dir in reversed(paths()): for cheat_dir in reversed(paths()):

View File

@ -1,8 +1,7 @@
from __future__ import print_function
import os import os
import sys import sys
from xdg.BaseDirectory import save_data_path
def colorize(sheet_content): def colorize(sheet_content):
""" Colorizes cheatsheet content if so configured """ """ Colorizes cheatsheet content if so configured """
@ -49,42 +48,18 @@ def editor():
def prompt_yes_or_no(question): def prompt_yes_or_no(question):
""" Prompts the user with a 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) print(question)
return raw_input('[y/n] ') == 'y' return get_input('[y/n] ') == 'y'
def warn(message): def warn(message):
""" Prints a message to stderr """ """ Prints a message to stderr """
print >> sys.stderr, (message) print((message), file=sys.stderr)
def get_default_data_dir():
"""
Returns the full path to the directory containing the users data.
Which directory is used, is determined the following way:
1. If the `DEFAULT_CHEAT_DIR` environment variable is set, use it.
2. If a `.cheat` directory exists in the home directory, use it.
3. Use a `cheat` directory in the systems default directory for user data.
"""
user_dir = os.environ.get("DEFAULT_CHEAT_DIR")
if not user_dir:
user_dir = os.path.expanduser(os.path.join("~", ".cheat"))
if not os.path.exists(user_dir):
user_dir = get_userdata_dir()
return user_dir
def get_userdata_dir():
"""
Returns the full path to a `cheat` directory in the platform specific
default data directory for the current user.
.. note:: The directory is created, if it's not already present.
"""
return save_data_path('cheat')

View File

@ -1,3 +1,2 @@
docopt>=0.6.2 docopt>=0.6.2
Pygments>=1.6 Pygments>=1.6
pyxdg>=0.25

View File

@ -3,7 +3,7 @@ import os
setup( setup(
name = 'cheat', name = 'cheat',
version = '2.0.7', version = '2.1.19',
author = 'Chris Lane', author = 'Chris Lane',
author_email = 'chris@chris-allen-lane.com', author_email = 'chris@chris-allen-lane.com',
license = 'GPL3', license = 'GPL3',
@ -24,6 +24,5 @@ setup(
install_requires = [ install_requires = [
'docopt >= 0.6.1', 'docopt >= 0.6.1',
'pygments >= 1.6.0', 'pygments >= 1.6.0',
'pyxdg >= 0.25'
] ]
) )