ilguappo/aicommit
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
Rayai will draft git commit messages for you. Also a script for groq.
30 Commits 2 Branches 1 Tag 78 KiB
Shell 100%
baed3d5d17
Go to file
anaxios baed3d5d17
Update README.md with new instructions on using aicommit 
Replace outdated information about `aicommit_groq`
Clarify prerequisites for using Aicommit
Add setup and usage section to README.md
Document bypassing AI-generated commit messages using the `-m` flag
2024-08-08 02:22:20 -07:00
aicommit Now stands as middleware between the git commit command and the default 2024-08-08 01:30:10 -07:00
aicommit_groq Add pipefail option to set command to prevent pipes from hiding errors, improve script reliability 2024-08-07 04:40:22 -07:00
README.md Update README.md with new instructions on using aicommit 2024-08-08 02:22:20 -07:00
test.txt update README to reflect new feature and remove deprecated usage of aicommit_groq 2024-08-08 02:15:21 -07:00

README.md

Use AI to Draft Commit Messages with Aicommit

Aicommit integrates with RayAI to generate a draft commit message, which is then loaded into your default editor for review and editing.

Prerequisites

To use Aicommit, you need to have the following tools installed:

  • curl
  • jq

Note: Aicommit-groq is currently broken and should not be used.

Setup and Usage

  1. Clone the repository: Clone the Aicommit repository to your local machine.
  2. Configure your Git editor: Add the following line to your ~/.bashrc file, replacing <path/to/> with the actual path to the Aicommit executable:
export GIT_EDITOR="<path/to/>aicommit"
  1. Use Git as normal: Once configured, you can use Git as you normally would. When you run git commit, Aicommit will generate a draft commit message using RayAI, which will then be loaded into your default editor for review and editing.

Bypassing AI-generated messages: If you prefer to write your own commit message, you can use the -m flag with git commit, like this: git commit -m "your message here". This will bypass the AI-generated message and allow you to write your own message directly.