https://github.com/viscouspot/gitsync

Android mobile git client for syncing a repository between remote and a local directory
https://github.com/viscouspot/gitsync

git obsidian productivity sync

Last synced: 22 days ago
JSON representation

Android mobile git client for syncing a repository between remote and a local directory

• Host: GitHub
• URL: https://github.com/viscouspot/gitsync
• Owner: ViscousPot
• License: apache-2.0
• Created: 2024-06-08T17:10:16.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2025-04-25T14:42:41.000Z (about 1 month ago)
• Last Synced: 2025-05-16T09:06:12.250Z (22 days ago)
• Topics: git, obsidian, productivity, sync
• Language: Kotlin
• Homepage: https://gitsync.viscouspotenti.al
• Size: 18 MB
• Stars: 484
• Watchers: 6
• Forks: 40
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  
⚠️ Disclaimer

  
GitSync is currently undergoing a rework.
The latest release remains functional but won’t receive major updates until the rework is complete.
Thanks for your patience! 

  


  


  
GitSync

  
Android git client for syncing a repository between remote and a local directory

  

  


    

    

    

    

    

  

    


  


  


  


  

    

  

  


  


    Documentation

  

  




GitSync is an Android git client that aims to simplify the process of syncing a folder between a git remote and a local directory. It works in the background to keep your files synced with a simple one-time setup and numerous options for activating manual syncs

- **Supports Android 5+**

- Authenticate with

    - **GitHub**

    - **Gitea**

    - **HTTP/S**

    - **SSH**

- Clone a remote repository

- Sync repository

    - Fetch changes

    - Pull changes

    - Commit new changes

    - Push changes

    - Resolve merge conflicts

- Sync mechanisms

    - From a quick tile

    - When an app is opened or closed

    - From a custom intent (advanced)

- Settings

    - Customise sync message

    - Edit .gitignore file

  

Give us a ⭐ if you like our work. Much appreciated!

## Build Instructions

If you just want to try the app out, feel free to use a pre-built release from the [Releases](https://github.com/ViscousPot/GitSync/releases) page

### 1. Setup 

- Clone the project

```bash

  git clone https://github.com/ViscousPot/GitSync.git

```

- Go to the project directory

```bash

  cd GitSync

```

- Open the project in Android Studio

- Sync the gradle project

### 2. Secrets 

- Rename `Secrets.kt.template` to `Secrets.kt`

- Visit `https://github.com/settings/developers`

- Select `OAuth Apps`

- Select `New OAuth App`

  - Application Name: GitSync

  - Homepage URL: `https://github.com/ViscousPot/GitSync`

  - Authorization callback URL: `gitsync://auth`

  - Enable Device Flow: `leave unchecked` 

- Fill `Secrets.kt` with the new OAuth App ID and SECRET

### 3. Build & Run

- Build from within Android Studio

## Support

For support, email [email protected].

Consider [sponsoring](https://github.com/sponsors/ViscousPot)! Any help is hugely appreciated!

## Authors

- [@ViscousPot](https://github.com/ViscousPot)

## Acknowledgements

 - [JGit](https://github.com/eclipse-jgit/jgit)