Skip to content
On this page

czg ai

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

demo-gif

Synopsis

czg ai - Turn on OpenAI generate subject mode

Preparation

Get your OpenAI API Key: https://platform.openai.com/account/api-keys

sh
czg --api-key=sk-xxxxx
czg --api-key=sk-xxxxx

Options

Shorthand, NameDescription
-N=<number>
--ai-num=<number>
Setting AI return number subjects and Turn on choose mode
--no-aiTurn off AI prompt mode in this session
--api-key=<token>Setup OpenAI API secret key to local (.config/.czrc)
--api-proxy=<proxy_URL>Setup request OpenAI API proxy to local (.config/.czrc)
e.g:
1. npx czg --api-proxy="socks5://127.0.0.1:1080"
2. npx czg --api-proxy="http://127.0.0.1:1080"
--api-endpoint=<url>Setup request OpenAI API endpoint to local
Default "https://api.openai.com/v1"
--unset-proxyUnset request API proxy on local configure

TIP

more information and usage ⇒ see the recipes

I just try my best to make thing well, Could you give a star ⭐