Link SSH Key to GitHub: Quick Guide

1. Generate a New SSH Key

Run the following command to generate a new SSH key specifically for GitHub:

ssh-keygen -t ed25519 -C "your_email@example.com" -f ~/.ssh/id_github

Explanation:

-t ed25519: Specifies the key type.
-C "your_email@example.com": Adds a comment to the key (typically your email).
-f ~/.ssh/id_github: Specifies the file name for the new key.

During the process, you’ll be prompted to:

Confirm the file location (press Enter to accept the default).
Enter a passphrase (optional, but recommended for added security).

2. Verify the Key Files

Once the SSH key is created, confirm the existence of the key files using:

ls -l ~/.ssh/id_github*

You should see:

~/.ssh/id_github: The private key (keep this secure and never share it).
~/.ssh/id_github.pub: The public key (this will be added to GitHub).

3. Add the Key to Your SSH Agent

Add the private key to your SSH agent to manage it easily:

Start the SSH agent:
```
 eval "$(ssh-agent -s)"
```
Add the key to the agent:
```
 ssh-add ~/.ssh/id_github
```

4. Copy the Public Key to Your Clipboard

To add the key to GitHub, first copy the public key:

cat ~/.ssh/id_github.pub

5. Add the SSH Key to Your GitHub Account

Log in to your GitHub account.
Navigate to Settings > SSH and GPG keys.
Click New SSH key.
Paste your public key into the provided field.
Add a title to identify this key (e.g., "Server").
Click Add SSH key.

6. Test the SSH Connection

Verify the connection to GitHub using:

ssh -i ~/.ssh/id_github -T git@github.com

If successful, you should see a message like:

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

7. Using the SSH Key for Repository Management

Clone a Repository

Use the SSH URL to clone a repository:

When pushing changes, Git will automatically use the SSH key for authentication:

git clone git@github.com:<username>/<repository>.git

Push Changes

git push origin main

Conclusion

By setting up an SSH key with GitHub, you’ve simplified your authentication process and secured your repository management workflow. No more password prompts—just smooth, secure Git operations!

Step-by-Step Guide to Linking an SSH Key with Your GitHub Repositories

Comments

More from this blog

Qdrant 101

Why Dense and Sparse Vectors Work Better Together: A Beginner's Guide to Multi-Vector Collections

A Guide to Document Chunking and Vector Search

Kubernetes/Helm-charts commonly used commands

WSL Networking and Port Forwarding

1. Generate a New SSH Key

2. Verify the Key Files

3. Add the Key to Your SSH Agent

4. Copy the Public Key to Your Clipboard

5. Add the SSH Key to Your GitHub Account

6. Test the SSH Connection

7. Using the SSH Key for Repository Management

Clone a Repository

Push Changes

Conclusion

Command Palette

Comments

More from this blog

1. Generate a New SSH Key

2. Verify the Key Files

3. Add the Key to Your SSH Agent

4. Copy the Public Key to Your Clipboard

5. Add the SSH Key to Your GitHub Account

6. Test the SSH Connection

7. Using the SSH Key for Repository Management

Clone a Repository

Push Changes

Conclusion