liblaf-lime 0.3.16
🍋‍🟩 AI-powered Git commit assistant and repository documentation generator
Requires Python: >=3.12

<div align="center" markdown>
<a name="readme-top"></a>

[![lime](https://socialify.git.ci/liblaf/lime/image?description=1&forks=1&issues=1&language=1&logo=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fmicrosoft%2Ffluentui-emoji%2Fassets%2FLime%2F3D%2Flime_3d.png&name=1&owner=1&pattern=Transparent&pulls=1&stargazers=1&theme=Auto)](https://github.com/liblaf/lime)

**[Explore the docs »](https://liblaf.github.io/lime/)**

<!-- tangerine-start: badges/python.md -->

[![codecov](https://codecov.io/gh/liblaf/lime/graph/badge.svg)](https://codecov.io/gh/liblaf/lime)
[![MegaLinter](https://github.com/liblaf/lime/actions/workflows/mega-linter.yaml/badge.svg)](https://github.com/liblaf/lime/actions/workflows/mega-linter.yaml)
[![Test](https://github.com/liblaf/lime/actions/workflows/test.yaml/badge.svg)](https://github.com/liblaf/lime/actions/workflows/test.yaml)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/liblaf/lime/main.svg)](https://results.pre-commit.ci/latest/github/liblaf/lime/main)
[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/liblaf/lime)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/liblaf-lime?logo=PyPI&label=Downloads)](https://pypi.org/project/liblaf-lime)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/liblaf-lime?logo=Python&label=Python)](https://pypi.org/project/liblaf-lime)
[![PyPI - Version](https://img.shields.io/pypi/v/liblaf-lime?logo=PyPI&label=PyPI)](https://pypi.org/project/liblaf-lime)

<!-- tangerine-end -->

[Changelog](https://github.com/liblaf/lime/blob/main/CHANGELOG.md) · [Report Bug](https://github.com/liblaf/lime/issues) · [Request Feature](https://github.com/liblaf/lime/issues)

![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)

</div>

## ✨ Features

- 🤖 **AI-Powered Commit Messages**: Automatically generates meaningful commit messages using LLMs that analyze git diffs and follow conventional commit standards
- 🎯 **Interactive Workflow**: Provides an intuitive command-line interface with interactive prompts for confirming or editing generated commit messages
- 📁 **Smart Context Awareness**: Uses repomix to intelligently include relevant repository files while ignoring generated and unnecessary files
- 🔧 **Highly Configurable**: Supports multiple LLM providers (DeepSeek, Qwen) with customizable temperature settings and model fallbacks
- 🎨 **Rich Terminal Experience**: Features beautiful console output with live streaming responses and formatted commit message previews
- 📚 **Template-Based Prompts**: Utilizes Jinja2 templates for flexible and customizable prompt engineering

## 📦 Installation

To install `liblaf-lime`, run the following command:

```bash
uv add liblaf-lime
```

## ⌨️ Local Development

You can use Github Codespaces for online development:

[![](https://github.com/codespaces/badge.svg)](https://codespaces.new/liblaf/lime)

Or clone it for local development:

```bash
gh repo clone liblaf/lime
cd lime
mise run install
```

## 🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues](https://github.com/liblaf/lime/issues) to get stuck in to show us what you're made of.

[![](https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge)](https://github.com/liblaf/lime/pulls)

[![Contributors](https://contrib.nn.ci/api?repo=liblaf/lime)](https://github.com/liblaf/lime/graphs/contributors)

## 🔗 More Fruits

<!-- tangerine-start: projects/fruits.md -->

- **[🍇 Grapes](https://github.com/liblaf/grapes)** - Supercharge your Python with rich logging, precise timing, and seamless serialization.
- **[🍉 Melon](https://github.com/liblaf/melon)** - A comprehensive Python library for 3D mesh processing with advanced I/O capabilities, proximity analysis, and integration with external mesh processing tools.
- **[🍊 Tangerine](https://github.com/liblaf/tangerine)** - Squeeze dynamic content into your files with Tangerine's template magic.
- **[🍋‍🟩 Lime](https://github.com/liblaf/lime)** - AI-powered Git commit assistant and repository documentation generator
- **[🍎 Apple](https://github.com/liblaf/apple)** - A JAX and Warp library for differentiable physics simulation, featuring elastic energy models and finite element methods.
- **[🍒 Cherries](https://github.com/liblaf/cherries)** - Sweet experiment tracking with Comet, DVC, and Git integration.
<!-- tangerine-end -->

---

#### 📝 License

Copyright © 2025 [liblaf](https://github.com/liblaf). <br />
This project is [MIT](https://github.com/liblaf/lime/blob/main/LICENSE) licensed.