nyegosh v0.2.4

Generate AI Commit message

Nyegosh is a command-line tool that helps generate commit messages adhering to the Conventional Commit standard. Once installed globally, simply run the nyegosh command to generate well-structured, meaningful commit messages that follow the conventional commit guidelines.

Developed by the DevBoost Lab team during an AI Hackathon organized within Symphony company, where innovative solutions and AI-driven tools were created to enhance developer workflows.

Get Started

Install

To install the package globally and use it as a command line tool, run:

npm install -g nyegosh

Or you can install it locally in your project as a dev dependency:

npm install nyegosh -D

Connect to Your Platform

To setup global environment variables through CLI wizard, run:

OpenAI

nyegosh-connect openai

Azure

nyegosh-connect azure

Installation wizard will ask you for the environment variables and save them to local .nyegosh.env file.

Example .env file

# OpenAI
NYEGOSH_OPENAI_API_KEY=your-api-key-here

# Azure
NYEGOSH_AZURE_OPENAI_API_KEY=your-api-key-here
NYEGOSH_AZURE_OPENAI_ENDPOINT=your-endpoint-here
NYEGOSH_AZURE_OPENAI_API_VERSION=2024-08-01-preview

# mutual
NYEGOSH_GENERATOR_DEPLOYMENT=gpt-4o

After installation, you can run nyegosh to generate a commit message.

Use in your project

After staging changes, generate commit message simply by running the command:

nyegosh

Or generate release notes for changes between two specific commits by running:

nyegosh-release-notes commit-hash-older commit-hash-newer