Installation

Install and set up nocommit.

Getting nocommit up and running takes less than a minute. Let's walk through it.

Prerequisites

  • Node.js (v18 or higher)
  • Git installed and configured
  • A Gemini API key from Google AI Studio

Quick Install

Install nocommit globally using your package manager of choice.

npm

npm install -g nocommit

That's it! You can now use nocommit from anywhere in your terminal.

Homebrew (macOS/Linux)

Install via Homebrew tap:

brew tap asimar007/no-commit https://github.com/asimar007/no-commit
brew install nocommit

API Key Setup

nocommit needs a Gemini API key to generate commit messages. Set the key so nocommit can use it:

nocommit config set GEMINI_API_KEY=<your_api_key>

This stores your configuration securely using conf.

Note: If you haven't already, you'll need to create an account at Google AI Studio and get your API key. It's free to get started!

Verify Installation

Check that nocommit is installed correctly:

nocommit --version

You should see the current version number (e.g., 0.0.4). If you do, you're all set!

Upgrading

Check the installed version with:

nocommit --version

If it's not the latest version, run:

npm update -g nocommit

Or if you installed via Homebrew:

brew update
brew upgrade nocommit

Having trouble? Check out our FAQ or open an issue on GitHub.