Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m1guelpf/auto-commit
A CLI tool that automatically writes commit messages for you.
https://github.com/m1guelpf/auto-commit
Last synced: 6 days ago
JSON representation
A CLI tool that automatically writes commit messages for you.
- Host: GitHub
- URL: https://github.com/m1guelpf/auto-commit
- Owner: m1guelpf
- License: mit
- Created: 2022-10-30T17:09:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-15T00:41:30.000Z (9 months ago)
- Last Synced: 2024-12-01T12:02:31.816Z (20 days ago)
- Language: Rust
- Size: 18.6 KB
- Stars: 1,198
- Watchers: 11
- Forks: 54
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- starred - m1guelpf/auto-commit - A CLI tool that automatically writes commit messages for you. (Rust)
README
# Automagically-generated commit messages
A CLI tool that generates commit messages from your staged changes, built in Rust and using [OpenAI's GPT-3.5](https://platform.openai.com/overview).
## Installation
You can install `auto-commit` by running the following command in your terminal.
```
curl -fsSL https://raw.githubusercontent.com/m1guelpf/auto-commit/main/install.sh | sh -
```
Or, if you're an arch user, you can download it from the [AUR](https://aur.archlinux.org/) using
```sh
yay -S auto-commit
```
You may need to close and reopen your terminal after installation. Alternatively, you can download the binary corresponding to your OS from the [latest release](https://github.com/m1guelpf/auto-commit/releases/latest).
## Usage
`auto-commit` uses GPT-3.5. To use it, grab an API key from [your dashboard](https://beta.openai.com/), and save it to `OPENAI_API_KEY` as follows (you can also save it in your bash/zsh profile for persistance between sessions).
```bash
export OPENAI_API_KEY='sk-XXXXXXXX'
```
Once you have configured your environment, stage some changes by running, for example, `git add .`, and then run `auto-commit`.
Of course, `auto-commit` also includes some options, for editing the message before commiting, or just printing the message to the terminal.
```sh
$ auto-commit --help
Automagically generate commit messages.
Usage: auto-commit [OPTIONS]
Options:
-v, --verbose... More output per occurrence
-q, --quiet... Less output per occurrence
--dry-run Output the generated message, but don't create a commit.
-r, --review Edit the generated commit message before committing.
-h, --help Print help information
-V, --version Print version information
```
## Develop
Make sure you have the latest version of rust installed (use [rustup](https://rustup.rs/)). Then, you can build the project by running `cargo build`, and run it with `cargo run`.
## License
This project is open-sourced under the MIT license. See [the License file](LICENSE) for more information.