commitprompt

Turn your git diff --staged into a ready-to-paste AI prompt for commit messages, PR descriptions, and changelogs.

Installation

npm install -g @elvatis_com/commitprompt

Or use without installing:

npx @elvatis_com/commitprompt

Usage

Commit message (default)

git add src/my-fix.ts
commitprompt
# Prints a structured prompt - paste it into ChatGPT, Claude, or any LLM

PR description

git add .
commitprompt --mode pr

Changelog entry

commitprompt --mode changelog

Read diff from a file

commitprompt --diff path/to/change.diff
commitprompt --diff path/to/change.diff --mode pr

How it works

1. Reads your staged diff (via git diff --staged) or a diff file
2. Parses the diff: extracts changed files with +/- counts, detects change type (feat, fix, docs, test, ci...)
3. Builds a structured prompt with file list, diff summary, and mode-specific instructions - ready to paste into any LLM

Output example

# Commit Message Request

## Changed Files
- src/error-extractor.ts (+50 -14)

## Diff Summary
\`\`\`diff
diff --git a/src/error-extractor.ts b/src/error-extractor.ts
...
\`\`\`

## Instructions
Write a conventional commit message for these changes.
Format: <type>(<scope>): <description>
Types: feat, fix, docs, refactor, test, chore, ci, perf
Keep the subject line under 72 characters.
If the change is complex, add a body paragraph explaining WHY (not WHAT).

Options

| Flag | Description | Default | | ---- | ----------- | ------- | | --mode <commit\|pr\|changelog> | Output format | commit | | --diff <path> | Read diff from file instead of git | - | | --staged | Explicit staged diff (same as default) | - | | --context | Include package.json name in output | - |

AAHP case study

This tool was built using the AAHP (AI-to-AI Handoff Protocol).

Its sibling project failprompt does the same thing for CI failure logs: turn GitHub Actions errors into structured AI prompts for debugging.

Both tools follow the same 4-module pattern: reader, parser, builder, CLI.

License

MIT