Github Cheatsheet

Download as pdf or txt
Download as pdf or txt
You are on page 1of 6

GIT CHEAT SHEET

Git is the free and open source distributed version control system that's responsible for everything GitHub
related that happens locally on your computer. This cheat sheet features the most important and commonly
used Git commands for easy reference.

INSTALLATION & GUIS STAGE & SNAPSHOT


With platform specific installers for Git, GitHub also provides the Working with snapshots and the Git staging area
ease of staying up-to-date with the latest releases of the command
line tool while providing a graphical user interface for day-to-day git status
interaction, review, and repository synchronization.
show modified files in working directory, staged for your next commit
GitHub for Windows
git add [file]
https://windows.github.com
add a file as it looks now to your next commit (stage)
GitHub for Mac
https://mac.github.com git reset [file]

unstage a file while retaining the changes in working directory


For Linux and Solaris platforms, the latest release is available on
the official Git web site. git diff

Git for All Platforms diff of what is changed but not staged
http://git-scm.com
git diff --staged

diff of what is staged but not yet committed

SETUP git commit -m “[descriptive message]”


Configuring user information used across all local repositories commit your staged content as a new commit snapshot

git config --global user.name “[firstname lastname]”

set a name that is identifiable for credit when review version history
git config --global user.email “[valid-email]”
BRANCH & MERGE
Isolating work in branches, changing context, and integrating changes
set an email address that will be associated with each history marker
git branch
git config --global color.ui auto
list your branches. a * will appear next to the currently active branch
set automatic command line coloring for Git for easy reviewing
git branch [branch-name]

create a new branch at the current commit

SETUP & INIT git checkout


Configuring user information, initializing and cloning repositories
switch to another branch and check it out into your working directory
git init git merge [branch]

initialize an existing directory as a Git repository merge the specified branch’s history into the current one
git clone [url] git log

retrieve an entire repository from a hosted location via URL show all commits in the current branch’s history
INSPECT & COMPARE SHARE & UPDATE
Examining logs, diffs and object information Retrieving updates from another repository and updating local repos

git log git remote add [alias] [url]

show the commit history for the currently active branch add a git URL as an alias
git log branchB..branchA git fetch [alias]

show the commits on branchA that are not on branchB fetch down all the branches from that Git remote
git log --follow [file] git merge [alias]/[branch]

show the commits that changed file, even across renames merge a remote branch into your current branch to bring it up to date
git diff branchB...branchA git push [alias] [branch]

show the diff of what is in branchA that is not in branchB Transmit local branch commits to the remote repository branch
git show [SHA] git pull

show any object in Git in human-readable format fetch and merge any commits from the tracking remote branch

TRACKING PATH CHANGES REWRITE HISTORY


Versioning file removes and path changes Rewriting branches, updating commits and clearing history

git rm [file] git rebase [branch]

delete the file from project and stage the removal for commit apply any commits of current branch ahead of specified one

git mv [existing-path] [new-path] git reset --hard [commit]

change an existing file path and stage the move clear staging area, rewrite working tree from specified commit

git log --stat -M

show all commit logs with indication of any paths that moved TEMPORARY COMMITS
Temporarily store modified, tracked files in order to change branches

IGNORING PATTERNS git stash


Preventing unintentional staging or commiting of files Save modified and staged changes

logs/ git stash list


*.notes
pattern*/ list stack-order of stashed file changes
git stash pop
Save a file with desired patterns as .gitignore with either direct string
matches or wildcard globs. write working from top of stash stack
git config --global core.excludesfile [file] git stash drop

system wide ignore pattern for all local repositories discard the changes from top of stash stack

Education
Teach and learn better, together. GitHub is free for students and teach- [email protected]
ers. Discounts available for other educational uses. education.github.com
Git Cheat Sheet

01 Git configuration 03 Day-To-Day Work


$ git config --global user.name “Your Name” $ git status
Set the name that will be attached to your commits and tags. Displays the status of your working directory. Options include new,
staged, and modified files. It will retrieve branch name, current commit
$ git config --global user.email “[email protected]” identifier, and changes pending commit.
Set the e-mail address that will be attached to your commits and tags.
$ git add [file]
$ git config --global color.ui auto Add a file to the staging area. Use in place of the full file path to add all
Enable some colorization of Git output. changed files from the current directory down into the directory tree.

$ git diff [file]


02 Starting A Project Show changes between working directory and staging area.

$ git init [project name] $ git diff --staged [file]


Create a new local repository. If [project name] is provided, Git will Shows any changes between the staging area and the repository.
create a new directory name [project name] and will initialize a
repository inside it. If [project name] is not provided, then a new $ git checkout -- [file]
repository is initialized in the current directory.
Discard changes in working directory. This operation is unrecovera-
ble.
$ git clone [project url]
Downloads a project with the entire history from the remote repository. $ git reset [file]
Revert your repository to a previous known working state.

