SSH Keys for GitHub

Setting up SSH Keys for GitHub on Windows Or Linux

Setting up an SSH key for GitHub on Windows is a simple process that involves generating an SSH key, adding it to the SSH agent, and linking it to your GitHub account. Here’s a step-by-step guide:

1. Check for Existing SSH Keys

Open a terminal (PowerShell, Git Bash, or Command Prompt) and run:

ls ~/.ssh

If there are files like id_rsa and id_rsa.pub, you already have an SSH key. If not, proceed to the next step.

2. Generate a New SSH Key

Run the following command in your terminal:

ssh-keygen -t ed25519 -C "[e-mail]"

Replace [e-mail] with your GitHub email address.

If your system doesn’t support ed25519, use RSA instead:\

ssh-keygen -t rsa -b 4096 -C "[e-mail]"

You’ll be prompted:

To save the file: Press Enter to save to the default location (~/.ssh/id_ed25519)

For a passphrase: Enter one for extra security or leave it empty.

3. Start the SSH Agent

On Windows In Git Bash or On Linux:

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519

In PowerShell if you are using standalone git binary from Mingw or any other source:

Start-Service ssh-agent
ssh-add ~\.ssh\id_ed25519

Replace YourUsername with your actual Windows username.

If you’re using a Linux desktop environment, the SSH agent may already be running. You can skip the first command if you see output like Agent pid XXXX.

4. Add the SSH Key to Your GitHub Account

View your public key:

# on windows
Get-Content ~\.ssh\id_ed25519.pub
# on linux
cat ~/.ssh/id_ed25519.pub

Log in to GitHub

Go to Settings > SSH and GPG keys.

Click New SSH Key.

Paste the public key into the “Key” field.

Add a title and click Add SSH Key.

5. Test the Connection

Run the following command to verify your SSH setup:

ssh -T [e-mail]

If successful, you’ll see:

Hi username! You’ve successfully authenticated, but GitHub does not provide shell access.