AutoGit is a shell script that automates the process of executing Git commands to add, commit, and push changes to a Git repository.
Meeting these requirements ensures that AutoGit works smoothly on your system.
- Linux or Unix-like system: AutoGit is designed to run on any Linux or Unix-like system including macOS and several Linux distros not limited to Ubuntu, Kali Linux, centOS, Debian, etc. For Windows users, you can consider alternative means of getting Linux/Unix system and/or environment on your machine but using WSL which simplifies the process is highly recommended though only availble for recent versions of Windows 10 and totally supported on Windows 11. Check out WSL.
- Git: AutoGit automates basic Git commands, therefore you must have Git installed on your system. Run
git --versionfrom your command line to confirm installation. If not already installed, kindly install it from the oificial Git website. - Bash Shell: AutoGit is a shell script written in Bash. Ensure that bash is available on your system. Most Linux distros come with Bash pre-installed.
- Internet connectivity: AutoGit requires an internet connection to interact with remote Git repositories, such as pushing changes to a remote origin.
- Permissions: Make sure that you have the necessary permissions to execute scripts (
chmod u+x autogit/install.sh) and access the Git repository you are working with.
-
Clone the repository:
git clone https://github.com/OxOneBeing/autogit.git -
Change directory to the
autogitdirectory. Runcd ./autogit. -
Run
./install.shfrom a bash command line. Note: You might want to run this using SuperUser privileges (i.e sudo./install.sh). -
autogitis now installed and globally accessible.
To use autogit, run the script with the commit message as the argument:
E.g. autogit "Updated 'README.md' file." . This is with an assumption that you're pushing the remote origin to main.
Extensibly, you could specify a different remote and branch by including them as two further arguments.
Example: autogit "Initialized a dev branch!" devRemote devBranch . Note that if you're specifying a remote, you MUST specify a branch.
-vor--version: Print the version of AutoGit.- Run
man autogitafter installation to display the manual pages.
This project is licensed under the MIT License - Coming Soon.
- AutoGit was inspired by the need for an automated Git workflow and relative ease as a lot would be done with just one line of code.
- Thanks to Sunday and the contributors & supporters of the project.