Everything related with git can be accomplished using Git CLI(Command Line Interface).

Installation

In order to install Git CLI please follow the documentation provided at https://git-scm.com/downloads

First Time Setup

If this is your first time using Git CLI you need to configure some parameters.

• user.name The name that will be shown in commit history.
• user.email The email that will be shown in commit history.

git config --global user.name "<your_usename>"
git config --global user.email "<your_email>"

cd <path_to_repository>
git config user.name "<your_username>"
git config user.email "<your_email>"

Optional: Setup SSH

Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to GitHub without supplying your username and personal access token at each visit. You can also use an SSH key to sign commits.

You will first need to create an SSH key using ssh-keygen command:

• -t Specifies the type of key to create. Recommended value ed25519
• -C Comment to identify key easier(for humans)

ssh-keygen -t ed25519 -C "<your_email>"

Using above command with default values will create two files named:

• id_ed25519 Private key file to prove identity to remote server.
• id_ed25519.pub Public key file that remote server uses to authenticate requests.

By default it is located under:

• Windows: C:/Users/<your_username/.ssh/
• MacOs: /Users/<your_username>/.ssh/
• Linux: /home/<your_username>/.ssh/

Next we will need to add the id_ed25519.pub file to your GitHub account:

Cloning a Repository

In order to clone a repository we will use different URL depending on our preferred protocol(SSH or HTTPS).

• SSH git:github.com:<organization_name>/<repository_name>.git
• HTTPS https://github.com/<organization_name>/<repository_name>.git

After acquiring the URL we will use git clone command using:

git clone <repository_url>

An example with output folder parameter

git clone git:github.com/P1Gaming/P1-OM-Info.git /Users/siyahas/output_path

TODO

We should add these topics in documentation to provide better coverage on Git CLI.

• Creating branch
• Checkout branch
• Merge branch
• Git History (git log)
• Create/Apply Patch