https://github.com/dnanhkhoa/acm

A dead-simple AI-powered CLI tool for effortlessly crafting meaningful Git commit messages
https://github.com/dnanhkhoa/acm

ai cli commit-message git-commit gpt llm

Last synced: 15 days ago
JSON representation

A dead-simple AI-powered CLI tool for effortlessly crafting meaningful Git commit messages

• Host: GitHub
• URL: https://github.com/dnanhkhoa/acm
• Owner: dnanhkhoa
• License: apache-2.0
• Created: 2024-01-07T11:02:58.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-24T12:00:23.000Z (6 months ago)
• Last Synced: 2024-12-16T13:44:54.436Z (23 days ago)
• Topics: ai, cli, commit-message, git-commit, gpt, llm
• Language: Rust
• Homepage:
• Size: 587 KB
• Stars: 23
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome_ai_agents - Acm - A dead-simple AI-powered CLI tool for effortlessly crafting meaningful Git commit messages (Building / Tools)
• awesome_ai_agents - Acm - A dead-simple AI-powered CLI tool for effortlessly crafting meaningful Git commit messages (Building / Tools)

README

        
# AI Commit Message `acm`

A dead-simple AI-powered CLI tool for effortlessly crafting meaningful Git commit messages.

![Demo](assets/demo.gif)

## Features

- Effortlessly create meaningful commit messages

- Supports the [Conventional Commits standard](https://www.conventionalcommits.org)

- Customizable prompts

- JSON mode support

- Compatible with various LLM API providers, including [OpenAI](https://openai.com), [OpenRouter](http://openrouter.ai), [Together AI](https://www.together.ai), [Anyscale](https://www.anyscale.com), [Groq](https://groq.com) and more

## Installation

Before installing `acm`, please ensure that you have [git](https://git-scm.com) installed on your system.

### Via Cargo

To install `acm` from source using `Cargo`, run the following command:

```sh

cargo install --locked acm-cli

```

### Via Homebrew

```sh

brew install dnanhkhoa/tap/acm

```

## Usage

To generate a commit message and commit your changes, simply use `acm` as a replacement for `git commit`:

```sh

# Stage your changes

git add 

# Generate a commit message and commit your changes

acm

```

## License

`acm` is licensed under the [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/)