$ git commit
Create a new commit from changes added to the staging area.
The commit must have a message!

GitLab | everyone can contribute about.gitlab.com


$ git rm [file] 05 Review your work
Remove file from working directory and staging area.
$ git log [-n count]
$ git stash List commit history of current branch. -n count limits list to last n
Put current changes in your working directory into stash for later use. commits.

$ git stash pop $ git log --oneline --graph --decorate


Apply stored stash content into working directory, and clear stash. An overview with reference labels and history graph. One commit
per line.
$ git stash drop
$ git log ref..
Delete a specific stash from all your previous stashes.
List commits that are present on the current branch and not merged
into ref. A ref can be a branch name or a tag name.
04 Git branching model
$ git log ..ref
$ git branch [-a] List commit that are present on ref and not merged into current
List all local branches in repository. With -a: show all branches branch.
(with remote).
$ git reflog
$ git branch [branch_name] List operations (e.g. checkouts or commits) made on local repository.
Create new branch, referencing the current HEAD.

$ git checkout [-b][branch_name]


Switch working directory to the specified branch. With -b: Git will
create the specified branch if it does not exist.

$ git merge [from name]


Join specified [from name] branch into your current branch (the one
you are on currently).

$ git branch -d [name]


Remove selected branch, if it is already merged into any other.
-D instead of -d forces deletion.

GitLab | everyone can contribute about.gitlab.com


06 Tagging known commits 08 Synchronizing repositories
$ git tag $ git fetch [remote]
List all tags. Fetch changes from the remote, but not update tracking branches.

$ git tag [name] [commit sha] $ git fetch --prune [remote]


Create a tag reference named name for current commit. Add commit Delete remote Refs that were removed from the remote repository.
sha to tag a specific commit instead of current one.
$ git pull [remote]
$ git tag -a [name] [commit sha] Fetch changes from the remote and merge current branch with its
Create a tag object named name for current commit. upstream.

$ git tag -d [name] $ git push [--tags] [remote]


Remove a tag from local repository. Push local changes to the remote. Use --tags to push tags.

$ git push -u [remote] [branch]


07 Reverting changes Push local branch to remote repository. Set its copy as an upstream.
$ git reset [--hard] [target reference]
Switches the current branch to the target reference, leaving
a difference as an uncommitted change. When --hard is used, Commit an object
all changes are discarded. Branch a reference to a commit; can have a tracked upstream
Tag a reference (standard) or an object (annotated)
$ git revert [commit sha]
Head a place where your working directory is now
Create a new commit, reverting changes from the specified commit.
It generates an inversion of changes.

GitLab | everyone can contribute about.gitlab.com


A Git installation D The zoo of working areas
For GNU/Linux distributions, Git should be available in the standard Another remote repository. Git is a distributed
version control system. You can have as many
system repository. For example, in Debian/Ubuntu please type in Remote repository named origin? You’ve remote repositories as you want. Just remember
the terminal: probably made git clone from here. to update them frequently.

$ sudo apt-get install git Remote repo Remote repo


If you need to install Git from source, you can get it from (name: origin) (name: public)
git-scm.com/downloads.
Git fetch or git pull Git push Git push public master Remote repositories
An excellent Git course can be found in the great Pro Git book by
Scott Chacon and Ben Straub. The book is available online for free Local repositories

at git-scm.com/book. Repository
Git commit

B Ignoring Files Changes committed here will be safe. If you are


doing backups! You are doing it, right? Index
$ cat .gitignore (staging area)
/logs/* Git reset HEAD
Only index will be committed.
!logs/.gitkeep Git stash
Choose wisely what to add!
Stash
/tmp Git add
*.swp A kind of shelf for the mess
Verify the .gitignore file exists in your project and ignore certain type you don’t want to include.
Working
of files, such as all files in logs directory (excluding the .gitkeep file), Git stash pop directory
whole tmp directory and all files *.swp. File ignoring will work for the
directory (and children directories) where .gitignore file is placed. You do all the hecking right here!

C Ignoring Files This is an origin/fix/a fix/a This is a local branch. It is 3 commits ahead,
upstream branch you see it, right?

This is a tag. It looks like a developer’s note working-version


so it’s probably a reference, not an object.
Master This is also a local branch

This is an initial commit, This is a merge commit,


This is a tag. It looks like V1.0.1
it has no parents a version so it’s probably it has two parents! HEAD Your working directory is here
an object (annotated tag)

GitLab | everyone can contribute about.gitlab.com

You might also like