whatisgithub

What is git-commit-craft?

pegasusdev18/git-commit-craft — explained in plain English

Analysis updated 2026-05-18

13JavaScriptAudience · developerComplexity · 2/5LicenseSetup · easy

In one sentence

A CLI tool that uses Google's Gemini AI to write Conventional Commit messages and generate README files for your project.

Mindmap

mindmap
  root((repo))
    What it does
      AI generated commits
      AI generated README
      Interactive review
    Tech stack
      Node.js
      Gemini API
      Commander CLI
    Use cases
      Speed up commit writing
      Draft project README
      Enforce commit conventions
    Audience
      Developers
      Open source maintainers
    Requirements
      Gemini API key
      Node 18 or newer

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Generate a Conventional Commits compliant message automatically from your staged git changes.

USE CASE 2

Draft a professional README.md file by scanning your project's structure and package.json.

USE CASE 3

Review, edit, or regenerate an AI-suggested commit message before committing.

USE CASE 4

Standardize commit message formatting across a team or open source project.

What is it built with?

Node.jsGemini APICommanderInquirerOraChalk

How does it compare?

pegasusdev18/git-commit-craft09catho/axonabdulrdeveloper/react--tic-tac-toe
Stars131313
LanguageJavaScriptJavaScriptJavaScript
Setup difficultyeasymoderateeasy
Complexity2/54/51/5
Audiencedeveloperresearcherdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires a free Gemini API key from Google AI Studio and Node.js 18 or newer.

Licensed under MIT, which allows free use, modification, and distribution, including commercially, as long as you keep the license notice.

So what is it?

git-commit-craft is a command line tool built with Node.js that uses Google's Gemini AI model to handle two common but tedious developer tasks: writing well-formed commit messages and drafting README files. Instead of staring at a blank prompt trying to summarize a code change, or writing project documentation from scratch, a developer can run one of two commands and let the AI generate a draft based on the actual project content. For commit messages, the tool reads the output of git diff, either for changes already staged or, if nothing is staged, for unstaged changes instead. It sends that diff to the Gemini model along with instructions to follow the Conventional Commits format, a widely used standard for structuring commit messages. The AI's suggested message is shown in the terminal, and the developer can accept it as is, edit it, ask for a new version, or cancel entirely before anything is committed to the repository. For README generation, the tool scans the project's folder structure, figures out which programming language is used most based on file extensions, and reads details from the package.json file if one exists, such as the project name, dependencies, and available scripts. It sends all of that information to the same AI model with instructions to write a complete, professional README, then saves the result directly to a README.md file, asking first if one already exists. Using the tool requires a free Gemini API key from Google AI Studio, which can either be typed in interactively the first time a command runs, where it gets saved locally on your computer, or set as an environment variable. The README notes that Google now requires these API keys to be restricted to a specific API address, and that keys created directly through Google AI Studio already meet that requirement automatically. The project is installed by cloning the repository, running npm install, and linking it so the command becomes available from any git repository on the same machine, and it is released under the MIT license.

Copy-paste prompts

Prompt 1
Walk me through installing git-commit-craft and linking it globally with npm.
Prompt 2
Help me set up a Gemini API key for git-commit-craft using an environment variable.
Prompt 3
Explain how git-commit-craft turns a git diff into a Conventional Commits message.
Prompt 4
What happens if I run craft-readme in a project that already has a README.md file?

Frequently asked questions

What is git-commit-craft?

A CLI tool that uses Google's Gemini AI to write Conventional Commit messages and generate README files for your project.

What language is git-commit-craft written in?

Mainly JavaScript. The stack also includes Node.js, Gemini API, Commander.

What license does git-commit-craft use?

Licensed under MIT, which allows free use, modification, and distribution, including commercially, as long as you keep the license notice.

How hard is git-commit-craft to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is git-commit-craft for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.