Skip to content

Commit dd413e3

Browse files
author
edgar-zorrilla-smartports
committed
feat(docs): AI-Powered Git Workflow Tool
``` An AI-powered Git workflow tool that intelligently analyzes your changes, groups them, and prioritizes changes based on impact analysis. This commit focuses on enhancing the tool's core functionality by improving its change importance assessment and grouping capabilities. The current commit, identified as AI- Powered Git Workflow Tool, details a refined change analysis process that streamlines workflows. ``` Affected files: - M README.md
1 parent 56549a6 commit dd413e3

File tree

1 file changed

+86
-8
lines changed

1 file changed

+86
-8
lines changed

README.md

Lines changed: 86 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,55 @@ An AI-powered Git workflow tool that intelligently analyzes your changes, groups
1313
- 🎯 **Smart Change Importance**: Prioritizes changes based on impact analysis
1414
- 🧩 **Component Detection**: Identifies file components based on project structure
1515

16+
## Prerequisites
17+
18+
### Basic Requirements
19+
- Python 3.7+
20+
- Git (installed and available in PATH)
21+
22+
### For AI-Powered Features (Optional)
23+
- [Ollama](https://ollama.ai) installed and running
24+
- At least one LLM model pulled in Ollama
25+
- Ollama server accessible (default: http://localhost:11434)
26+
27+
## Ollama Setup
28+
29+
To use the AI-powered features:
30+
31+
1. **Install Ollama**:
32+
- Download from [ollama.ai](https://ollama.ai/download)
33+
- Follow the installation instructions for your platform
34+
35+
2. **Start the Ollama server**:
36+
```bash
37+
ollama serve
38+
```
39+
40+
3. **Pull at least one model**:
41+
```bash
42+
# Pull a recommended model
43+
ollama pull llama3
44+
45+
# Or a smaller model
46+
ollama pull gemma:2b
47+
```
48+
49+
4. **Verify your installation**:
50+
```bash
51+
# List available models
52+
ollama list
53+
```
54+
1655
## Installation
1756

1857
```bash
1958
# Install from PyPI
2059
pip install smart-git-commit
2160

2261
# Or install directly from the repository
23-
pip install git+https://github.com/yourusername/smart-git-commit.git
62+
pip install git+https://github.com/CripterHack/smart-git-commit.git
2463
```
2564

26-
## Requirements
27-
28-
- Python 3.7+
29-
- Git
30-
- Ollama (optional, for AI-powered features)
31-
3265
## Usage
3366

3467
```bash
@@ -47,6 +80,9 @@ smart-git-commit --non-interactive
4780
# Specify a repository path
4881
smart-git-commit --repo-path /path/to/your/repository
4982

83+
# Specify a custom Ollama server
84+
smart-git-commit --ollama-host http://custom-ollama-server:11434
85+
5086
# See all options
5187
smart-git-commit --help
5288
```
@@ -183,13 +219,32 @@ smart-git-commit --repo-path /path/to/your/repository
183219

184220
## Troubleshooting
185221

222+
### Common Issues
223+
224+
#### Error: "No models found in Ollama"
225+
- Make sure Ollama is running: `ollama serve`
226+
- Check that you have at least one model installed: `ollama list`
227+
- If no models are available, pull one: `ollama pull llama3`
228+
229+
#### Error: "Failed to get models from Ollama API"
230+
- Check that the Ollama server is accessible on the specified host
231+
- Default location is http://localhost:11434
232+
- Verify your network connection allows access to the Ollama server
233+
- Try restarting the Ollama server: `ollama serve`
234+
235+
#### Error: "Failed to generate text with Ollama"
236+
- The model might be too large for your hardware
237+
- Try a smaller model like gemma:2b or tinyllama
238+
- Check Ollama server logs for any errors or memory issues
239+
186240
### Ollama Connection Issues
187241

188242
If you encounter issues connecting to Ollama:
189243

190244
1. Ensure Ollama is running: `ollama serve`
191245
2. Check that you have at least one model: `ollama list`
192246
3. Try specifying the host explicitly: `--ollama-host http://localhost:11434`
247+
4. Check for firewall or network issues if using a remote server
193248

194249
### Falling Back to Non-AI Mode
195250

@@ -200,6 +255,14 @@ If AI analysis isn't working properly:
200255
smart-git-commit --no-ai
201256
```
202257

258+
## System Requirements
259+
260+
- **Minimum**: Python 3.7+, Git, 4GB RAM
261+
- **Recommended for AI mode**:
262+
- 8GB+ RAM
263+
- An Ollama-compatible system
264+
- Internet connection (for initial model download)
265+
203266
## Contributing
204267

205268
Contributions are welcome! Please feel free to submit a Pull Request.
@@ -217,4 +280,19 @@ MIT
217280
## Acknowledgements
218281

219282
- [Conventional Commits](https://www.conventionalcommits.org/) for the commit message format
220-
- [Ollama](https://github.com/ollama/ollama) for the local LLM capabilities
283+
- [Ollama](https://github.com/ollama/ollama) for the local LLM capabilities
284+
285+
# Changelog
286+
287+
## 0.1.3 (2025-04-23)
288+
- Fix several issues related to ollama
289+
290+
## 0.1.2 (2025-04-23)
291+
- Update meta data
292+
293+
## 0.1.1 (2025-04-23)
294+
- Fixed bug in component detection for subdirectories
295+
- Improved error handling for Ollama connection issues
296+
297+
## 0.1.0 (2025-04-23)
298+
- Initial release

0 commit comments

Comments
 (0)