1. Git Cheat Sheet
1.1. Git Resources
| Resource | Notes |
|---|---|
| http://git-scm.com/ | Official git website |
| http://git-scm.com/docs | Git docs |
| https://help.github.com/articles/generating-ssh-keys/ | Generate an SSH Key |
| https://help.github.com/articles/changing-a-remote-s-url/ | Setup the Remote URL |
| https://github.com/pluralsight/git-switch | GitSwitch is a windows utility for managing multiple git credentials |
| https://github.com/pluralsight/pairing-station | PairingStation is a mac app for managing multiple git credentials |
| https://www.codeschool.com/learn/git | CodeSchool courses on using git |
1.2. Awesome Git Aliases
git config --global alias.aliases "\!git config --list | grep alias | sed -e 's/alias\.//' | sed -e $'s/=/\t/'"
git config --global alias.b "branch"
git config --global alias.ba "branch -a"
git config --global alias.bd "branch -d"
git config --global alias.bda "\!git branch | grep -v master | grep -v '*' | xargs git branch -d"
git config --global alias.brda "\!git branch --remotes --merged master | grep -v master | sed -e 's/\// :/' | xargs -n2 git push"
git config --global alias.cam "commit -am"
<<<<<<< HEAD
git config --global alias.cane "commit --amend --no-edit"
=======
>>>>>>> add git cheatsheet and toc
git config --global alias.cm "commit -m"
git config --global alias.ch "checkout"
git config --global alias.chb "checkout -b"
git config --global alias.d "diff"
git config --global alias.ds "diff --staged"
git config --global alias.lga "log --all --color --graph --pretty=format:'%Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit"
git config --global alias.pr "pull --rebase"
git config --global alias.restore "\!git checkout \$(git rev-list -n 1 HEAD -- \"\$1\")^ -- \"\$1\""
git config --global alias.rpo "remote prune origin"
git config --global alias.s "status -bsu"
1.3. Super Git Scripts
# Find remote branches that have not had activity for a specified amount of time.
for k in $(git branch --remotes); do
if [ -z "$(git log -1 --after='24 months ago' $k)" ]; then
echo $k
fi
done
1.4. Global Configuration Preferences
echo ".idea/" >> $HOME/.gitignore
git config --global core.excludesfile $HOME/.gitignore
git config --global core.autocrlf true
git config --global core.safecrlf false
git config --global push.default simple
git config --global color.ui true
1.5. Git Recipes
1.5.1. Now what exactly depends on this package...?
When you find yourself wondering how a downstream dependency fits into the big picture, this command can show you the dependency tree:
npm ls | grep -C 20 "react"
1.5.2. Hatin' on merge commits
Don't you just hate those nasty merge commits cluttering up your commit history? This recipe is just the trick for merging a local branch into master without generating a merge commit.
DO NOT use this recipe if your branch has been pushed to a remote!
git checkout my-branch
git rebase master
git checkout master
git merge my-branch
1.5.3. I take it back!
Sometimes, don't you wish you could just go back in time and do things a little bit differently? Well, with git you can.
Here are the git commands to use for the three different scenarios you'll face when wanting to undo what's been done.
| Command | Use Case |
|---|---|
git checkout |
Use checkout if your changes have not been checked in. |
git reset |
Use reset if your changes have been checked in, but not pushed to a remote. |
git revert |
Use revert if your changes have been checked in and pushed to a remote. |
1.5.4. Catching up
If you've forked a repo and then find yourself wanting to sync up with the latest changes in the original repo, this is the recipe for you.
This recipe makes the assumption that your repo follows the standard conventions of naming the original remote the upstream remote.
git fetch upstream
git checkout master
git merge upstream/master
1.6. Special Git Files
1.6.1. .gitignore
The .gitignore file should be at the root of the project directory. This file tells git to ignore, or not track, the specified files.
See the docs for a complete reference: https://git-scm.com/docs/gitignore
# Lines that start with a pound sign (#) are comments
# Blank lines are not interpreted
# Ignore specific files
.env
secrets.txt
# Ignore entire folders
node_modules
bin
log
# Patterns are supported
*.log
**/*.log
# Negate a previous pattern to NOT ignore a file
!critical.log
1.6.2. .gitattributes
The .gitattributes file should be at the root of the project directory. This file tells git how to handle certain files or file types.
See the docs for a complete reference: https://git-scm.com/docs/gitattributes
The -text option tells git not to normalize the line endings on that file. In other words, leave this file alone.
*.txt text
*.vcproj eol=crlf
*.sh eol=lf
*.jpg -text
1.7. Git Commands
When working with git commands, options can be combined. For example, git commit -am is the same as git commit -a -m and git status -su is the same as git status -s -u.
1.7.1. git help
| Command | Description |
|---|---|
git help |
Prints basic usage for the help command to the console. |
git help <command> |
Launches detailed help docs for the specified command. For example, git help commit or git help clone |
1.7.2. git config
For a large, but not necessarily complete, list of configuration variables, see http://git-scm.com/docs/git-config#_variables
| Command | Description |
|---|---|
git config |
Prints basic usage for the config command to the console. |
git config --global |
Use the global user configuration |
git config --system |
Use the system configuration, i.e. the config for all users on the computer |
git config --list |
Prints the applicable configurations for the repository, namely the local, global, and system configurations, so some variables might be listed multiple times. |
git config <variable> <value> |
Set the value for a config variable. For example, git config --global color.ui true |
git config --get <variable> |
Get the value for a config variable. For example, git config --global --get color.ui |
git config --unset <variable> |
Remove a variable from the config. |
git config --global alias.<alias-name> "<aliased command>" |
Set a command alias. For example, git config --global alias.pr "pull --rebase" then use git pr |
git config --global user.name "User Name" |
Set the global user name |
git config --global user.email "user@site.com" |
Set the global email address |
git config --global core.autocrlf true |
Set the global line endings policy to \r\n (carriage return) on checkout and \n (line feed) on commit |
git config --global core.autocrlf input |
Changes the line ending to \n on commit. |
git config --global core.editor <editor-command> |
Set the global editor used by git for things like commit messages |
1.7.3. git init
| Command | Description |
|---|---|
git init |
Create a new, empty git repository. |
1.7.4. git status
| Command | Description |
|---|---|
git status |
Shows changes since the last commit |
git status -s |
Displays a short, condensed status message. Alias for --short |
git status -u |
Show untracked files. Alias for --untracked |
1.7.5. git diff
When viewing the diff in a bash console, hit q to exit.
| Command | Description |
|---|---|
git diff |
Show the differences in tracked, unstaged files. |
git diff --staged |
Show the differences in staged files. Synonymous with git diff --cached |
git diff <file> |
Show the differences in the specified file. |
git diff <commit> |
Show the changes you have in your working tree relative to the named <commit>. |
git diff <branch-1> <branch-2> |
Show the differences between two branches. |
git diff HEAD~5 |
Show the differences in the working tree against 5 commits back. |
1.7.6. git checkout
| Command | Description |
|---|---|
git checkout <path> |
Replace the contents of the file in the working directory with the contents from the last commit. This effectively blows away the changes in the specified path since the last commit. |
git checkout . |
Checkout all files from the last commit. This effectively blows away all changes to tracked files since your last commit. |
git checkout <branch-name> |
Switch to the specified branch. If you have changes in your working directory when you switch branches, those changes will be preserved. |
git checkout -b <new-branch> |
Create a new branch and immediately switch to the new branch. |
git checkout <tag-name> |
Checks out the code at the commit where the tag was inserted. |
git checkout <branch-name> -- <file-name> |
Checkout a file from a different branch. Useful if you're in a branch and want to get a single file in sync with master or any other branch. |
1.7.7. git add
| Command | Description |
|---|---|
git add <path> |
Add the specified file or folder to the staging area. |
git add -A |
Add all modified and untracked files to the staging area. Alias for --all |
git add . |
Functionally equivalent to --all |
git add *.txt |
Wildcards are supported. A command like this would add all .txt files in the top level folder. |
git add "*.txt" |
Adding quotes around the wildcard will make it work in the top level folder and in all sub folders. |
1.7.8. git commit
| Command | Description |
|---|---|
git commit |
Commit the staged files. This will open up an editor to type in your commit message. |
git commit -m "message" |
Commit staged files with the specified commit message. |
git commit -a |
Add all modified tracked files and then commit. This DOES NOT add untracked files. Alias for --all |
git commit --amend |
Amend the last commit by adding additional files or changing the commit message. Do not amend commits that have been pushed to a remote repository! |
git commit --dry-run |
Does not create a commit, but instead shows what would have been committed. |
1.7.9. git tag
| Command | Description |
|---|---|
git tag |
Lists all of the tags. Same as running git tag -l |
git tag <tag-name> |
Create a new lightweight tag. This does not create a tag object. Lightweight tags are only recommended for temporary or private use for identifying commits. |
git tag -a <tag-name> |
Create an unsigned, annotated tag object. For example, git tag -a v1.2.7. -a is an alias for --annotate. |
git tag -s <tag-name> |
Create a GPG-signed tag object using the default email address's key. For example, git tag -s v2.2.9. -s is an alias for --sign. |
git tag -m <message> |
Add the message for the tag object from the command line. For example, git tag -a v3.1.0 -m 'new feature: time travel'. -m is an alias for --message. |
git tag -a <tag-name> <commit> |
Tag a previous commit by its id. For example, git tag -a v5.3.1 9fceb02 -m 'forgot to tag this!' |
git tag -l <pattern> |
List all tags that match the given pattern. If no pattern is given, all tags are listed. -l is an alias for --list. |
git tag -d <tag-name> |
Delete a local tag. For example git tag -d v1.2.3. -d is an alias for --delete. |
git push <remote-name> :<tag-name> |
Use git push to delete a remote tag. For example, git push origin :v1.2.3 |
1.7.10. git blame
| Command | Description |
|---|---|
git blame <file-name> |
See which commit is responsible for each line in the specified file. |
1.7.11. git reset
Never use the reset command to undo changes that have been pushed! If changes have been pushed, use git revert to undo commits.
| Command | Description |
|---|---|
git reset |
Unstage all files that have been staged using the add command. |
git reset <path> |
Unstage the specified file or folder. |
git reset --soft HEAD^ |
Undo, or reset, the last commit and put the changes from that commit into the staging area. |
git reset --hard HEAD^ |
Undo, or reset, the last commit and discard the changes. |
git reset --hard HEAD^^^ |
Completely blow away the last three commits. |
git reset --soft <commit> |
Undo changes back to the specified commit. |
1.7.12. git revert
Use git revert if the commit to undo has been pushed to a remote.
| Command | Description |
|---|---|
git revert <commit> |
Create an inverse commit of the specified commit. For example, git revert f32ab34 |
1.7.13. git log
When viewing the diff in a bash console, hit q to exit.
| Command | Description |
|---|---|
git log |
Show the commit log. |
git log --graph |
Show a text based representation of the branches. |
git log --all |
Show all of the commits as if they had been specified on the command line. |
git log --oneline |
Show each commit on a single line. |
git log --abbrev-commit |
Show only the first 7 characters of the commit instead of the full 40 byte hex object name. |
1.7.14. git remote
There are a couple of remote naming conventions:
originis the name of the remote that is the primary owner of the repository.upstreamis the name of the original remote from which a repository was forked.
| Command | Description |
|---|---|
git remote |
List the remotes for the repository. |
git remote -v |
Give detailed information about remotes. Alias for --verbose. |
git remote add <remote-name> <remote-address> |
Add a remote to an existing repo. |
git remote rm <remote-name> |
Remove a remote. |
git remote show <remote-name> |
Show detailed information about a remote, including remote branches and whether the branches are tracked or not. |
git remote prune <remote-name> |
Remove stale, local branches that have been removed from the remote. |
1.7.15. git push
| Command | Description |
|---|---|
git push <remote-name> <branch-name> |
Push the specified branch to the specified to the specified remote. |
git push -u <remote-name> <branch-name> |
Push using the -u flag to remember the remote to use for the branch. After pushing with the -u flag, you can just use git push. -u is an alias for --set-upstream. |
git push |
After pushing with the -u flag, this will push the branch to the upstream remote. |
git push <remote-name> :<branch-name> |
Delete a remote branch. For example, git push origin :new-feature |
git push <remote-name> :<tag-name> |
Delete a remote tag. For example, git push origin :v1.2.6 |
git push <remote-name> <local-branch>:<remote-branch> |
If the local branch has a different name than the remote branch, use this command to push the local branch to the remote. |
git push --tags |
Push tags. For some strange reason, tags are not pushed unless this flag is used and using this flag does not push code. |
git push --recurse-submodules=on-demand |
If using submodules, use this flag to push your current branch and also all of the submodules. |
1.7.16. git fetch
| Command | Description |
|---|---|
git fetch |
Retrieves and pulls down information from the remote, but does not merge it into the local copy |
1.7.17. git pull
| Command | Description |
|---|---|
git pull |
Pull down changes from the remote. If needed a merge commit will be created. Shorthand for git fetch followed by git merge FETCH_HEAD |
git pull --rebase |
Pull down changes from the remote, and if needed, rebase local commits instead of creating a merge commit. Shorthand for git fetch followed by git rebase FETCH_HEAD |
1.7.18. git clone
| Command | Description |
|---|---|
git clone <src-repo> |
Clone a repository. Provide a url to clone a remotely hosted repo. |
git clone <src-repo> <target-repo> |
Clone a repo into the specified repo. |
1.7.19. git branch
| Command | Description |
|---|---|
git branch |
List the active branch and all local branches. |
git branch -r |
List remote branches. |
git branch -a |
List all branches, both local and remote. |
git branch <branch-name> |
Create a new branch with the specified name. |
git branch <branch-name> <commit> |
Create a new branch that points to a specific commit. |
git branch -d <branch-name> |
Safely delete a branch. If the branch has not been merged into master or has uncommitted changes, the delete will fail. |
git branch -D <branch-name> |
Force delete a branch. This will blow the branch away regardless of branch state. |
git push <remote-name> :<branch-name> |
Use git push to delete a remote branch. For example, git push origin :cool-branch |
1.7.20. git merge
| Command | Description |
|---|---|
git merge <branch-name> |
Merge the specified branch into the current branch. |
git merge <remote-name>/<remote-branch> <local-branch> |
Merge a remote branch into a local branch. |
git merge --no-ff <branch-name> |
Do a recursive merge. Tell git not to do a fast-forward merge. |
1.7.21. git rebase
Rebase moves commits made on the current branch since the branch was made into a temporary area, does a fast-forward merge of new commits in the original branch into the current branch, and then replays the current branch commits (which creates new commit hashes in the process). This effectively makes it as if you had started the branch at the current state of the original branch. This is a useful technique for not creating automatic 'merge commits' that would get created using git merge.
DO NOT rebase a branch that has been pushed to a remote.
| Command | Description |
|---|---|
git rebase <branch-name> |
Replay the commits in the current branch on top of any commits from the specified branch. |
git rebase --continue |
Continue a rebase after fixing a conflict. |
git rebase -i <branch-name> |
Do an interactive rebase. |
1.7.22. git rm
| Command | Description |
|---|---|
git rm <file-pattern> |
Remove the file(s) that match the specified file pattern from the working tree and from the index. |
git rm -n <file-pattern> |
Do a dry run to see which files will be removed. |
git rm -r <directory> |
Recursively remove all of the files in the specified directory. |
git rm --cached <file-pattern> |
Remove matching files from the index, but does not touch the working tree. In other words, the file is no longer tracked in git, but the file is not modified by this command. |
1.7.23. git clean
| Command | Description |
|---|---|
git clean |
Remove untracked files from the working directory |
git clean -n |
Do a dry run - preview files that are going to be deleted |
git clean -f |
Force delete. Remove files without requiring a confirmation |
git clean -x |
Remove files that are ignored in your .gitignore file. For more examples, see http://stackoverflow.com/questions/61212/how-do-i-remove-local-untracked-files-from-my-current-git-branch |
1.7.24. git stash
Stashing files is particularly useful for when you have changes in the working directory that you aren't ready to commit, but you need to pull or push or something. Stashing the files will preserve your changes in the stashed copy.
Most common usage is git stash, [do some stuff], git stash pop
| Command | Description |
|---|---|
git stash |
Same as git stash save |
git stash save |
Save all changed files and stash them away. |
git stash save --keep-index |
Causes the staging area not to get stashed. |
git stash save --include-untracked |
Stash untracked files as well |
git stash save "message" |
A message can be included when stashing. |
git stash apply |
Restores the files at the top of the stash. |
git stash apply <stash-name> |
A stash can be picked out of the stack by name to restore. |
git stash drop |
Deletes the top stash. |
git stash pop |
Shortcut for git stash apply followed by git stash drop. |
git stash list |
List the stack of stashes |
git stash list --stat |
Summarize the file changes in the stash. |
git stash show |
Show the changes for the stash |
git stash show <stash-name> |
Show the changes for the named stash |
git stash branch <branch-name> |
Pulls a stash out into a new branch |
git stash clear |
Drop all of the stashes in the stack |
**tech.joshegan.com
Josh Egan
<<<<<<< HEAD Proudly built with harp and hosted on GitHub ======= Proudly built with harp and hosted on GitHub
add git cheatsheet and toc