Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GitJournal/git-auto-sync
Automatically Sync Git Repos
https://github.com/GitJournal/git-auto-sync
Last synced: about 2 months ago
JSON representation
Automatically Sync Git Repos
- Host: GitHub
- URL: https://github.com/GitJournal/git-auto-sync
- Owner: GitJournal
- License: apache-2.0
- Created: 2020-08-12T12:16:58.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-13T00:01:20.000Z (10 months ago)
- Last Synced: 2024-01-27T11:01:47.809Z (5 months ago)
- Language: Go
- Size: 146 KB
- Stars: 88
- Watchers: 4
- Forks: 9
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- jimsghstars - GitJournal/git-auto-sync - Automatically Sync Git Repos (Go)
- awesome-stars - GitJournal/git-auto-sync - Automatically Sync Git Repos (Go)
- awesome-cli-apps - Git Auto Sync - Automatically commits changes to a git repository, and always keep that repository up to date. (<a name="git"></a>Git and accessories)
- cli-apps - Git Auto Sync - Automatically commits changes to a git repository, and always keep that repository up to date. (<a name="git"></a>Git and accessories)
README
# Git Auto Sync
GitAutoSync is a simple command line program to automatically commit changes
to your git repo, and always keep that repo up to date. This way you can use any editor with your text files, and never need to worry about
comitting and remembering to push and pull changes.
## Installation
* OSX - `brew install GitJournal/tap/git-auto-sync`
* Linux -
- Ubuntu/Debian -
```bash
sudo echo "deb [trusted=yes] https://apt.fury.io/vhanda/ /" | sudo tee /etc/apt/sources.list.d/git-auto-sync.list
sudo apt-get update
sudo apt-get install -y git-auto-sync
```
- Fedora/RPM -
```bash
sudo echo -e "[git-auto-sync]\nname=Git-Auto-Sync\nbaseurl=https://yum.fury.io/vhanda/\nenabled=1\ngpgcheck=0" | sudo tee /etc/yum.repos.d/git-auto-sync.repo
sudo yum update
sudo yum install -y git-auto-sync
```
- Arch Linux - Please write an AUR package and open a PR for this. You're an Arch User. You got this.
- Other - Download the [latest release](https://github.com/GitJournal/git-auto-sync/releases/latest)
* Windows - Download the [latest release](https://github.com/GitJournal/git-auto-sync/releases/latest)
## How to use?
GitAutoSync comes with a manual and daemon mode. It's recommended to start with the manual
mode to ensure authentication is working correctly. It internally just calls the `git` executable
so, if that works, `git-auto-sync` should just work.
You can test it out by running `git-auto-sync sync` to commit, pull, rebase and push any changes.
If there are no changes, it will just attempt to pull, rebase and push.
Once you're satisfied that `git-auto-sync` is working for you. You can run `git-auto-sync daemon add ` to start a background daemon which will continously monitor that repo for any changes
in the file system and accordingly sync the changes.
This daemon will be automatically started as a system process.
You can check if it is running `git-auto-sync daemon status`
### Background Daemon
The background daemon will be started / stopped automatically if there are any repos to watch in `git-auto-sync daemon ls`.
This process will monitor the filesystem, poll every 10 minutes, and additionally try to sync on resuming from a suspend. The latter
two are done to pick up changes from the remote.
### Merge Conflicts
GitAutoSync current only supports rebases, and doesn't yet attempt to do a merge. In the case of a
rebase conflict, it will abort and stop syncing that repo. It will send a system notification
to inform you of the conflict.
### Ignored Files
It currently ignores all hidden files, files ignored by git, and additional temporary swap files
created by vim, emacs and similar editors.
## Similar Projects
- [Obsidian Git](https://github.com/denolehov/obsidian-git)
- [VS Code GitDoc](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.gitdoc)
- [Git Annex](https://git-annex.branchable.com/)
- [Git Sync](https://github.com/simonthum/git-sync)