@stephansama/ai-commit-msg

@stephansama / ai-commit-msg

generate commit messages using ai

Table of contents

Open Table of contents

• Installation
• CLI Options
• Usage
  • Husky

Installation

pnpm install @stephansama/ai-commit-msg

CLI Options

Option	Alias	Description	Type
--config	-c	Path to config file	string
--output	-o	Output file for commit-msg	string
--verbose	-v	Enable verbose logging	boolean

Usage

Husky

1. Install and initialize husky

   npm install --save-dev husky && npx husky init

2. create the prepare-commit-msg hook by creating a file located at .husky/prepare-commit-msg

   #!/bin/sh
   
   ai-commit-msg -o "$1"

Modules

Module	Description
ai	‐
arguments	‐
cli	‐
config	‐
index	‐
schema	‐
utilities	‐