For the past year or so, we’ve been using Git as our version control system. My introduction to the GUIs around Git was SourceTree (although I’ve made an effort to learn the commands) but I have also used poshgit and Git Bash. Recently, we’ve started using SSH keys instead of HTTPS and I had to learn how to set up my repositories with SSH. Everywhere and everyone tells you this is straight forward and it is when the critical path works but when something is wrong, it gets more difficult. A lot of unnecessarily complex documents does not help either. So I’m going to details all the steps that I took in the hope that it could helps someone.

Set-up your GitHub account You should already have a GitHub account (if not, go to github.com and create one now). Now you have to connect your GitHub account to SourceTree. Click on the Settings icon on the right and select Settings. It happens because SourceTree didn't get some private access from Github while authenticating. So the solution is very simple Login into your Github account on any browser From top right corner select SETTINGS. Unfortunately, you can’t do this in SourceTree, and it often makes SourceTree run slowly if you even try to do it while SourceTree is open. But it’s what I do in all my “solo repositories” and “quickie-project repositories” where the “remote” (e.g. GitHub.com, BitBucket.com) repository is the “source of truth” and my. Git config user.name git config user.email Make sure the repo on Mac has the same settings than the one on Windows. This thread details how to change those settings in SourceTree, but check if 'Allow SourceTree to modify your global Git configuration file' is set: that means it would apply to all your local git repo (Github or not).

My setup for this task is Git (you can use the embedded git within SourceTree), SourceTree and BitBucket (previously used Google Drive to host my git repositories).

Open SourceTree and click on the Terminal icon (this is Git Bash)

Type the following command in
- ls –all ~/.ssh (this will list any existing ssh keys in C:Users.ssh, this is the default but can be changed when generating the key).
Next, generate the key
- ssh-keygen –t rsa –b 4096 –C “”
- It will ask you where you’d like to store the files, I accepted the default but you can specify a directory if you wish.
- Then enter a passphrase, I would recommend you provide a passphrase from a security standpoint.
- You should now see this this:

There should be two key files id_rsa (private) and id_rsa.pub now created.

Still using the terminal (Git Bash) in SourceTree, type:
- eval $(ssh-agent). There are many ways to start the SSH agent but this is only way it would work for me. It should give you a process id back, something like, Agent pid 1234
Finally using this command to add the new key
- ssh-add ~/.ssh/id_rsa
- If successful, the output should say that an identity has been created.
- You should never have to type in the passphrase again.

Log into BitBucket
Select the icon on the top right of the browser and select Manage Account
From the Security menu, select SSH Key then Add Key
Add you public key (id_rsa.pub) to the text area and then Add Key again

Note, your public key in this file is in a different format from what BitBucket expects. My recommendation for this scenario is to go to SourceTree – Tools – Create or Import SSH Keys. This starts a Putty Generator that has the ability to load existing keys. The generator will then show the public key in a user friendly format to be copied and used within BitBucket.

In Stage 1, the SSH key was generated and set up for the Git Bash terminal, now we want to take that SSH key and use it within the SourceTree GUI.

First step is to go to Tools – Create or Import SSH Key
Load your existing private key in.
Click on “Save Private Key”. This has to be saved in the Putty .ppk format. I would recommend that you didn’t save this private key to the .ssh folder in case of conflicts between two keys.
Next is to launch the SSH agent – Putty comes with SourceTree.
Make sure Pagent is running ( little computer with a hat on sitting in your windows tray).

Add the key to the SSH agent by right clicking on Putty Pagent and selecting “Add Key”. It is Pagent that stops the user from entering the passphrase all the time by holding key and making it available to SourceTree.
A further step is to add the .ppk key to Tools – Options – General – SSH Client Configuration.

That’s it! I was all around the houses trying to fix various errors and configure. Some of the problems I faced were:

Permission denied (public key). I believe it was a combination of errors on my part. One, I had created too many key files in the .ssh directory and it didn’t know what one to choose. Second, I hadn’t set up SourceTree correctly. The SSH key had to be a .ppk key and not the id_rsa key, which I’d generated.
Could not open a connection to your authentication agent. I believe this was down to me changing from Putty to OpenSSH. OpenSSH just never launched, no wonder it couldn’t get a connection.
It took ages to clone a repository. SourceTree GUI doesn’t give a lot of feedback with what is going on, not like Git Bash. I thought it wasn’t working.

My tip would be to test the connection using “ssh –T git@bitbucket.org”. This command with provide decent feedback if you have or haven’t authenticated. So open Git Bash and type this in.

A good topic for debate is why go to all the trouble of using SSH keys? Why not, use HTTPS and cache you account details in winstore?

Update:

Discovered this morning that if you shut SourceTree down, if you use the Git Bash terminal, you will need to repeat Stage 2.

References

Git and the command line can be a daunting prospect, luckily there are multiple Git GUIs, which work across a variety of platforms such as, OSX, Windows, and Linux.

In this post, we’ll be taking a look at the two most important ones. GitHub Desktop and SourceTree by Atlassian, the company behind Bitbucket.

So why would you use a Git GUI? It’s perfect for learning the ins and outs of Git-based code management, before advancing to more complex command line tools. If you really want to understand what’s going on behind the scenes, you will still have to dig into the command line. Check out WP Pusher’s free video course on Git for WordPress for more on this.

GitHub Desktop

The GitHub Desktop application is developed by GitHub and is the perfect way to easily manage all your GitHub projects.

The layout of the GitHub Desktop application is simple and straightforward with an uncluttered interface, making it perfect for the beginner, though still including more powerful options for the advanced developer. This is where GitHub Desktop stands out when compared to SourceTrees more cluttered interface. Which could easily confuse a beginner that isn’t familiar with Git.

There’s quite a few things going on in that screenshot, let’s break down each piece:

On the left hand side you have your repositories, these are repositories that you’ve already created in your GitHub account and synced to your PC. You won’t see repositories that you have added to GitHub and haven’t synced to your PC. In other words don’t panic, if you can’t see your repositories. We’ll cover adding repositories in a moment.

Next to the repositories we have our commits for the currently selected repository: Delphi exe decompiler.

Notice that next to the repository name there is a padlock symbol? That denotes the repository is private and can only be seen by people that have been granted access. Which means if someone went on your public GitHub profile and you didn’t have any public repositories but had two private ones it would show as if you’ve got no repositories.

In the above screenshot, see how there’s an 11 next to that top commit. This means 11 files where modified. If you click on that, you’ll get a full list of all changed files:

If we click on the commit at the top, we can see what’s has been changed on the right hand side. Red = deleted, Green = added.

Let’s take a closer look at the commit information.

At the top there’s the commit title,

Sourcetree With Github