# GigaCommitAI
CLI инструмент для генерации коммитов на основе ИИ
## Установка
> Минимальная поддерживаемая версия Python - 3.8.
> Проверьте свою версию Python командой python --version
1. Установить gigacommit
- c помощью _pip_
```
pip install gigacommitai
```
- c помощью _pipx_
```
pipx install gigacommitai
```
- c помощью _poetry_
```
poetry add gigacommitai
```
2. Установить свой токен для авторизации
- Получите свой Client Secret
- Вставьте свой токен с помощью команды
```
gigacommitai config set gigachat.settings.credentials <CLIENT_SECRET>
```
## Как использовать?
1. Командой ниже можно сгенерировать сообщение для коммита
```
gigacommitai commit
```
2. Командой ниже можно вывести всю конфигурацию
```
gigacommitai config show
```
3. Командой ниже можно вывести значение параметра, например:
```
gigacommitai config get gigachat.settings.model
```
4. Командой ниже можно изменить значение параметра, например:
```
gigacommitai config set gigachat.settings.model <ТВОЕ_ЗНАЧЕНИЕ>
```
## Можно ли менять конфигурацию через файл?
Да. Конфигурация хранится в вашей директории где хранятся пользовательские конфигурации
- На Linux `~/.config/gigacommitai/config.toml`
- На Mac `~/Library/Application Support/gigacommitai/config.toml`
- На Windows `<APPDATA>/gigacommitai/gigacommitai/config.toml`
> Рекомендуется делать бэкап конфигурации во избежании проблем с запуском CLI
## Участие в проекте
GigaCommitAI - это проект с иходным кодом. Приветсвуется любое участие в разработке или улучшение документации.
Raw data
{
"_id": null,
"home_page": "https://github.com/axemanofic/gigacommit",
"name": "gigacommitai",
"maintainer": "Roman",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "axeman.ofic@gmail.com",
"keywords": "python, ai, git, commit",
"author": "Roman Sotnikov",
"author_email": "axeman.ofic@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0f/62/5dbd8bc17f15acfdba1e73f3aac2f0c48e4e903ac05de98ca53a21c4c72e/gigacommitai-1.2.0.tar.gz",
"platform": null,
"description": "# GigaCommitAI\n\nCLI \u0438\u043d\u0441\u0442\u0440\u0443\u043c\u0435\u043d\u0442 \u0434\u043b\u044f \u0433\u0435\u043d\u0435\u0440\u0430\u0446\u0438\u0438 \u043a\u043e\u043c\u043c\u0438\u0442\u043e\u0432 \u043d\u0430 \u043e\u0441\u043d\u043e\u0432\u0435 \u0418\u0418\n\n## \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430\n\n> \u041c\u0438\u043d\u0438\u043c\u0430\u043b\u044c\u043d\u0430\u044f \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u0438\u0432\u0430\u0435\u043c\u0430\u044f \u0432\u0435\u0440\u0441\u0438\u044f Python - 3.8.\n> \u041f\u0440\u043e\u0432\u0435\u0440\u044c\u0442\u0435 \u0441\u0432\u043e\u044e \u0432\u0435\u0440\u0441\u0438\u044e Python \u043a\u043e\u043c\u0430\u043d\u0434\u043e\u0439 python --version\n\n1. \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u0438\u0442\u044c gigacommit\n\n- c \u043f\u043e\u043c\u043e\u0449\u044c\u044e _pip_\n\n```\npip install gigacommitai\n```\n\n- c \u043f\u043e\u043c\u043e\u0449\u044c\u044e _pipx_\n\n```\npipx install gigacommitai\n```\n\n- c \u043f\u043e\u043c\u043e\u0449\u044c\u044e _poetry_\n\n```\npoetry add gigacommitai\n```\n\n2. \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u0438\u0442\u044c \u0441\u0432\u043e\u0439 \u0442\u043e\u043a\u0435\u043d \u0434\u043b\u044f \u0430\u0432\u0442\u043e\u0440\u0438\u0437\u0430\u0446\u0438\u0438\n\n- \u041f\u043e\u043b\u0443\u0447\u0438\u0442\u0435 \u0441\u0432\u043e\u0439 Client Secret\n- \u0412\u0441\u0442\u0430\u0432\u044c\u0442\u0435 \u0441\u0432\u043e\u0439 \u0442\u043e\u043a\u0435\u043d \u0441 \u043f\u043e\u043c\u043e\u0449\u044c\u044e \u043a\u043e\u043c\u0430\u043d\u0434\u044b\n\n```\ngigacommitai config set gigachat.settings.credentials <CLIENT_SECRET>\n```\n\n## \u041a\u0430\u043a \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c?\n\n1. \u041a\u043e\u043c\u0430\u043d\u0434\u043e\u0439 \u043d\u0438\u0436\u0435 \u043c\u043e\u0436\u043d\u043e \u0441\u0433\u0435\u043d\u0435\u0440\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u0435 \u0434\u043b\u044f \u043a\u043e\u043c\u043c\u0438\u0442\u0430\n\n```\ngigacommitai commit\n```\n\n2. \u041a\u043e\u043c\u0430\u043d\u0434\u043e\u0439 \u043d\u0438\u0436\u0435 \u043c\u043e\u0436\u043d\u043e \u0432\u044b\u0432\u0435\u0441\u0442\u0438 \u0432\u0441\u044e \u043a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0430\u0446\u0438\u044e\n\n```\ngigacommitai config show\n```\n\n3. \u041a\u043e\u043c\u0430\u043d\u0434\u043e\u0439 \u043d\u0438\u0436\u0435 \u043c\u043e\u0436\u043d\u043e \u0432\u044b\u0432\u0435\u0441\u0442\u0438 \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u0430, \u043d\u0430\u043f\u0440\u0438\u043c\u0435\u0440:\n\n```\ngigacommitai config get gigachat.settings.model\n```\n\n4. \u041a\u043e\u043c\u0430\u043d\u0434\u043e\u0439 \u043d\u0438\u0436\u0435 \u043c\u043e\u0436\u043d\u043e \u0438\u0437\u043c\u0435\u043d\u0438\u0442\u044c \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u0430, \u043d\u0430\u043f\u0440\u0438\u043c\u0435\u0440:\n\n```\ngigacommitai config set gigachat.settings.model <\u0422\u0412\u041e\u0415_\u0417\u041d\u0410\u0427\u0415\u041d\u0418\u0415>\n```\n\n## \u041c\u043e\u0436\u043d\u043e \u043b\u0438 \u043c\u0435\u043d\u044f\u0442\u044c \u043a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0430\u0446\u0438\u044e \u0447\u0435\u0440\u0435\u0437 \u0444\u0430\u0439\u043b?\n\n\u0414\u0430. \u041a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0430\u0446\u0438\u044f \u0445\u0440\u0430\u043d\u0438\u0442\u0441\u044f \u0432 \u0432\u0430\u0448\u0435\u0439 \u0434\u0438\u0440\u0435\u043a\u0442\u043e\u0440\u0438\u0438 \u0433\u0434\u0435 \u0445\u0440\u0430\u043d\u044f\u0442\u0441\u044f \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c\u0441\u043a\u0438\u0435 \u043a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0430\u0446\u0438\u0438\n\n- \u041d\u0430 Linux `~/.config/gigacommitai/config.toml`\n- \u041d\u0430 Mac `~/Library/Application Support/gigacommitai/config.toml`\n- \u041d\u0430 Windows `<APPDATA>/gigacommitai/gigacommitai/config.toml`\n\n> \u0420\u0435\u043a\u043e\u043c\u0435\u043d\u0434\u0443\u0435\u0442\u0441\u044f \u0434\u0435\u043b\u0430\u0442\u044c \u0431\u044d\u043a\u0430\u043f \u043a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0430\u0446\u0438\u0438 \u0432\u043e \u0438\u0437\u0431\u0435\u0436\u0430\u043d\u0438\u0438 \u043f\u0440\u043e\u0431\u043b\u0435\u043c \u0441 \u0437\u0430\u043f\u0443\u0441\u043a\u043e\u043c CLI\n\n## \u0423\u0447\u0430\u0441\u0442\u0438\u0435 \u0432 \u043f\u0440\u043e\u0435\u043a\u0442\u0435\n\nGigaCommitAI - \u044d\u0442\u043e \u043f\u0440\u043e\u0435\u043a\u0442 \u0441 \u0438\u0445\u043e\u0434\u043d\u044b\u043c \u043a\u043e\u0434\u043e\u043c. \u041f\u0440\u0438\u0432\u0435\u0442\u0441\u0432\u0443\u0435\u0442\u0441\u044f \u043b\u044e\u0431\u043e\u0435 \u0443\u0447\u0430\u0441\u0442\u0438\u0435 \u0432 \u0440\u0430\u0437\u0440\u0430\u0431\u043e\u0442\u043a\u0435 \u0438\u043b\u0438 \u0443\u043b\u0443\u0447\u0448\u0435\u043d\u0438\u0435 \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u0438.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI \u0438\u043d\u0441\u0442\u0440\u0443\u043c\u0435\u043d\u0442 \u0434\u043b\u044f \u0433\u0435\u043d\u0435\u0440\u0430\u0446\u0438\u0438 \u043a\u043e\u043c\u043c\u0438\u0442\u043e\u0432 \u043d\u0430 \u043e\u0441\u043d\u043e\u0432\u0435 \u0418\u0418",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/axemanofic/gigacommit",
"Repository": "https://github.com/axemanofic/gigacommit"
},
"split_keywords": [
"python",
" ai",
" git",
" commit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4bd8f80c480891531723ff15aa6570e6a237c4e6bb24f70f8a5f8446d647047",
"md5": "c27cb507cfcc598d630f25c5a7e26c8e",
"sha256": "ac1d81c0d5afa4e05330e6c72e7c17d55641ab26eaa8a837a3026d32dc2916fd"
},
"downloads": -1,
"filename": "gigacommitai-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c27cb507cfcc598d630f25c5a7e26c8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 7275,
"upload_time": "2024-03-29T16:30:45",
"upload_time_iso_8601": "2024-03-29T16:30:45.079578Z",
"url": "https://files.pythonhosted.org/packages/d4/bd/8f80c480891531723ff15aa6570e6a237c4e6bb24f70f8a5f8446d647047/gigacommitai-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f625dbd8bc17f15acfdba1e73f3aac2f0c48e4e903ac05de98ca53a21c4c72e",
"md5": "c858abd039f8ceeadbab814509cc1f22",
"sha256": "f430e1c3678c0eddb7fe446f1f15b12ecf8a96ff8f8c98412bfb42e6a9d29333"
},
"downloads": -1,
"filename": "gigacommitai-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c858abd039f8ceeadbab814509cc1f22",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 5949,
"upload_time": "2024-03-29T16:30:46",
"upload_time_iso_8601": "2024-03-29T16:30:46.962779Z",
"url": "https://files.pythonhosted.org/packages/0f/62/5dbd8bc17f15acfdba1e73f3aac2f0c48e4e903ac05de98ca53a21c4c72e/gigacommitai-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 16:30:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "axemanofic",
"github_project": "gigacommit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gigacommitai"
}
JSON
