Clone a repository

../_images/git-fork-clone.png

“Cloning” is git’s term for making a local copy of a remote repository (i.e. one held on the GitHub servers).

Developers should clone the main ArduPilot repository (if they simply want to download and compile the latest code) or their own fork (if they want to make changes to the source code and potentially submit changes back).

Instructions for commonly used tools are below but whichever tool is used, the URL for the source repo will be required. This can be found on the right side of the screen on each Github repository home page but in general the URL is:

  • https://github.com/ArduPilot/ardupilot.git for the main ardupilot repo
  • https://github.com/your-github-account/ardupilot for your fork of the ardupilot repo
../_images/APM-Git-Github-Clone.jpg

Cloning with the command line

  • open a terminal and navigate to the directory where you would like the clone to be stored

  • clone your fork:

    git clone https://github.com/your-github-userid/ardupilot
    cd ardupilot
    git submodule update --init --recursive
    

    or the main project repo:

    git clone https://github.com/ArduPilot/ardupilot
    cd ardupilot
    git submodule update --init --recursive
    

Cloning with the GitHub GUI (Windows or MAC)

  • ensure you have installed the GitHub for Desktop
  • open the ArduPilot repo in your favorite web browser
  • click on the green “Clone or download” button and select “Open in Desktop” and follow the instructions
../_images/CloningTheRepository_Windows1.png