CommitAI ist eine Befehlszeilenschnittstellenanwendung, die basierend auf der Ausgabe von git diff automatisch Commit-Nachrichten generiert. Es nutzt die Leistungsfähigkeit der GPT-3-API von OpenAI, um aussagekräftige und beschreibende Commit-Nachrichten zu erstellen, wodurch es einfacher wird, den Überblick über Codeänderungen zu behalten. Mit CommitAI können Sie Zeit sparen und sich auf das Schreiben von Code konzentrieren, anstatt Commit-Nachrichten zu erstellen.
$ npm install --global commitai
oder
$ yarn global add commitai
$ npx commitai [OPTIONS]
oder
$ commitai [OPTIONS]
Hinweis: Sie müssen über einen gültigen OpenAI-API-Schlüssel verfügen, um CommitAI verwenden zu können. Sie können einen OpenAI-API-Schlüssel erhalten. Nachdem Sie Ihren API-Schlüssel haben, müssen Sie ihn als Umgebungsvariable festlegen oder den folgenden Befehl ausführen, bevor Sie CommitAI verwenden:
OPENAI_API_KEY=sk- < your-api-key > commitai
oder exportieren Sie es als Umgebungsvariable in Ihre .bashrc
oder .zshrc
Datei:
export OPENAI_API_KEY=sk- < your-api-key >
-h, --help
: Hilfe anzeigen-v, --version
: Versionsnummer anzeigen-n [number], --numberOfCommitMessages [number]
: Anzahl der zu generierenden Commit-Nachrichten-e, --edit
: Bearbeiten Sie die Commit-Nachricht vor dem Commit--no-e, --no-edit
: Bitten Sie nicht, die Commit-Nachricht vor dem Commit zu bearbeiten-c, --confirmation
: Bestätigen Sie die Commit-Nachricht vor dem Commit--no-c, --no-confirmation
: Vor dem Festschreiben nicht zur Bestätigung auffordern