Quick answer
  1. Open GitSync.md and sign into the GitHub account that can access the repository.
  2. Add the repository from your account or enter its clone URL.
  3. Choose a local destination and select Add & Clone Repository.
  4. Open the working copy, make a small edit, review the diff, commit, and push if you have write access.

GitSync.md requires iOS 17 or iPadOS 17 or later and costs $19.99 once on the US App Store. Local prices vary. This guide clones an existing remote; to start with files already on your phone, follow Create a Git repository from your iPhone.

1. Check repository access

A public repository can be downloaded without private-repository credentials. A private repository requires an account or credential with access. Cloning someone else’s repository does not give you permission to push to it.

For your own GitHub repository, sign into GitSync.md with GitHub and select the appropriate account. The account picker helps you choose a repository without typing its URL. If it is missing, check the account and any organization access requirements first.

You can also enter a clone URL manually. On GitHub, open the repository’s Code menu and copy its HTTPS URL:

https://github.com/YOUR_ACCOUNT/YOUR_REPOSITORY.git

Replace the example with your repository. A link to an individual file, an issue, or a browser page containing /tree/ is not the clone URL. See GitHub’s cloning documentation.

2. Choose where the files belong

In GitSync.md’s repository setup, check Clone To. Choose a local Files location that the editor you intend to use can access.

  • For Obsidian: use its local folder under On My iPhone → Obsidian or On My iPad → Obsidian. Open the cloned repository root as the vault.
  • For code or other documents: choose a local folder accessible to your Files-compatible editor, or edit in GitSync.md.

For this first setup, use a fresh local destination. Do not clone over the only copy of unsynced files. If you already have a local repository, use the existing-repository workflow rather than creating a second working copy unintentionally.

3. Add and clone the repository

  1. Open the add-repository flow and select your GitHub repository or enter the remote URL.
  2. Select the matching authentication method. GitHub Account uses the signed-in account; manual HTTPS and SSH remotes need their own configured credentials.
  3. Review the destination and choose Add & Clone Repository.
  4. Wait for the clone to complete. Check the local files, current branch, and repository status before editing.

A clone creates a Git working copy and its history, not just a ZIP download. The hidden .git directory holds repository metadata; keep it with the working copy. If you use SSH or a self-hosted server, follow the SSH setup guide for key and host-trust steps.

Get GitSync.md for iPhone and iPad →

4. Verify an edit, commit, and push

  1. Open a disposable note or a file you own in GitSync.md’s editor or your chosen local editor.
  2. Make a small change and return to GitSync.md to review the diff.
  3. Stage only the intended changes and create a commit with a useful message.
  4. Push to a remote you have permission to update. Verify the new commit and exact file contents on GitHub.

You can edit files and save local commits offline. Pushing requires network access and authorization. Pull before starting work on another device so you do not accidentally edit an older copy.

Common cloning problems

The repository does not appear

Confirm the selected GitHub account can open the repository on GitHub. Organization access, account selection, and the credential’s permissions can affect visibility. Signing in successfully does not establish access to every private repository.

Obsidian cannot see the vault

Check the destination. For the documented local route, the repository belongs in Obsidian’s local folder. Fully close and reopen Obsidian after cloning, then open the cloned root. Follow the missing-vault checklist.

Push is rejected

Read the error. Write permissions, server policy, authentication, and incoming commits are different causes. If history has diverged, follow the conflict recovery guide; do not force-push merely to clear an error.

Can I run the project after cloning?

Cloning makes files and Git history available. GitSync.md is a Git client and editor, not a general-purpose compiler or application runtime. Check your project’s build and execution requirements separately.

What about large files?

Check storage and the project’s Git LFS requirements before cloning a large library. The LFS guide describes GitSync.md’s downloads and push guards. Other editors and Git clients can have different limits.

Use your new working copy