A terminology list is found at the bottom.
git clone <repo link>
The git clone command lets you make a copy of a repo from some git service,
e.g. GitHub or GitLab.
Note: When executing the command the repo will be placed in your current location.
git clone https://github.com/Tosuma/AAU-Latex-Template-English.git - will
clone the repo 'AAU-Latex-Template-English' to your computer.
Stage files to commit
git add <Path>
This command stages a file or folder to the commit.
git add . - adds all changes made to the commit.
For more information go to here.
git add ./API/API-documentation.md - adds the file 'API-documentation.md'
located in the folder 'API' to the commit.
git commit [-m <message>]
This command commits all stages made.
It has the optional argument -m <message>, which is the commit message - this
is more often than not included when making commits.
The message should be enclosed by single or double qoutes to make it a string.
git commit -m "ADDDED: API-documentation.md" - commits the stages with the
message 'ADDDED: API-documentation.md'.
Push commits to the remote
git push [-u <target remote> <branch name>]
This command updates the remote with the commits from the specified branch.
The -u tag is used for new branches which is not tracked by the remote.
This is a one time setup, meaning that it is only the first time you ask the
remote to track a branch that you should include the -u tag.
Specify which remote should track the specified branch. Unless you know what
you are doing use the origin as the target remote.
git push - pushes the commits from the local to the remote.
git push origin api-documentation - pushes the commits from the branch
'api-documentation' to origin. NB: This is a bad practise,
use pull requests instead.
git push -u origin my-new-branch - pushes the branch to the remote and gets
the remote to track the new branch.
Pull the commits from the remote
git pull
This command pulls the changes made on the remote into the local, making your branch up to date with the changes that meight have been made.
git checkout [<branch name>]
This command lets you change to the specified branch. Note, that in order to
checkout to the specified branch your local must know that it exists.
To do this you can use the git pull
or git fetch command
git checkout api-documentation - this will change your working tree
to that of a the api-documentation branch.
git status
This will give you a status of current working tree. Here you will be able to see the files which has had changes or have been added since the last commit. You will also be able to see the files which has been staged.
Unstage files from commit
git restore [--staged <Path>]
The given path (file or folder) will be unstaged from the commit. However, it is rare that it is used.
NB: This command is experimental, the behavior may change.
git restore --staged ./API/API-documentation.md - removes the file
'API-documentation.md' located in the folder 'API' from the commit.
git restore --staged . - removes all files and folders from the commit.
For more information go to here.
git reset [--soft | --hard] [HEAD<~number>]
This command will let you undo a commit. It will still keep the changes you have made, but remember to commit the changes you need! Use git status
to see the changes which has been made.
The number in ~number is the amount of commits you want to undo, which gives
you the option to undo multiple commits.
The --hard tag should be used with causion since it will remove all
changes - i.e. it destroys the changes made in the commits which are undone.
The --soft tag will leave your changes in the index, meaning that you can
make a commit immediately without doing git add.
git reset --hard HEAD~1 - undos the latest commit and removes all changes
from said commit.
git reset HEAD~2 - undos the 2 latest commits and keeps the changes, however
they are not stages for a new commit.
git reset --soft HEAD~1 - undo the latest commit and keeps the changes where
the changes are staged and ready for a new commit.
git branch [ [-d <branch name>] | [-r | -a] ]
This command will show all of the local branches and specify which is checked out to.
The -d <branch name> will delete a branch from your local.
Important: it does not delete the branch from the remote,
meaning that you can remove instances of a branch from your computer
but not delete the actual branch.
The -r tag will just show all of the branches.
The -a tag will show all of the branches as well as the branches which you
are currently on and the others which is on the local.
Recommended to use over the -r tag, since -a gives more information.
git branch - will show all the branches of which an instance exist on the
computer, including marking which branch you are currently on.
git branch -d api-documentation - will delete the local instance of the
api-documentation branch.
git branch -r - will show all branches in the repository.
git branch -a - will show all branches in the repository and all the
branches of which an instance exist on the computer, including marking which
branch you are currently on.
git fetch [-p]
This command will fetch the recent changes from the remote (such as new branches or deleted branches).
Include the tag or -p to prune (delete) any branches which has been deleted on the remote.
git merge [<branch name>]
This command lets you merge the working tree of another branch
into the working tree of the branch which you are currently on. Note you
may need to specify which remote the branch is from, therefore include
origin/<branch name> when merging.
NB: Merge conflicts arises when the two branches have made changes in the same area, i.e. changed something in a file or created a file with the same name. Git will not let you push commits which contains merge conflicts, hence you should handle them immediatly.
git merge origin/other-api-documentation - this will merge the files and their
content into the branch which you are currently on.
git config credential.helper store
This command will store the last credentials entered. NB: Should be executed immediately after credentials has been entered.
git push <remote name> --delete <branch name>
NB: Since this deletes branches from the remote it should be used with with great care!
This command will delete the branch from the remote, but not from the local.
The remote name will likely have to be origin.
git diff [--name-only]
This command will show all of the files which has changed and what has changed in them.
Include the tag --name-only to only see the names of the files.
NB: You will achive the same with git status.
git checkout -- <file_path>
This command will reset the specific file back to what is on the current remote.
The tag -- is to make sure that git knows it is a file.
git checkout .
This command will discard all changes made, and reset back to what is on the current remote.
git log --all --decorate --oneline --graph
This command will return a graph of the all the branches and their commits which can be used to get an overview if a merge erreor occurs.
Every folder has, besides the content, two hidden subjects; . and ..
. is the current folder. Depending on how the command works it might be
interpreted as the content of the folder, e.g. the command git add <Path>
adds the changes made in the path, if the path is . the command git add .
would add all changes made in this current folder, which includes all file
changes in said folder.
.. is the folder above the current folder. It is often used with the command
cd .. which changes the command line directory to the to directory above.
The square brackets ( [ ] ) indicate that the enclosed element
(parameter, value, or information) is optional.
You can choose one or more items or no items.
Do not type the square brackets themselves in the command line.
[global options]
[source language="arguments"][/source]
[destination arguments]
The angle brackets ( < > ) indicate that the enclosed element
(parameter, value, or information) is mandatory. You are required to
replace the text within the angle brackets with the appropriate information.
Do not type the angle brackets themselves in the command line.
-f <set the File Name variable>
-printer <printer name>
-repeat <months> <days> <hours> <minutes>
date access <mm/dd/yyyy>
The ellipsis symbol of three periods ( ... ) means "and so on" and
indicates that the preceding element (parameter, value, or information) can be
repeated several times in a command line.
-jobid <job id1, job id2, job id3,...>
[-exitcode <exit code 1>,<exit code2>,<exit code3> ...]
The pipe symbol (vertical line) means "or" and indicates a choice within an element. If two arguments are separated by the pipe symbol, you can select the element to the left of the separator or the element to the right of the separator. You cannot select both elements in a single use of the command. Within square brackets, the choices are optional. Within angle brackets, at least one choice is required.
-ca_backup [-custom|-rotation|-gfsrotation]
-excludeday <Sun|Mon|Tue|Wed|Thu|Fri|Sat>
-runjob <start|stop>
The curly brackets ( { } ) indicates a set of required items, however,
you must choose one of the elements. The elements in the curly brackets are
seperated by the pipe operator.
Do not type the braces themself in the command line.
{FILE_1 | FILE_2}
{--source=CLOUD_SOURCE --source-url=SOURCE_URL | --bucket=BUCKET [--source=LOCAL_SOURCE]}
An open source, distributed version-control system.
A platform for hosting and collaborating on Git repositories.
A copy of a repository on GitHub owned by a different user.
A lightweight movable pointer to a commit.
A local version of a repository, including all commits and branches.
The remote is the branch which is in the cloud, e.g. GitHub/GitLab, hence remote.
The local is branch which is locally on the computer. This can be deleted without deleting the remote in the cloud.
The Working Tree in Git is a directory (and its files and subdirectory) on your file system that is associated with a repository.
A commit is a snapshot of the project's currently staged changes. Committed snapshots can be thought of as "safe" versions of a project - Git will never change them unless you explicitly ask it to.
To stage af file or folder means that the subject has been added to the commit.
To unstage a file or folder means that the subject has been removed from the commit.
A place to compare and discuss the differences introduced on a branch with reviews, comments, integrated tests, and more.
Representing your current working directory. Can generally be thought of the main/master branch.