Guides: Git Cheat Sheet

Git principles

Git for computer scientists.

Git user’s manual

Git Magic

Zach Rusin’s Git Cheat Sheet

• https://ktown.kde.org/_{zrusin/git/git-cheat-sheet.svg}

• https://ktown.kde.org/zrusin/git/git-cheat-sheet-medium.png
• https://ktown.kde.org/~zrusin/git/git-cheat-sheet-large.png

cheat.errtheblog.com

• https://cheat.errtheblog.com/s/git/
• https://cheat.errtheblog.com/s/git_usage/
• https://cheat.errtheblog.com/s/gitsvn/

A Practical Git GUIDE

(credit: notes extracted from GIT screencast at https://www.peepcode.com.)

CONFIGURE

identify yourself to git: email and your name

git config --global user.name "David Beckwith"

git config --global user.email "dbitsolutions@gmail.com"

To view all users:

git config --list

OR

cat .gitconfig

SET UP ALIASES

git config --global alias.co checkout

VIEW YOUR CONFIGURATION

cat .gitconfig

TO IGNORE WHITESPACE (Ruby is whitespace insensitive)

git config --global apply.whitespace nowarn

Some nice aliases:

gb = git branch
gba = git branch -a
gc = git commit -v
gd = git diff | mate
gl = git pull
gp = git push
gst = git status

START USING GIT

git init

TO IGNORE SOME FILES

Add a file in the root directory called .gitignore and add some files to it: (comments begin with hash)

*.log
db/schema.rb
db/schema.sql

Git automatically ignores empty directories. If you want e.g. and log/ directory, but want to ignore all the files in it, first add log/* in .gitignore, then add an empty .gitignore in the empty directory:

touch log/.gitignore

TO SCHEDULE THE ADDITION OF ALL FILES TO THE NEXT COMMIT

git add .

TO SEE WHAT THE STATUS

git status

TO COMMIT

git commit -m "First import"

TO SEE WHAT HAS BEEN COMMITTED

git ls-files

TO SCHEDULE DELETION OF A FILE

git rm [file name]

TO COMMIT ALL CHANGES IN FILES IN THE CURRENT REPOSITORY

git commit -a

TO SCHEDULE THE ADDITION OF AN INDIVIDUAL FILE TO THE NEXT COMMIT

git add [file name]

TO VIEW THE DIFFERENCE AS YOU COMMIT USE THE -v OPTION

git commit -v

TO COMMIT AND TYPE THE MESSAGE ON THE COMMAND LINE USE THE -m OPTION

git commit -m "This is the message describing the commit"

TO COMMIT AND GET AUTOMATICALLY ANY CHANGES FROM OTHER PEOPLE USE THE -a OPTION

git commit -a

THE NORMAL COMMIT COMMAND:

git commit -a -v

TO VIEW A LOG OF YOUR COMMITS

git log

TO VIEW A LOG OF YOUR COMMITS WITH A GRAPH TO SHOW THE EXTENT OF THE CHANGES

git log --stat

TO HAVE PAGINATION WHEN VIEWING THE LOG FILE USE THE -v OPTION

git log -v

TO VISUALIZE YOUR CHANGES

gitk --all

TO CREATE A NEW BRANCH

git branch [name of your new branch]

TO VIEW ALL OF THE EXISTING BRANCHES

git branch

TO VIEW A LIST OF ALL BRANCHES

git branch -a

TO SWITCH TO ANOTHER BRANCH

The state of your file system will change after executing this command.

git checkout [name of the branch you want to switch to]

OR

git co [name of the branch you want to switch to]

TO MAKE SURE THAT YOUR NEW BRANCH GETS CHANGES FROM THE MASTER BRANCH (WHERE EVERYBODY ELSE IS WORKING) USE THE REBASE COMMAND

git rebase master

TO MERGE YOUR NEW BRANCH INTO THE MASTER BRANCH

First, switch back to the master branch:

git co master

Check to see what changes you’re about to merge together, compare the two branches:

git diff master xyz

If you’re in a branch that’s not the xyz branch and want to merge the xyz branch into it:

git merge xyz

TO REVERT YOUR CHANGES to before the merge.

git reset --hard ORIG_HEAD

TO RESOLVE CONFLICTS just edit your file.

Remove the markings, add the file, then commit.

TO CREATE A BRANCH AND SWITCH TO THE BRANCH IN ONE MOVE:

git checkout -b [name of new branch]

TO CREATE A “CLIPBOARD” or “STASH” OF CHANGES THAT ARE NOT YET COMMITED (SO THAT YOU CAN SWITCH TO ANOTHER BRANCH IN THE MIDDLE OF YOUR CHANGES.), CREATE A STASH.

git stash "Put a message here to remind you of what you're saving to the clipboard"

TO SWITCH AWAY FROM THE CURRENT BRANCH

git co [branch you want to switch to]

Do whatever Then switch back to the stashed branch

git co [the stashed branch]

TO VIEW THE LIST OF STASHES

git stash list

TO LOAD BACK THE “CLIPBOARD” OR “STASH”

git stash apply

Now you can continue to work where you were previously.

TO DELETE A BRANCH THAT IS NOT USED ANYMORE, but already merged into the current branch. (TO CLEAN UP)

git branch -d [name of branch you want to delete]

TO DELETE AN UNMERGED BRANCH

git branch -D [name of branch you want to delete]

TO DELETE THE STASH. (ERASE THE “CLIPBOARD” FROM MEMORY)

git stash clear

TO SET UP YOUR REPOSITORY FOR SHARING ON A CENTRAL SERVER

Copy up your repository. e.g.:

scp -r my_project deploy@yourbox.com:my_project

Move your files on the remote server to /var/git/my_project For security make the owner of this project git On the repository server:

sudo chown -R git:git my_project

Then (for security) restrict the “deploy” user to doing git-related things in /etc/passwd with a git-shell.

TO CHECK OUT THE GIT REPOSITORY TO YOUR LOCALHOST. ON YOUR LOCAL HOST DO THIS:

git clone git@yourbox.com:/var/git/my_project

TO SEE SOME INFO ABOUT THE REPOSITORY THAT WILL TELL YOU WHICH REPOSITORY IS THE MASTER AND WHICH IS THE SLAVE:

cat .git/config

By virtue of having cloned the remote repository, your local repository becomes the slave and will track and synchronize with the remote master branch.

TO UPDATE YOUR LOCAL BRANCH FROM THE REMOTE SERVER:

git pull

TO GET A COPY OF THE ENTIRE REMOTE REPOSITORY (e.g. a repository named “laptop”) WITHOUT MERGING THEM INTO YOUR LOCAL BRANCHES USE FETCH

git fetch laptop

TO MERGE TWO LOCAL BRANCHES (ie. your local xyz branch with your local master branch) USE MERGE

git merge laptop/xyz

This merged the (already copied laptop repository’s xyz branch) with the current branch you’re sitting in.

TO MERGE THE REMOTE BRANCH WITH YOUR LOCAL BRANCH THAT YOU ARE SITTING IN USE PULL

TO ADD LOCAL KNOWLEDGE (TO YOUR LOCAL REPOSITORY) OF A 2ND REMOTE REPOSITORY, LIKE YOUR LAPTOP

git remote add laptop duo2book.local:repos/m_project

where ’’‘laptop’’” is the name of the remote repository and ”’‘duo2book.local’’” is the name of the remote machine.

TO VIEW META INFORMATION ABOUT THAT REMOTE REPOSITORY

git remote show laptop

TO PUSH A COMMITTED LOCAL CHANGE OF THE xyz BRANCH TO THE REMOTE laptop BRANCH

git push laptop xyz

TO CREATE A TRACKING BRANCH (A SLAVE BRANCH). Ie. to link a local branch to a remote branch:

git branch --track local_branch remote_branch

NOW IF YOU’RE SITTING IN THE LOCAL TRACKING BRANCH, TO PULL YOU DON’T NEED TO SPECIFY THE REMOTE TRACKING BRANCH:

git  pull

Note: You can track(link) different local branches to different remote machines. For example, you can track your friend’s “upgrade” branch with your “bobs_upgrade” branch, and simultaneously you can track the origin’s “master” branch (of your main webserver) with your local “master” branch.

By convention, ‘origin’ is the local name given to the remote centralized server which is the way SVN is usually set up on a remote server.

TO SEE WHICH LOCAL BRANCHES ARE TRACKING A REMOTE BRANCH:

git remote show origin

TO WORK WITH AN SVN REPOSITORY BUT WORK WITH GIT LOCALLY:

git-svn clone [http location of an svn repository]

Now you can work with the checked out directory as though it was a git repository. (cuz it is)

TO PUSH (COMMIT) CHANGES TO THE REMOTE SERVER

git-svn dcommit

TO UPDATE YOUR LOCAL REPOSITORY FROM THE SVN REPOSITORY

git-svn rebase

NOTE: make sure you have your perl bindings to your local svn installation.

I screwed up, how do I reset my checkout?

git checkout -f