CommitWhiz (cwz)

CommitWhiz is a CLI tool that helps you generate meaningful commit messages using AI (cloud or local models).
It also supports optional auto-push to your remote branch, saving you time when working with Git.

🚀 Features

• AI-powered commit message generation (Cloud or Local model).
• Supports Google Gemini API or local Ollama models.
• Interactive commit message editing (input or editor).
• Auto Git initialization if not already set up.
• Optional autoPush with configurable branch and remote.
• Configurable via whiz.config.js

📦 Installation

npm install -g commitwhiz

After installation, you can use it globally via:

cwz <command>

⚙️ Configuration

At the root of your project, run:

cwz init

This will create a whiz.config.js file in your project root.

Example: whiz.config.js

const { Whiz } = require("commitwhiz");

const whizConfig = Whiz.config({
  key: process.env.API_KEY, // AI key (if using cloud model)
  useTextEditor: false, // Use terminal input or editor
  initializeGitByDefault: true, // Auto-initialize git repo if missing
  autoPush: true, // Auto push after commit
  autoPushOptions: {
    branch: "main", // Branch to push
    remote: "origin", // Remote to push
  },
});

module.exports = whizConfig;

Example: whiz.config.js

import { Whiz } from "commitwhiz";

const whizConfig = Whiz.config({
  key: process.env.API_KEY,
  useTextEditor: false,
  initializeGitByDefault: true,
  autoPush: true, // Auto push after commit
  autoPushOptions: {
    branch: "main", // Branch to push
    remote: "origin", // Remote to push
  },
});

export default whizConfig;

🛠 Usage

Stage some changes:

git add .

Run commit:

cwz commit

Follow the prompts to review or edit the AI-generated commit message.

If autoPush is enabled, your commit will be pushed to the configured branch and remote.

📌 Requirements

• Node.js >= 16
• Git installed
• (Optional) API key if using a cloud AI provider
• (Optional) Ollama installed for local model

🤝 Contributing

PRs are welcome! If you'd like to improve CommitWhiz, feel free to fork the repo and submit a pull request.

📄 License

MIT License © 2025 CommitWhiz Contributors