Commitprompt

Write the commit. Not the syntax.

Commitprompt is a focused, package-manager-neutral prompt for Conventional Commits. It checks staged changes, guides the author through the message, validates with included Commitlint rules or the repository's own configuration, previews the result, and commits only after confirmation.

Install

pnpm add --save-dev @santi020k/commitprompt
npm install --save-dev @santi020k/commitprompt
yarn add --dev @santi020k/commitprompt

{
  "scripts": {
    "commit": "commitprompt"
  }
}

Then stage your intended changes and run pnpm commit, npm run commit, or yarn commit. Commitprompt supplies Conventional Commits rules by default and honors the repository's Commitlint configuration when one is present.

Commitlint rules—including disabled length limits, custom types, parser presets, plugins, and ignores—are covered in the package documentation. The same guide explains the current Git hook boundary and AI integration API.

AI agents can discover repository types, format structured input, validate a message, and create an explicitly authorized commit without driving the interactive prompt. See the packaged AI agent guide.

Editor AI

Run commitprompt setup zed or commitprompt setup vscode to configure the editor's native commit-message generator for Conventional Commits across every project.

Repository

• packages/commitprompt — public CLI and programmatic API
• apps/docs — Astro documentation website built with Lumen

Development

pnpm install
pnpm run dev
pnpm run validate

User-visible package changes require a Changeset:

pnpm changeset

License

MIT