Crates.io | commitaura |
lib.rs | commitaura |
version | 1.0.5 |
source | src |
created_at | 2024-09-20 09:05:02.472246 |
updated_at | 2024-10-08 02:03:20.382881 |
description | Intelligent Git commit assistant with README integration |
homepage | |
repository | https://github.com/alexfigueroa-solutions/commitaura |
max_upload_size | |
id | 1381033 |
size | 48,073 |
An Intelligent Git Commit Assistant with README Integration
Commitaura enhances your Git workflow by generating concise, meaningful commit messages and suggesting updates to your README based on staged changes. Leveraging OpenAI's GPT models, it provides context-aware suggestions that save time and improve documentation quality.
Install Commitaura directly using Cargo:
cargo install commitaura
Note: If Commitaura is not yet published on crates.io, you can install it from the Git repository:
cargo install --git https://github.com/alexfigueroa-solutions/commitaura.git
This command compiles the project and installs the commitaura
binary to Cargo's bin directory, which is typically included in your system's PATH (~/.cargo/bin
).
If you prefer to build Commitaura from the source code:
Clone the Repository
git clone https://github.com/alexfigueroa-solutions/commitaura.git
Navigate to the Project Directory
cd commitaura
Build and Install the Project
Use Cargo to build and install the project:
cargo install --path .
This command compiles the project and installs the commitaura
binary to Cargo's bin directory.
Commitaura requires an OpenAI API key to function. You can set it up using one of the following methods:
Environment Variable
Add the API key to your shell profile (e.g., ~/.bashrc
, ~/.zshrc
):
export OPENAI_API_KEY=your-api-key-here
.env File
In your home directory or project root, create a .env
file:
echo "OPENAI_API_KEY=your-api-key-here" > ~/.commitaura.env
Commitaura will automatically load the API key from this file.
Commitaura provides several commands to streamline your Git operations.
commit
: Automatically generate a commit message and commit staged changes.update-readme
: Generate suggestions to update your README.md based on staged changes.commit-and-update
: Perform a commit and update the README in one step.commitaura commit
commitaura update-readme
commitaura commit-and-update
commit
and update-readme
.Commitaura relies on an OpenAI API key for generating messages.
Environment Variable
Add the API key to your shell profile:
export OPENAI_API_KEY=your-api-key-here
.env File
Create a .env
file in your home directory or project root:
echo "OPENAI_API_KEY=your-api-key-here" > ~/.commitaura.env
Commitaura will automatically load the API key from this file.
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
This project is licensed under the MIT License.
Developed by Alex Figueroa.