aichangelog
| Crates.io | aichangelog |
| lib.rs | aichangelog |
| version | 0.1.0 |
| created_at | 2023-04-05 21:04:38.565352+00 |
| updated_at | 2023-04-05 21:04:38.565352+00 |
| description | A CLI tool to generate a changelog based on your commit messages. |
| homepage | https://github.com/Sett17/aichangelog |
| repository | https://github.com/Sett17/aichangelog |
| max_upload_size | |
| id | 831403 |
| size | 66,119 |
Raik Rohde (Sett17)
documentation
https://github.com/Sett17/aichangelog
README
aichangelog
aichangelog is a CLI tool written in Rust, that generates a changelog based on your Git commit messages. It leverages OpenAI's conversational models to produce a human-readable, Markdown-formatted changelog.
Installation
aichangelog can be easily installed with Cargo, Rust's package manager. Simply run the following command:
cargo install aichangelog
Please note that in order to use aichangelog, you will need to set the OPENAI_API_KEY environment variable. This API key is required to use the OpenAI language models, which is used by aichangelog to generate commit messages.
Usage
Generating Conventional Commits with aichangelog
| Short | Long | Description | Default |
|---|---|---|---|
| -s | --short | Only use first line of commit message to reduce tokens | |
| -t | --temp |
Temperature for AI 0.0 - 2.0 | 1.0 |
| -f | --freq |
Frequency Penalty for AI -2.0 - 2.0 | 0.0 |
| -m | --model |
Model to use | gpt-3.5-turbo |
| -h | --help | Print help | |
| -V | --version | Print version |
Getting Help with aichangelog
To get help with using aichangelog, you can use the -h or --help option
$ aichangelog --help
This will display the help message with information on how to use the tool.