Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guanguans/ai-commit
Automagically generate conventional git commit messages with AI. - 使用 AI 自动生成约定式 git 提交信息。
https://github.com/guanguans/ai-commit
ai bito changelog chat chatgpt commit commit-message commitizen commitlint conventional conventional-commit copilot git git-diff github gpt keepachangelog model models openai
Last synced: 1 day ago
JSON representation
Automagically generate conventional git commit messages with AI. - 使用 AI 自动生成约定式 git 提交信息。
- Host: GitHub
- URL: https://github.com/guanguans/ai-commit
- Owner: guanguans
- License: mit
- Created: 2023-01-30T09:20:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T21:39:17.000Z (5 days ago)
- Last Synced: 2025-01-07T22:41:06.535Z (4 days ago)
- Topics: ai, bito, changelog, chat, chatgpt, commit, commit-message, commitizen, commitlint, conventional, conventional-commit, copilot, git, git-diff, github, gpt, keepachangelog, model, models, openai
- Language: PHP
- Homepage:
- Size: 116 MB
- Stars: 372
- Watchers: 6
- Forks: 22
- Open Issues: 0
-
Metadata Files:
- Readme: README-ja.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-chatgpt - ai-commit - Automatically generate conventional Git commit messages. (CLI tools / Examples)
- awesome-chatgpt - ai-commit - Automagically generate conventional commit messages with AI
- fucking-awesome-chatgpt - AI Commit - Automagically generate conventional commit messages with AI
- awesome-chatgpt - AI Commit - Automagically generate conventional commit messages with AI
- awesome-ChatGPT-repositories - ai-commit - Automagically generate conventional git commit messages with AI. - 使用 AI 自动生成约定式 git 提交信息。 (Openai)
- awesome-laravel-zero - AI Commit
- awesome-chatgpt - ai-commit
- awesome-chatgpt - ai-commit - Automatically generate conventional Git commit messages. (CLI tools / Examples)
- Awesome-ChatGPT - AI Commit - Automagically generate conventional commit messages with AI
- awesome-gpt - ai-commit
- awesome-chatgpt-zh - AI Commit - 使用 AI 自动生成常规提交消息
README
# ai-commit
[//]: # (https://looka.com)
[//]: # (
)
[ENGLISH](README.md) | [日本語](README-ja.md) | [简体中文](README-zh_CN.md) | [繁體中文](README-zh_TW.md)
> Automagically generate conventional git commit message with AI. - 使用 AI 自动生成约定式 git 提交信息。
[](https://github.com/guanguans/ai-commit/actions)
[](https://github.com/guanguans/ai-commit/actions)
[](https://codecov.io/gh/guanguans/ai-commit)
[](https://packagist.org/packages/guanguans/ai-commit)
[](https://github.com/guanguans/ai-commit/releases/latest)
[](https://packagist.org/packages/guanguans/ai-commit)
[](https://packagist.org/packages/guanguans/ai-commit)
## サポート
- [x] [Bito Cli](https://github.com/gitbito/CLI)
- [x] [ERNIE-Bot-turbo](https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Nlks5zkzu#ernie-bot-turbo)
- [x] [ERNIE-Bot](https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Nlks5zkzu#ernie-bot)
- [x] [GitHub Copilot CLI](https://github.com/github/gh-copilot)
- [x] [GitHub Models CLI](https://github.com/github/gh-models)
- [x] [Moonshot](https://platform.moonshot.cn/docs/api-reference)
- [x] [OpenAI Chat](https://platform.openai.com/docs/api-reference/chat)
- [x] [OpenAI](https://platform.openai.com/docs/api-reference/completions)
- [ ] ...
## 必要条件
* PHP >= 7.3
## インストール
### [ai-commit](./builds/ai-commit) ファイルを直接ダウンロード
```shell
curl 'https://raw.githubusercontent.com/guanguans/ai-commit/main/builds/ai-commit' -o ai-commit -#
chmod +x ai-commit
```
### Composer を使用してインストール
```shell
composer global require guanguans/ai-commit --dev -v # グローバル
composer require guanguans/ai-commit --dev -v # ローカル
```
## 使用方法
### クイックスタート
details
```shell
./ai-commit config set generators.bito_cli.binary bito-cli-binary... --global # Config Bito CLI binary(Optional)
./ai-commit config set generators.ernie_bot.api_key api-key... --global # Config Ernie API key
./ai-commit config set generators.ernie_bot_turbo.api_key api-key... --global # Config Ernie API key
./ai-commit config set generators.github_copilot_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
./ai-commit config set generators.github_models_cli.binary gh-cli-binary... --global # Config Github CLI binary(Optional)
./ai-commit config set generators.moonshot.api_key sk-... --global # Config Moonshot API key
./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 using the default generator
./ai-commit commit --generator=github_copilot_cli # Generate and commit message using the specified generator
```
```shell
╰─ ./ai-commit commit --generator=bito_cli --no-edit --no-verify --ansi ─╯
1. Generating commit message: generating...
Please choose commit type [Automatically generate commit type]:
[auto ] Automatically generate commit type
[feat ] A new feature
[fix ] A bug fix
[docs ] Documentation only changes
[style ] Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
[refactor] A code change that neither fixes a bug nor adds a feature
[perf ] A code change that improves performance
[test ] Adding missing tests or correcting existing tests
[build ] Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
[ci ] Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
[chore ] Other changes that don't modify src or test files
[revert ] Reverts a previous commit
> chore
RUN 'bito'
ERR Model in use: BASIC
ERR
ERR
OUT {
OUT "subject": "chore(ai-commit): update tape and gif resources",
OUT "body": "- Adjusted width and height settings in ai-commit.tape\n- Changed commit command generator from openai_chat to bito_cli\n- Updated ai-commit-vhs.gif file with new binary data"
OUT }
OUT
OUT
RES Command ran successfully
1. Generating commit message: ✔
2. Confirming commit message: confirming...
+-------------------------------------------------+-----------------------------------------------------------------+
| subject | body |
+-------------------------------------------------+-----------------------------------------------------------------+
| chore(ai-commit): update tape and gif resources | - Adjusted width and height settings in ai-commit.tape |
| | - Changed commit command generator from openai_chat to bito_cli |
| | - Updated ai-commit-vhs.gif file with new binary data |
+-------------------------------------------------+-----------------------------------------------------------------+
Do you want to commit this message? (yes/no) [yes]:
>
2. Confirming commit message: ✔
3. Committing message: committing...
3. Committing message: ✔
[OK] Successfully generated and committed message.
```
### コマンドの一覧
details
```shell
╰─ ./ai-commit list ─╯
_____ _____ _ _
/\ |_ _| / ____| (_) |
/ \ | | | | ___ _ __ ___ _ __ ___ _| |_
/ /\ \ | | | | / _ \| '_ ` _ \| '_ ` _ \| | __|
/ ____ \ _| |_ | |___| (_) | | | | | | | | | | | | |_
/_/ \_\_____| \_____\___/|_| |_| |_|_| |_| |_|_|\__|
1.2.5
USAGE: ai-commit [options] [arguments]
commit Automagically generate conventional commit message 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.
```
### 設定の操作
details
```shell
./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
```
### 自己更新
details
```shell
╰─ ./ai-commit self-update ─╯
Checking for a new version...
=============================
[OK] Updated from version 1.2.4 to v1.2.5.
```
### コマンドヘルプ
details
```shell
╰─ ./ai-commit commit --help ─╯
Description:
Automagically generate conventional commit message with AI.
Usage:
commit [options] [--] []
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.json",":!*.lock",":!*.sum"]] (multiple values allowed)
-g, --generator=GENERATOR Specify generator name [default: "openai_chat"]
-p, --prompt=PROMPT Specify prompt name of message 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]
--dry-run Only generate message without commit
--diff[=DIFF] Specify diff content
-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
```
## テスト
```shell
composer test
```
## 変更履歴
最近の変更については、[CHANGELOG](CHANGELOG.md) を参照してください。
## 貢献
詳細については、[CONTRIBUTING](.github/CONTRIBUTING.md) を参照してください。
## セキュリティ脆弱性
セキュリティ脆弱性の報告方法については、[セキュリティポリシー](../../security/policy) をご覧ください。
## クレジット
* [guanguans](https://github.com/guanguans)
* [すべての貢献者](../../contributors)
## ライセンス
MIT ライセンス（MIT）。詳細については、[ライセンスファイル](LICENSE) を参照してください。