gitai-wf 0.1.1

AI-powered toolkit that enhances `Git` workflow
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# Git With AI

AI-powered Git toolkit that enhances workflow with intelligent commit messages, pull request generation, code reviews, changelogs, and more. It integrates with various LLM providers to automate and improve your development process.

## Features

- **Smart Commit Messages**: Generate meaningful commit messages based on your code changes
- **Pull Request Generation**: Automatically create detailed PR descriptions with context
- **Code Reviews**: Get AI-assisted code reviews with suggestions
- **Changelogs**: Generate release notes and changelogs from commit history
- **Multiple LLM Support**: Works with OpenAI, Anthropic, Google, and other providers
- **Git Config Integration**: Store configurations in Git config for project-specific settings
- **Wire Protocol Support**: Efficient caching and synchronization for remote repositories

## Installation

### From Source

```bash
git clone https://github.com/ab22593k/gitai.git
cd gitai
cargo build --release
```

## Configuration

gitai uses Git config to store settings. Configure your LLM provider:

# To configure your default LLM provider globally, use the following commands.

# Replace 'google' with your chosen provider and provide the necessary credentials and model.

```bash
git config --global gitai.defaultprovider google
git config --global gitai.google-apikey "your-api-key"
git config --global gitai.google-model "gemini-1.5-pro"

# For project-specific settings, omit the --global flag to apply configurations locally.
# Example: git config gitai.defaultprovider openai
```

Supported providers: `openai`, `anthropic`, `google`, `cohere`, `groq`, `ollama`, etc.

You can also use the config command:

## How to Use

### Generating Commit Messages

```bash
# Stage your changes
git add .

# Generate a commit message
git message

# Or specify a custom instruction
git message --instructions "Focus on the API changes"
```

### Generating Changelogs

```bash
# Generate changelog from commits
git changelog

# Specify version and detail level
git changelog --version 1.2.0 --detail-level standard

# Generate release notes
git release-notes --version 1.2.0
```

### Other Commands

# Wire operations (syncing)

```bash
git wire
```

## Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

## License

Licensed under the MIT License. See [LICENSE.md](LICENSE.md) for details.