/GitSync

A simple way to manage GitHub repositories on Windows and Linux.

Primary LanguageC#MIT LicenseMIT

GitSync

GitSync is a .NET application to simplify the use of some Git commands like commit, add, push, pull, and inserting usernames and passwords.

Technology

GitSync uses some open source projects to work properly:

  • .NET Core - build and execute .NET applications on Windows, Linux, and MacOS.
  • LibGit2Sharp - manage and execute native runtimes for Git commands.
  • Newtonsoft.Json - control .JSON files and objects.

Requirements (Portable Version)

Gitsync requires .NET Core Runtime v2.1+ to run. You also have to use one of those Operating Systems:

  • Linux (Alpine, Debian, Fedora, Linux-x64, Red Hat, Ubuntu, or derived distributions).
  • Windows.
  • MacOS X

Requirements (Native Versions)

By using native versions, you just have to use one of those Operating Systems:

  • Linux x64 distributions.
  • Windows x86 or x84.
  • MacOS X x64.

Usage (Portable Version)

GitSync does not need installation, just download the latest portable release available here and edit the file config.json. You have to put at least your GitHub username and password in the configuration file. For more accurated signature and commit, please add your GitHub e-mail to the configuration file.

After that, you can open your favorite Terminal and run this command to execute the GitSync application.

Executing:

$ dotnet GitSync.dll some\git\repository\path "commit message here"
  • To run the .dll this way, make sure to insert the path using a valid format, for example, if your path is C:\Users\user\Desktop\my folder, you must use " " on it because of the spaces. It is a valid insertion for this case:

Paths with spaces:

$ dotnet GitSync.dll "C:\Users\user\Desktop\my folder" "commit message here"

(optional) Paths with spaces on Linux distributions:

$ dotnet GitSync.dll /mnt/c/Users/user/Desktop/my\ folder/ "commit message here"
  • In this case, use \ before the spaces.

Usage (Native Versions)

GitSync does not need installation, just download the latest native release available here and edit the file config.json. You have to put at least your GitHub username and password in the configuration file. For more accurated signature and commit, please add your GitHub e-mail to the configuration file.

After that, you can open your favorite Terminal and run this command to execute the GitSync application.

Executing on Windows:

$ GitSync.exe some\git\repository\path "commit message here"

Executing on Linux distributions and OSX:

$ ./GitSync some\git\repository\path "commit message here"
  • To run the executable file this way, make sure to insert the path using a valid format, for example, if your path is C:\Users\user\Desktop\my folder, you must use " " on it because of the spaces. It is a valid insertion for this case:

Paths with spaces:

$ GitSync.exe "C:\Users\user\Desktop\my folder" "commit message here"

(optional) Paths with spaces on Linux distributions and OSX:

$ ./GitSync /mnt/c/Users/user/Desktop/my\ folder/ "commit message here"
  • In this case, use \ before the spaces.

Results

Running GitSync implies the same results as the following Git command lines:

$ git add -a
$ git commit -m "commit message here"
$ git pull [inserting username and password if needed]
$ git push [inserting username and password]

License

The MIT license (Refer to the LICENSE.md file).