AutoCommit is a script that simplifies the process of generating a commit message using gpt-4 from OpenAI-API's, for staged files and committing them using Git. It combines a Python script and a Bash script to activate the necessary environment and run the Python code.
- Git
- Conda (Anaconda or Miniconda)
-
Clone the repository and navigate to the project directory.
-
Install the required dependencies by creating a Conda environment:
git clone git@github.com:kandapagari/AutoCommit.git cd AutoCommit conda create --name autocommit python=3.10 poetry -y # python 3.11 doesn't work as @asyncio.coroutine decorator is removed since Python 3.11 see https://stackoverflow.com/a/74345066 conda activate autocommit poetry install
-
Set up the alias by adding the following line to your shell configuration file (e.g., ~/.bashrc, ~/.zshrc):
echo "alias ac='bash $(pwd)/run.sh'" >> ~/.bashrc
only use for quick commit if you trust AutoCommit to work
bash echo "alias qac='echo \":q\" | ac'" >> ~/.bashrc
source ~/.bashrc
ac- No options: Run the Python script to generate and commit the changes.
--help: Display help information.
-
Stage your changes using
git add. -
Run the
acorqacalias. -
The script will activate the
autocommitConda environment and execute the Python scriptsrc/autocommit.py. -
Git will prompt you to edit the generated commit message. Make any necessary modifications and save the file to complete the commit.
run this command in from the root of the repository:
acor
qacThis will generate a commit message for the staged files and initiate the commit process. Git will open a text editor for you to review and modify the generated commit message.
This project is licensed under the MIT License.