CommitAI é um aplicativo de interface de linha de comando que gera automaticamente mensagens de commit com base na saída do git diff. Ele utiliza o poder da API GPT-3 da OpenAI para criar mensagens de commit significativas e descritivas, facilitando o controle das alterações no código. Com o CommitAI, você pode economizar tempo e se concentrar em escrever código, em vez de criar mensagens de commit.
$ npm install --global commitai
ou
$ yarn global add commitai
$ npx commitai [OPTIONS]
ou
$ commitai [OPTIONS]
Observação: você deve ter uma chave de API OpenAI válida para usar o CommitAI. Você pode obter uma chave de API OpenAI. Depois de obter sua chave de API, você deve defini-la como uma variável de ambiente ou executar o seguinte comando antes de usar o CommitAI:
OPENAI_API_KEY=sk- < your-api-key > commitai
ou exporte-o como uma variável de ambiente em seu arquivo .bashrc
ou .zshrc
:
export OPENAI_API_KEY=sk- < your-api-key >
-h, --help
: mostra ajuda-v, --version
: mostra o número da versão-n [number], --numberOfCommitMessages [number]
: Número de mensagens de commit a serem geradas-e, --edit
: Edite a mensagem de commit antes de confirmar--no-e, --no-edit
: Não solicita a edição da mensagem de commit antes de commitar-c, --confirmation
: Confirme a mensagem de commit antes de confirmar--no-c, --no-confirmation
: Não solicita confirmação antes de confirmar