Hello World ๐
In this article, I will be sharing a cheat sheet of commonly used git commands and their usage with example. Before starting with the cheat sheet first, we must know what is Git.
Git and Github
Git is a free and open-source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.
GitHub is a web-based Git repository hosting service, which offers all of the distributed revision control and source code management (SCM) functionality of Git as well as adding its own features.
Git Basics
- Git Config :
git config -- global user.name NAME
||git config --global user.email EMAIL
= to set infogit config user.name
||git config user.email
= to check info
Creating repo
git init
= creates a git repository in the directory currently in
Staging
git status
= to check status , if staged or unstagedgit add FILE_NAME
= to add a file to staging areagit rm --cached FILE_NAME
= to remove a file from staging areagit add .
= to add all files in project to staging area
Commiting
git commit -m "Specific Changes Made"
= commits the staging area giving them a specific idgit log
= shows all the commits with detailsgit log --oneline
= shows all the commits in one line each
Git Stash
git stash
= clears the changes to the initial state (last commit) & creates a unique id for the current stategit stash apply
= brings back the current state
- using git stash multiple times creates a list of stashes of all states with multiple ids
git stash list
= shows all the stash (States) with their IDgit stash apply ID
= ID will be the number , which state you want to go back to
git stash push -m "Your message"
= used to give description to stashgit stash drop ID
= used to remove a stash savedgit stash pop ID
= applies the specific stash and removes it from historygit stash clear
= removes all the stash history
Gitignore
- a
.gitignore
file can be created, in which you can specify all the folders/files that should not be staged and committed - For example :
node_modules/
.css.map
etc. - It's Good to create a gitignore at the start of Project
- a good gitignore generator for reference :
Reverting & Reset
- use
git log --oneline
to see the commit_ID to change to - Checkout commit :
git checkout commit_ID
= to just check the commit id entered, see it in read-only ... changes will not be savedgit checkout master
= to come back to original commit (As checkout removes us from master branch)
Revert commit :
git revert commit_ID
= to remove the changes of the provided commit (will add a new revert commit and remove the changes of the specific commit)
- Reset Commit :
git reset commit_ID
= will remove all the commits after the provided id , but the files in local directory will not be touched (therefore you can still commit to original state after doing changes as needed) ... might take you to vim editor (type ":wq" then "Enter" to exit)git reset commit_ID --hard
= will remove all the commits after the provided id and even delete all the files and lines from local directory too
Branches
- Used to test a new feature or code, by creating a branch .. then merging it to master only if needed
- can be used for multiple developers working on the same project .. create a different branch for each developer adding their own feature then merging at the end
git branch branch_name
= to create a new branchgit branch -a
= to list all the branchesgit checkout branch_name
= to shift to the other branchgit branch -d branch_name
= to delete the branch only when it has been mergedgit branch -D branch_name
= to delete the branch (even if not merged to master)git checkout -b branch_name
= to create and shift to a new branch at once
Merging branches
after completing changes in a branch and committing them
come back to master and run
git merge branch_name
= this will merge the branch to master (all commits show in master) = automaticgit merge --squash branch_name
= this will merge the branch to master (only the commit after merge is shown in master) = manual
Conflicts
If Branch's Base (First Commit) is Master's Head (Last Commit) = No Conflict
If Master had commits after creating Branch = Conflicts Might Come
to solve this, edit the files manually, Solve The Conflicts then ..
run
git add .
and thengit commit -m "Message"
and the changes will be made
Git Rebase & Git Merge
Using Git Merge Shows that the Branches Were Added to master, i.e the tree is not inline for all commits
whereas Git Rebase keeps changing the base, and makes the commit inline, feels like the branch was never there
RUN
git rebase master
on your branch- Takes the base of the master, matches it with every commit of your branch
If The Master is already your base, no need for step 3, 4, 5
solve the conflicts, then
git add .
run
git rebase --continue
Repeat 2, 3 steps for every commit - conflict
Now The Master's Head is Branch's Base
- Move to Master
- run
git rebase branch_name
- Now All the commits of Branch are added above your Master commits
NOTE! : It is specified in the git docs that rebase should not be used in public reports (collaboration) as it can cause major errors and conflicts, it can be used in private repos.
Github
Creating new & Cloning Repo
create a new repo on Github and copy the URL
now push your code to it with
git push git_url master
= pushing code to master (master can be replaced by any other branch_name or for all branches replace master with --all)creating an alias to not always type URL
git remote add origin git_url
= origin can be name of anything else, but origin is the word most commonly usedgit push origin master
= to push code to using aliasgit push -u origin master
= pushes and starts tracking the branch (u don't need to specify it again , ex. if pulling)git clone git_url
= will copy the repo to current directory and also add the origin alias by defaultgit remote -v
= to check all the aliases madeadding id and password in push\pull :
replacing the origin in
git push origin master
git push https://username:password@repo_url.git master
if password contains @ replace it with %40
- NOTE : this can store your password in plain text
to avoid this you can remove the password and enter it later
git push https://username@repo_url.git master
Collaborating
- Most of the collaboration features are already available on Github, Example
git pull git_url
= to pull changes from remote to local repo- create a branch and make your changes
git push origin branch_name
= to push the specific branch to remote- create a Compare & Pull Request when you want are ready for the branch to be merged (with a message)
- the reviewer of the repo will accept the changes and merge it (and specify a merge commit message)
- pull the project every time before editing to see the changes
git branch -r
= helps us to see the remote branches & the connections
- Most of the collaboration features are already available on Github, Example
Forking (Contributing)
- to contribute to an open-source project
- click on fork, which will copy the repo to your account
- make changes by pulling the repo, then push it ( this will happen on your account )
- then go to the owner account's repo and create a pull request there
- the owner can compare the changes and accept your changes
- which will end up merging your changes to their project
Reference
#Happy_Coding ๐ป
Thank you for reading the article. Follow CodoPedia for More. ๐
For regular updates and more interesting stuff join our telegram community here Telegram