Beanstalk Guides

Working with Git on macOS

Table of Contents

Installing and configuring Git on macOS can seem difficult if you’ve never used a command line before, but there are only a few things to learn to get started. This guide will take you through the steps to install and configure Git and connect it to remote repositories to clone, push, and pull.

Installing Git

Download the latest Git installer package, double click on the installer to start the installation wizard. You’ll be prompted for your system password in order for the installer to complete.

After you have successfully installed Git on Mac, you’ll need to provide secure communication with your Git repositories by creating and installing SSH keys.

Creating SSH keys on Mac

To communicate with the remote Git repository in your Beanstalk account from your Mac, you will need to generate an SSH key pair for that computer. This process requires only a few steps, and all of the tools necessary are included on your Mac.

Launching Terminal

Terminal is an application that comes with macOS and provides you with an interface to run text commands, switch through folders, and manage files. You can usually find it in your Applications Utilities folder.

Generating a key pair

Type these commands in your Terminal window and press Return. First make sure you are in your home directory:

cd ~/

and then generate the keypair with:

ssh-keygen -t rsa

It will ask for location, just accept the default location (~/.ssh/id_rsa.pub) by pressing Return. When it asks for a pass phrase, make sure to set a strong pass phrase for the key. We’ve included some additional information about SSH keys and how to manage strong pass phrases in our Tips for using SSH Keys guide.

Now that the keys are generated, copy it to your clipboard for the next step:

cat ~/.ssh/id_rsa.pub | pbcopy

Your public key is now on your clipboard and you can easily add it to a version control hosting account like Beanstalk. When you paste it, your SSH public key should look something like this:

ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAyyA8wePstPC69PeuHFtOwyTecByonsHFAjHbVnZ+h0dpomvLZxUtbknNj3+
c7MPYKqKBOx9gUKV/diR/mIDqsb405MlrI1kmNR9zbFGYAAwIH/Gxt0Lv5ffwaqsz7cECHBbMojQGEz3IH3twEvDfF6cu5p
00QfP0MSmEi/eB+W+h30NGdqLJCziLDlp409jAfXbQm/4Yx7apLvEmkaYSrb5f/pfvYv1FEV1tS8/J7DgdHUAWo6gyGUUSZ
JgsyHcuJT7v9Tf0xwiFWOWL9WsWXa9fCKqTeYnYJhHlqfinZRnT/+jkz0OZ7YmXo6j4Hyms3RCOqenIX1W6gnIn+eQIkw==
Mac Pro

In your Beanstalk account, the added SSH key will look like this:

SSH Key Details in Beanstalk

Checking your connection

Before trying to access your Git remote repository, check if the connection to your remote hosted Git repository works. Enter the following command in the Terminal, replacing “accountname” with your account name:

ssh git@accountname.beanstalkapp.com

In this case, this is the URL to access Git on your Beanstalk account. If you are using another version control hosting service, the URL would be provided by them.

You’ll most likely encounter a message that looks like this:

The authenticity of host 'accountname.beanstalkapp.com (204.232.132.2)' can't be established.
RSA key fingerprint is 30:9a:97:f3:19:4f:d1:6e:28:76:9e:e7:d1:df:2c:31.
Are you sure you want to continue connecting (yes/no)?

You can type yes and press Enter, which will add your account’s hostname accountname.beanstalkapp.com to a known_hosts file. This step won’t need to be repeated unless your public key or your account names changes. Also, this must be done from the Terminal before using any GUI clients.

If you were authenticated correctly, you will see a message similar to this one:

You were successfully authenticated as [emailaddress] in accountname.beanstalkapp.com.

You can now continue to configure your local Git profile.

Setting up your Git Profile

After you have authenticated correctly by installing Git and setting up SSH keys, before you start using your Git repositories, you should setup your Git profile by typing following after you run Git bash in command line:

git config --global user.name "Firstname Lastname"
git config --global user.email "your_email@youremail.com"

In case you are using Beanstalk for version control, it would be best if your first name, last name and email address match to the ones you use in your account to avoid any conflicts.

Summary

In order to be able to use your repository you need to:

  • Install Git
  • Generate SSH keys with ssh-keygen
  • Check if the connection to the Git repository is working
  • Set up your Git profile

While getting started with Git, the most common mistakes include mismatched private and public SSH keys or the Beanstalk user not having permission to access the repository. Make sure to check these after you have finished setting up Git. If you run into issues, just contact us using one of the links below.

Now what?

Now that you have Git properly installed and configured, you can use a client of your choice. Whether you choose a terminal or a GUI, it is a good idea to learn the basic concepts and commands for versioning your files before. Here’s some recommended reading to get you started: