OpenAI `gpt-4o-mini` Model「default」Node.js >= 16.5.0+ ​

Let the AI generate your git commit message subject ^{(short description)}

CZ_OPENAI_API_KEY="sk-xxxxx" npx czg ai

CZ_OPENAI_API_KEY="sk-xxxxx" npx czg ai

CZ_OPENAI_API_KEY="sk-xxxxx" bunx czg ai

CZ_OPENAI_API_KEY="sk-xxxxx" bunx czg ai

Setup OpenAI token ​

1. https://platform.openai.com/account/api-keys
   Login and create your API secret key, which usually starts with sk-
2. Run command npx czg --api-key=<API secret key> and input your key to setup your token save to local

npx czg --api-key=sk-xxxxx

npx czg --api-key=sk-xxxxx

bunx czg --api-key=sk-xxxxx

bunx czg --api-key=sk-xxxxx

czg --api-key=sk-xxxxx

czg --api-key=sk-xxxxx

As global usage ​

npm install -g czg

npm install -g czg

brew install czg

brew install czg

# setup your token `czg --api-key=sk-xxxxx`
# Run the following command in any of your projects after setup OpenAI token
czg ai
# Return multiple subjects, and choose the suitable answer
git czg ai -N=5

# setup your token `czg --api-key=sk-xxxxx`
# Run the following command in any of your projects after setup OpenAI token
czg ai
# Return multiple subjects, and choose the suitable answer
git czg ai -N=5

As a dev dependency usage ​

npm install -D czg

npm install -D czg

yarn add -D czg

yarn add -D czg

pnpm install -D czg

pnpm install -D czg

1. Add script in package.json
   
2. Try run npm cz ai | yarn cz ai | pnpm cz ai after setup token

{
  "scripts": {
    "cz": "czg"
  }
}

{
  "scripts": {
    "cz": "czg"
  }
}

npx usage ​

• Run the following command in any of your projects after setup OpenAI token

npx czg ai

npx czg ai

bunx czg ai

bunx czg ai

Return multiple subjects, and choose the suitable answer

npx czg ai -N=5

npx czg ai -N=5

bunx czg ai -N=5

bunx czg ai -N=5

Commitizen CLI + cz-git usage ​

If you are currently using Commitizen CLI with the cz-git adapter:

There are three ways to configure the OpenAI API Key: ​

1. Run czg to configure it: npx czg --api-key=sk-xxxxx
2. Pass it as an environment variable and start: CZ_OPENAI_API_KEY="sk-xxxxx" czai=1 cz
3. Configure it in an environment variable in your rc file: Add export CZ_OPENAI_API_KEY="sk-xxxxx" to .zshrc or .bashrc.

There are two ways to turn on AI mode: ​

1. Pass czai=1 as an environment variable and start: czai=1 cz
2. Enable AI mode in the configuration file: useAI: true

Configure ​

• If you configure useAI to true, and you want to switch to normal mode not AI prompt mode in this session
  • czg CLI: czg --no-ai
  • Commitizen CLI + cz-git: no_czai=1 cz
• If you want to customize the prompt words sent to OpenAI (like support i18n), you can use aiQuestionCB option
• The AI configure options information see : Options - AI Related
• About project or global support configure file information see: Configure Template

How it works ​

• Run git diff to obtain difference code information, combine prompt task, send them to OpenAI API - /chat/completions, Return the subjects information generated by AI.
• 💡 Inspired by aicommits and modified part of the code