🔄 git-sync

A simple tool to backup and sync your git repositories

Bug report · Feature request · Read Docs

git-sync is a CLI tool designed to help you back up your Git repositories. This tool ensures you have a local copy of your repositories, safeguarding against potential issues such as account bans or data loss.

📺 Demo

🤔 Why `git-sync`?

Remember when @defunkt GitHub account got banned? Well, he is the co-founder of GitHub so he did get his account un-banned pretty quickly but what if you are not that lucky?

Recently I have seen many developers getting their GitHub account banned and losing access to their repositories. Some may be able to recover their account (but there is delay in that) and some may not be able to recover their account at all. What would you do if you lose access to your repositories? What if GitHub goes down? What if you accidentally delete your repositories? The answer is simple, you should have a backup of your repositories.

git-sync provides a straightforward way to back up all your repositories locally, ensuring you have access to your code whenever you need it. It does this by doing a bare clone of all your repositories in a specified directory so that you can recover your code in case of any unforeseen circumstances as well as the file size of your backups is minimal.

✨ Features

Backup All Repositories: Automatically clone or update all your GitHub repositories to a local directory.
Periodic Sync: Keep your backups in sync with your remote repositories by running git-sync periodically.
Multi Clone: While git-sync was designed to work with bare clones to save space and speed up the syncing process, it also supports shallow, mirror and full clones too.
Concurrency: Sync multiple repositories concurrently to reduce the time required for backup.
Configuration File: Easily manage your settings through a YAML configuration file.
Custom Backup Directory: Specify the directory where you want to store your repositories.
Multi Platform: Currently this project supports backing up repositories from all major Git hosting services like GitHub, GitLab, Bitbucket, Gitea and Forgejo.
Notifications: Get notified when your sync is complete, or if there are any errors.

🚀 Getting Started

We have a thorough guide on how to set up and get started with git-sync in our documentation.

🙏🏻 Support

If you found the project helpful, consider giving it a star ⭐️. If you would like to support the project in other ways, you can buy me a coffee or sponsor me on GitHub.

🐛 Bugs or Requests

If you encounter any problems feel free to open an issue. If you feel the project is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull requests are also welcome.