a CLI that helps you write better commit messages

Please consider following this project's author, Sina Bayandorian, and consider starring the project to show your ❤️ and support.

• Usage
• Commit Types
• AI-Powered Commit Message Checking
• Examples

Clone the repository:

git clone https://github.com/sina-byn/gitt.git

Install dependencies:

cd gitt && npm i

Build:

npm run build

Initialize:

npx gitt

To use globally:

npm i -g .

Then use wherever you want:

gitt <?commit_type> <?commit_message>

? : optional argument

To enable AI-powered commit message typo detection and correction, you need to create a .env file at the root of the repository. This file should contain the following environment variables, based on the .env.example file:

CF_API_KEY=your_cloudflare_ai_worker_api_key
CF_ACCOUNT_ID=your_cloudflare_account_id

When these environment variables are provided, the AI will automatically check your commit messages for typos and suggest corrections. If you wish to skip this step, use the --no-check flag:

gitt --no-check

If the environment variables are not provided, the AI-powered check will be skipped by default.

gitt

gitt feat

gitt fix "bug fixed"