Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 1.34 KB

README.md

File metadata and controls

60 lines (37 loc) · 1.34 KB

Porunga - A CLI tool to suggest commit messages

A simple tool to suggest commit messages.

Porunga Usage

Prerequisites

  • Make sure you are using Python version >3.11
  • This tool requires OPENAI API Key to work. Please see this

Installation

pip install porunga

Usage

  • To see a list of commands availabe to use:
porunga --help
  • To get information about a specific command , use:
porunga COMMAND --help

Example:

porunga set-env --help
  • To set env variables, it is recommended to use set-env command
porunga set-env OPENAI_API_KEY=sk-....

You can set the following env variables that this tool uses:

  • OPENAI_API_KEY : API key from OpenAI
  • PORUNGA_MODEL_NAME : Open AI Model to use
  • PORUNGA_MODE : Either cost or precise or balanced. It is recommended to precise for the best results

This CLI tool uses gpt-4o by default, which is recommended.

  • To get suggestions
porunga suggest FILEPATH -n 2

This generates 2 suggestions for the particular uncommitted changes.

Warning

The results generated by this tool can be unpredictable and may produce inconsistent results. Users are advised to review and verify the suggestions before using them.