ilguappo/aicommit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
a271e5624e
aicommit/README.md
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

1.2 KiB
Raw Blame History

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.