Definition: Git is a distributed revision control system.
Purpose: Keep track of software revisions and files changes.
Git software (like a driver) must be installed in local computer before using it, then you can start tracking software revisions. Revisions are saved to local repository and to a remote distributed repository. The remote repository can be located at your own servers (like GitLab), or at a cloud service like github. Team developers will push (and pull) revisions from that remote repository.
Cloud hosted services:
- github.com
- free for open source
- great community for open source
- beanstalkapp.com
- free for 1 user + 1 repo
- great built-in deploy system
- bitbucket.org
- free for teams under 5 users
- great documentation
- buddy.works
- free for 1 repo + unlimited users
- great team collaboration tools
- great built-in deploy system (extra brownie points for deploy pipelines)
Use “$” symbol to search thru the document
- $setup
- $gibberish
- $getting-started
- $clone
- $submodule
- $commit
- $push
- $remote
- $fetch-pull
- $branch
- $status
- $diff
- $tag
- $update
Set Up Git guide: https://help.github.com/articles/set-up-git/
| Keyword | Description |
|---|---|
Working directory |
Actual files on current directory |
Index | Staging area |
Snapshot of changes set aside to be commited |
SHA-1 |
Unique identifier repesenting history information |
blob |
Represents a file |
tree |
Represents a directory of files |
Commit |
Represents a tree as recorded in a point in time |
HEAD |
Represents the latest commit in current branch |
Tag |
Represents a specific commit used for marking important points in hisotry |
Make git rember your credentials from 2nd time you push/pull and on: $ git config credential.helper cache
| Command | Options | Description |
|---|---|---|
git config |
--global user.name "Cooper Black" |
Set global user name |
git config |
--global user.email "cooper@black.com" |
Set global user email |
git config |
--list |
Display configuration |
git config |
--global --list |
Display global configuration |
git init |
Make current directory a git repository | |
git remote |
add origin <url> |
Set remote origin |
git ls-tree |
-r <branch> --name-only |
List files being tracked |
Reference: https://git-scm.com/docs/git-config
| Command | Options | Description |
|---|---|---|
git clone |
<giturl> |
Clone remote repository into current directory |
git clone |
--recursive <giturl> |
Clone remote repository with submodules |
Reference: https://git-scm.com/docs/git-clone
| Command | Options | Description |
|---|---|---|
git clone |
--recursive <giturl> |
Clone remote repository with submodules |
git submodule |
add <giturl> |
Add submodule |
git submodule |
update --remote |
Update submodules |
git submodule |
status --recursive |
List submodules |
Remove submodule:
$ git submodule deinit <path/to/submodule>
$ git rm <path/to/submodule>Reference: https://git-scm.com/docs/git-submodule
| Command | Options | Description |
|---|---|---|
git add |
<filename> |
Add files to staging area |
git commit |
-m "<title>" -m "<body>" |
Commit with message (includes "added" files only) |
git rm |
<filenama> |
Remove files from the working tree and from the index |
-f |
Force deletion of files from disk | |
git rm |
-r --cached <filename> |
Untrack file (without deleting) |
Reference: https://git-scm.com/docs/git-commit
Untrack hidden files, or update list of tracked files, after adding .gitignore:
# remove all
$ git rm -r --cached .
# add all again, now gitignore will take effect (try to add .gitignore from the start next time)
$ git add .| Command | Options | Description |
|---|---|---|
git push |
<remotename> <branchname> |
Push branch to remote |
git push |
<remotename> --all |
Push all branches to remote |
git push |
--d <remotename> <branchname> |
--delete remote branch |
Reference: https://git-scm.com/docs/git-push
- Remote connections are like bookmarks named after remote repos
git cloneautomatically creates a remote connection usually calledorigin
| Command | Options | Description |
|---|---|---|
git remote |
-v |
List remote repository endpoints |
git branch |
-r |
List remote repository branches |
git remote |
add <name> <url> |
Create namespaced connection to a remote repository |
git remote |
rename <oldname> <newname> |
Rename connection |
git remote |
rm <name> |
Remove connection |
Reference: https://git-scm.com/docs/git-remote
Remove remote origin:
# Remove `origin` settings from .git/config
git remote rm origin
# Remove `FETCH_HEAD` which still points to remote
git rm .git/FETCH_HEAD| Command | Options | Description |
|---|---|---|
git fetch |
<remote> |
Fetch all branches from remote (without merge) |
git fetch |
<remote> <branch> |
Fetch specific branch |
git merge |
<remote>/<branch> |
Merge fetched remote |
git pull |
<remote> |
Fetch and merge in one command |
Reference: https://git-scm.com/docs/git-fetch, https://git-scm.com/docs/git-pull
| Command | Options | Description |
|---|---|---|
git branch |
List branches | |
git branch |
<branchname> |
Create new branch |
git checkout |
<sha-1> |
Switch to branch, or commit |
git branch |
-m <branchname> <newname> |
Rename branch |
git merge |
<branchname> |
Merge changes from <branchname> to current branch |
git branch |
-d <branchname> |
--delete branch |
Reference: https://git-scm.com/docs/git-branch
| Command | Options | Description |
|---|---|---|
git status |
-s |
Show the working tree status, with --short format |
git log |
--oneline |
Show commit logs, with --oneline format |
git ls-files |
Show information about files in the index and the working tree |
Reference: https://git-scm.com/docs/git-status
| Command | Options | Description |
|---|---|---|
git diff |
Compare working directory and index |
|
–-cached |
Compare index and latest commit |
|
HEAD |
Compare latest commit and working directory |
|
--stat |
Optional short format | |
<sha-1> <sha-1> |
2 points in time to compare | |
| ` | ` |
Reference: https://git-scm.com/docs/git-diff
Examples:
## compare changes made to README.md between working tree (default) and latest commit (HEAD)
$ git diff --stat HEAD ./path/README.md
## compare changes made to README.md between 2 specific points in time (e.g. 2 commits)
$ git diff --stat a649900 24bdd58 ./path/README.md| Command | Options | Description |
|---|---|---|
git tag |
List tags | |
git tag |
<v1.0.0> |
Create tag, from latest commit, lightweight |
git tag |
-a <v1.0.0> -m "<msg>" |
Create tag, with --annotate, from latest commit |
git tag |
-a <v1.0.0> -m "<msg>" <SHA-1> |
Create tag, with --annotate, from specific commit |
git tag |
-d <v1.1.0> |
--delete tag |
git show |
<v1.0.0> |
Show tag data and message |
git checkout |
<v1.0.0> |
Switch to specific point tag (not editable) |
git push |
<remote> <tag> |
Push specific tag to <remote> (recommended) |
git push |
<remote> --tags |
Push all tags to <remote> (only if necessary) |
Reference: https://git-scm.com/docs/git-tag