ai_commit

Description:

ai commit

ai_commit #






Dart CLI for generated git commit messages with OpenAI.

Quick Started 🚀 #
Installing
dart pub global activate ai_commit
copied to clipboard
Or install a specific version using:
dart pub global activate ai_commit <version>
copied to clipboard
Commands #
ai_commit -h #
See the complete list of commands and usage information.
Dart CLI for generated commit messages with OpenAI.

Usage: ai_commit <command> [arguments]

Global options:
-h, --help Print this usage information.
-a, --all Automatically stage changes in tracked files for the commit
-c, --count Count of messages to generate (Warning: generating multiple costs more)
-m, --model Locale language for commit message.
-x, --exclude Files to exclude from AI analysis
-l, --max-length Set max length of commit message.
--locale Locale language for commit message.
--[no-]conventional Format the commit message according to the Conventional Commits specification.
-v, --version Print the current version.
--[no-]verbose Noisy logging, including all shell commands executed.

Available commands:
config ai_commit configuration
update Update the CLI.

Run "ai_commit help <command>" for more information about a command.
copied to clipboard
ai_commit config #
Save data configuration and use later.
ai_commit configuration

Usage: ai_commit config [arguments]
-h, --help Print this usage information.
--key OpenAI API key.
--locale Set locale language.
--count Generate commit message count.
--[no-]conventional Format the commit message according to the Conventional Commits specification.
--model Set model name for OpenAI API.
--max-length Set max length of commit message.

Run "ai_commit help" to see global options.
copied to clipboard
Usage #
Before using you need to set OpenAI API key
ai_commit config --key sk-xxx
copied to clipboard
Generate commit message
ai_commit
copied to clipboard
Add all files and generate a commit message
ai_commit -a
copied to clipboard
Count of messages to generate (Warning: generating multiple costs more)
# one time use
ai_commit -c 2

# save data to config
ai_commit config -c 2
copied to clipboard
OpenAI model to use for generation
# one time use
ai_commit -m gpt-3.5-turbo-1106

# save data to config
ai_commit config -m gpt-3.5-turbo-1106
copied to clipboard
Files to exclude from AI analysis
# single
ai_commit -x test.dart

# multiple
ai_commit -x one.dart, two.dart
copied to clipboard
Max length of commit message
# one time use
ai_commit -l 200

# save data to config
ai_commit config -l 200
copied to clipboard
Locale language for commit message
# one time use
ai_commit --locale en

# save data to config
ai_commit config --locale en
copied to clipboard
Format the commit message according to the Conventional Commits specification.
# one time use
ai_commit --conventional

# save data to config
ai_commit config --conventional
copied to clipboard
Disable Conventional Commits Format
ai_commit --no-conventional

# save data to config
ai_commit config --no-conventional
copied to clipboard