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
Gitwit is a VS Code extension that uses the power of AI to generate meaningful and concise Git commit messages based on the changes you make in your repository. Save time, eliminate writer’s block, and maintain consistent commit history with Gitwit!
4
+
5
+
---
6
+
7
+
## Features
8
+
9
+
-**AI-Generated Commit Messages:** Automatically generate commit messages tailored to your code changes.
10
+
-**Customizable Suggestions:** Edit and refine AI-generated suggestions directly within the extension.
11
+
-**Seamless Git Integration:** Works seamlessly with your Git workflow.
12
+
-**Clipboard Integration:** Generated messages are automatically copied to your clipboard for easy use.
13
+
-**User-Friendly Interface:** Lightweight and easy-to-use UI integrated into VS Code.
14
+
15
+
---
16
+
17
+
## Installation
18
+
19
+
1. Open VS Code.
20
+
2. Go to the Extensions view by clicking the Extensions icon in the Activity Bar on the side of the window or pressing `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (Mac).
21
+
3. Search for `GitWit`.
22
+
4. Click **Install**.
23
+
24
+
Alternatively, download and install Gitwit from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=MohammedAbidNafi.gitwit).
25
+
26
+
---
27
+
28
+
## Setup
29
+
30
+
After installing Gitwit, run the following commands to set up the extension:
31
+
32
+
1.**Select AI Model:** Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`), type `GitWit: Select AI Model`, and press `Enter`.
33
+
34
+
2.**Enter API Key:** Open the Command Palette again, type `GitWit: Enter API Key`, and press `Enter`.
35
+
36
+
Supported models include:
37
+
38
+
-`gpt-4o`
39
+
-`gpt-4o-mini`
40
+
-`o1-preview`
41
+
-`o1-mini`
42
+
-`gpt-4-turbo`
43
+
-`gpt-4`
44
+
-`gpt-3.5-turbo`
45
+
-`gemini-1.5-flash`
46
+
-`gemini-1.5-pro`
47
+
-`gemini-1.0-pro`
48
+
49
+
---
50
+
51
+
## Usage
52
+
53
+
1.**Make Changes:** Modify your code files as usual.
54
+
2.**Stage Changes:** Stage your changes using Git (`git add` or the Source Control panel in VS Code).
55
+
3.**Generate Commit Message:**
56
+
- Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`).
57
+
- Type `Gitwit: Generate Commit Message` and press `Enter`.
58
+
- The generated commit message is automatically copied to your clipboard.
59
+
4.**Commit Changes:** Paste the message into your Git commit command or the VS Code Source Control panel and commit your changes.
60
+
61
+
---
62
+
63
+
## Requirements
64
+
65
+
- API KEY from either OpenAI or Gemini
66
+
- Active internet connection for AI-based functionality.
67
+
- Git installed on your system.
68
+
69
+
---
70
+
71
+
## License
72
+
73
+
Gitwit is open-source and available under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.html).
74
+
75
+
---
76
+
77
+
## Contributing
78
+
79
+
Contributions are welcome! If you encounter a bug, have a feature request, or want to contribute code:
80
+
81
+
1. Fork the repository.
82
+
2. Create a new branch for your changes.
83
+
3. Submit a pull request.
84
+
85
+
---
86
+
87
+
## Support
88
+
89
+
If you have questions or need help, feel free to open an issue on the [GitHub repository](https://github.com/MohammedAbidNafi/GitWit).
90
+
91
+
---
92
+
93
+
## Acknowledgments
94
+
95
+
Thanks to OpenAI and Gemini for providing the AI models that power Gitwit and to the developers who contributed to this project. Let’s make committing easier and smarter!
0 commit comments