Stars: 162
Forks: 6
Pull Requests: 54
Issues: 2
Watchers: 3
Last Updated: 2023-09-15 21:31:39
Automagically generate conventional git commit messages with AI. - 使用 AI 自动生成约定式 git 提交信息。
License: MIT License
Languages: PHP
Automagically generate conventional git commit messages with AI. - 使用 AI 自动生成约定式 git 提交信息。
curl 'https://raw.githubusercontent.com/guanguans/ai-commit/main/builds/ai-commit' -o ai-commit --progress
chmod +x ai-commit
composer global require guanguans/ai-commit --dev -v # global
composer require guanguans/ai-commit --dev -v # local
./ai-commit config set generators.bito_cli.path bito-cli-path... --global # Config Bito Cli path(Optional)
./ai-commit config set generators.openai.api_key sk-... --global # Config OpenAI API key
./ai-commit config set generators.openai_chat.api_key sk-... --global # Config OpenAI API key
./ai-commit config set generator openai_chat --global # Config default generator(Optional)
./ai-commit commit # Generate and commit message
╰─ ./ai-commit commit --generator=bito_cli --no-edit --no-verify --ansi ─╯
1. Generating commit messages: generating...
[
{
"id": 1,
"subject": "chore(ai-commit): update dimensions and typing speed",
"body": "- Set Width to 1550\n- Set Height to 958\n- Set TypingSpeed to 50ms"
},
{
"id": 2,
"subject": "fix(ai-commit): adjust sleep times and navigation",
"body": "- Type \"git status\" with 50ms sleep\n- Enter 1 with 15s sleep\n- Down@2s 3 with 1s sleep"
},
{
"id": 3,
"subject": "docs(ai-commit): update ai-commit-vhs.gif",
"body": "Binary files a/docs/ai-commit-vhs.gif and b/docs/ai-commit-vhs.gif differ"
}
]
1. Generating commit messages: ✔
2. Choosing commit message: choosing...
+----+------------------------------------------------------+---------------------------------------------------------------------------+
| id | subject | body |
+----+------------------------------------------------------+---------------------------------------------------------------------------+
| 1 | chore(ai-commit): update dimensions and typing speed | - Set Width to 1550 |
| | | - Set Height to 958 |
| | | - Set TypingSpeed to 50ms |
+----+------------------------------------------------------+---------------------------------------------------------------------------+
| 2 | fix(ai-commit): adjust sleep times and navigation | - Type "git status" with 50ms sleep |
| | | - Enter 1 with 15s sleep |
| | | - Down@2s 3 with 1s sleep |
+----+------------------------------------------------------+---------------------------------------------------------------------------+
| 3 | docs(ai-commit): update ai-commit-vhs.gif | Binary files a/docs/ai-commit-vhs.gif and b/docs/ai-commit-vhs.gif differ |
+----+------------------------------------------------------+---------------------------------------------------------------------------+
Please choice a commit message [chore(ai-commit): update dimensions and typing speed]:
[1] chore(ai-commit): update dimensions and typing speed
[2] fix(ai-commit): adjust sleep times and navigation
[3] docs(ai-commit): update ai-commit-vhs.gif
[4] regenerate
> chore(ai-commit): update dimensions and typing speed
2. Choosing commit message: ✔
3. Committing message: ✔
[OK] Successfully generated and committed messages.
╰─ ./ai-commit list ─╯
_____ _____ _ _
/\ |_ _| / ____| (_) |
/ \ | | | | ___ _ __ ___ _ __ ___ _| |_
/ /\ \ | | | | / _ \| '_ ` _ \| '_ ` _ \| | __|
/ ____ \ _| |_ | |___| (_) | | | | | | | | | | | | |_
/_/ \_\_____| \_____\___/|_| |_| |_|_| |_| |_|_|\__|
1.2.5
USAGE: ai-commit <command> [options] [arguments]
commit Automagically generate conventional commit messages with AI.
completion Dump the shell completion script
config Manage config options.
self-update Allows to self-update a build application
thanks Thanks for using this tool.
./ai-commit config [set, get, unset, reset, list, edit] key value --global
./ai-commit config set key value
./ai-commit config get key
./ai-commit config unset key
./ai-commit config reset key
./ai-commit config list
./ai-commit config edit
╰─ ./ai-commit self-update ─╯
Checking for a new version...
=============================
[OK] Updated from version 1.2.4 to v1.2.5.
╰─ ./ai-commit commit --help ─╯
Description:
Automagically generate conventional commit messages with AI.
Usage:
commit [options] [--] [<path>]
Arguments:
path The working directory [default: "/Users/yaozm/Documents/develop/ai-commit"]
Options:
--commit-options[=COMMIT-OPTIONS] Append options for the `git commit` command [default: ["--edit"]] (multiple values allowed)
--diff-options[=DIFF-OPTIONS] Append options for the `git diff` command [default: [":!*.lock",":!*.sum"]] (multiple values allowed)
-g, --generator=GENERATOR Specify generator name [default: "openai_chat"]
-p, --prompt=PROMPT Specify prompt name of messages generated [default: "conventional"]
--no-edit Enable or disable git commit `--no-edit` option
--no-verify Enable or disable git commit `--no-verify` option
-c, --config[=CONFIG] Specify config file
--retry-times=RETRY-TIMES Specify times of retry [default: 3]
--retry-sleep=RETRY-SLEEP Specify sleep milliseconds of retry [default: 200]
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
--env[=ENV] The environment the command should run under
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.