Skip to content

Commit with intent

npm / pnpm / Yarn

Write the commit. Not the syntax.

Turn staged work into a clear, validated Conventional Commit. Keep the rules your repository trusts and the tools you already use.

A small tool. A clearer history.

A commit, from start to finishCLI
commitprompt · ~/project
$ pnpm commit

Select the type of change:
  1. feat     A new feature
  2. fix      A bug fix
  3. docs     Documentation only

Type: 1
Scope: cli
Description: add repository-aware validation

feat(cli): add repository-aware validation

Create this commit? [y/N] y
Validated. Reviewed. Ready for the history.

Start with one command

Your next commit starts here.

Install it as a development dependency.

shell
pnpm add --save-dev @santi020k/commitprompt

Then add "commit": "commitprompt" to your package scripts. Or let project setup do it.

Runtime
Node.js 22.18+
Works with
npm · pnpm · Yarn
Conventions
Your Commitlint rules

01 / Fits the way you work

One small command.
Your whole repository.

Focused on the moment between staging a change and giving it a useful place in your history.

Your rules, already understood.

Use the included Conventional Commits rules or the Commitlint configuration already in your repository.

At home in your toolchain.

Install and run the same neutral binary with npm, pnpm, or Yarn. No adapter configuration needed.

The decision stays yours.

Review the complete message before anything is committed. Your Git hooks still have the final say.

02 / A familiar rhythm

Stage. Prompt. Commit.

A short path to a useful message, with a check at every boundary.

  1. Stage the change

    Stage the work you mean to commit. An empty index stops the flow before the first prompt.

    git add src/
  2. Find the right words

    Choose a type, add a scope, and describe the change. Include extra context only when it helps.

    commitprompt
  3. Commit with confidence

    Validate the finished message, review it, and confirm. Commitprompt passes it directly to Git.

    feat(cli): add validation

03 / Room for the full story

Small prompt.
Complete context.

Keep the everyday commit short. Add a body, a breaking change, or an issue reference when the work calls for more.

Explore the message format
One message, all the detailExample
feat(cli)!: add repository-aware validation

Keep commit messages consistent across the team.

BREAKING CHANGE: require Node.js 22.18 or newer
Closes #123
Header
What changed
Body
Why it matters
Footer
What comes next

04 / Beyond the prompt

The same rules.
Every way you commit.

Give AI tools repository-aware instructions and bring Conventional Commit guidance into your editor. Discover types and scopes, format structured input, and validate the exact result.

Read the automation guide

Ready when the index is

Leave a clearer history.

The next person reading it might be you.

Make your first commit