An open API service indexing awesome lists of open source software.

https://github.com/axemanofic/gigacommitai

CLI инструмент для генерации коммитов на основе ИИ
https://github.com/axemanofic/gigacommitai

ai cli commit gigachat git

Last synced: 2 months ago
JSON representation

CLI инструмент для генерации коммитов на основе ИИ

Awesome Lists containing this project

README

          


GigaCommitAI


CLI инструмент для генерации коммитов на основе ИИ


Pepy Total Downlods
PyPI - Python Version
PyPI - Version

---

## Используемые технологии

- gigachat
- typer
- platformdirs
- rtoml

## Установка

> Минимальная поддерживаемая версия Python - 3.8.
> Проверьте свою версию Python командой `python --version`

1. Установить gigacommit

- c помощью _pip_

```sh
pip install gigacommitai
```

- c помощью _pipx_

```sh
pipx install gigacommitai
```

- c помощью _poetry_

```sh
poetry add gigacommitai
```

2. Установить свой токен для авторизации

- Получите свой Client Secret
- Вставьте свой токен с помощью команды

```sh
gigacommitai config set gigachat.settings.credentials
```

## Как использовать?

1. Командой ниже можно сгенерировать сообщение для коммита

```sh
gigacommitai commit
```

2. Командой ниже можно вывести всю конфигурацию

```sh
gigacommitai config show
```

3. Командой ниже можно вывести значение параметра, например:

```sh
gigacommitai config get gigachat.settings.model
```

4. Командой ниже можно изменить значение параметра, например:

```sh
gigacommitai config set gigachat.settings.model <ТВОЕ_ЗНАЧЕНИЕ>
```

## Можно ли менять конфигурацию через файл?

Да. Конфигурация хранится в вашей директории где хранятся пользовательские конфигурации

- На Linux `~/.config/gigacommitai/config.toml`
- На Mac `~/Library/Application Support/gigacommitai/config.toml`
- На Windows `/gigacommitai/gigacommitai/config.toml`

> Рекомендуется делать бэкап конфигурации во избежании проблем с запуском CLI

## Участие в проекте

GigaCommitAI - это проект с иходным кодом. Приветсвуется любое участие в разработке или улучшение документации.