Installation

gitcomm ships as a single executable with no native modules, so installation is a single command on any platform Node runs on.

Requirements

• Node.js 20.12.0 or newer. Check with node --version.
• Git on your PATH, which it is on any normal development machine.
• A Git repository with at least one commit. Style detection reads your history, so an empty repository gives gitcomm nothing to learn from.

One-off run

Nothing to install. Your package manager downloads the package, runs it, and cleans up:

npx gitcomm

The package is cached after the first run, so later invocations start immediately. This is the recommended way to try gitcomm.

Globally

Install once and call gitcomm from any repository:

npm install -g gitcomm

As a project dependency

Pin the version for a team so everyone generates messages the same way:

npm install --save-dev gitcomm

Then run it through your package manager:

npx gitcomm

Updating

Check which version you have:

npx gitcomm --version

For a global install, update with your package manager:

npx gitcomm@latest