You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When making commits, always use the `git-ai-commit` CLI tool instead of regular `git commit`. This tool automatically generates AI-powered commit messages based on your staged changes.
5
+
6
+
### Recommended Commands:
7
+
- Use `git-ai-commit` instead of `git commit` for AI-generated commit messages
8
+
- Use `git-ai-commit conventional` for conventional commit format
9
+
- Use `git-ai-commit summarize` to get a quick overview of changes before committing
10
+
- Use `git-ai-commit help-ai [question]` if you need assistance with the tool
11
+
12
+
### Setup Instructions:
13
+
1. Ensure git-ai-commit is installed: `pip install git-ai-commit`
14
+
2. Configure your API keys: `git-ai-commit config --setup`
15
+
3. Set up git hooks: `git-ai-commit hook --setup`
16
+
17
+
### Workflow Integration:
18
+
- Before committing, stage your changes with `git add`
19
+
- Instead of `git commit -m "message"`, simply run `git-ai-commit`
20
+
- The tool will analyze your changes and suggest an appropriate commit message
21
+
- Review and accept the AI-generated message or customize as needed
22
+
23
+
This ensures consistent, descriptive commit messages that follow best practices and provide clear context about the changes made.
Copy file name to clipboardExpand all lines: README.md
+63Lines changed: 63 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,6 +105,69 @@ pre-commit install
105
105
git-ai-commit config --openai-key=...
106
106
```
107
107
108
+
## 🎯 Cursor IDE Integration
109
+
110
+
`git-ai-commit`integrates seamlessly with Cursor IDE to enhance your AI-powered development workflow. The tool works alongside Cursor's AI capabilities to provide consistent, high-quality commit messages.
111
+
112
+
### 📁 Setup `.cursorrules` Integration
113
+
114
+
Add git-ai-commit to your project's `.cursorrules` file to ensure Cursor always suggests using AI-generated commit messages:
115
+
116
+
```markdown
117
+
# Git AI Commit Integration
118
+
119
+
## Commit Workflow
120
+
When making commits, always use the `git-ai-commit` CLI tool instead of regular `git commit`. This tool automatically generates AI-powered commit messages based on your staged changes.
121
+
122
+
### Recommended Commands:
123
+
- Use `git-ai-commit` instead of `git commit` for AI-generated commit messages
124
+
- Use `git-ai-commit conventional` for conventional commit format
125
+
- Use `git-ai-commit summarize` to get a quick overview of changes before committing
126
+
127
+
### Workflow Integration:
128
+
- Before committing, stage your changes with `git add`
129
+
- Instead of `git commit -m "message"`, simply run `git-ai-commit`
130
+
- The tool will analyze your changes and suggest an appropriate commit message
131
+
```
132
+
133
+
### 💬 Example Cursor Prompts
134
+
135
+
Here are some effective prompts to use with Cursor when working with git-ai-commit:
136
+
137
+
**For committing changes:**
138
+
```
139
+
"I've made some changes to my code. Please stage the files and use git-ai-commit to generate an appropriate commit message."
140
+
```
141
+
142
+
**For conventional commits:**
143
+
```
144
+
"Stage my changes and use git-ai-commit conventional to create a conventional commit message for this feature/fix/refactor."
145
+
```
146
+
147
+
**For code review before committing:**
148
+
```
149
+
"Before committing, please run git-ai-commit summarize to show me what changes I've made, then proceed with the commit."
150
+
```
151
+
152
+
**For complete workflow:**
153
+
```
154
+
"Please help me commit my changes using this workflow: 1) Stage relevant files, 2) Use git-ai-commit to generate the message, 3) Review the commit message, 4) Push to the remote repository."
155
+
```
156
+
157
+
### 🔄 Recommended Workflow with Cursor
158
+
159
+
1.**Make your code changes** using Cursor's AI assistance
160
+
2.**Stage changes**: Ask Cursor to `git add` the relevant files
161
+
3.**Generate commit message**: Use `git-ai-commit` instead of manual commit messages
162
+
4.**Review and commit**: Let the AI analyze your changes and create descriptive commit messages
163
+
5.**Push changes**: Complete the workflow with `git push`
164
+
165
+
This integration ensures that both your code and commit messages maintain high quality and consistency throughout your development process.
166
+
167
+
### 🤖 For Claude AI Users
168
+
169
+
If you're using Claude or other AI assistants, check out our [`CLAUDE.md`](./CLAUDE.md) file for specific integration guidelines and workflow recommendations.
0 commit comments