docs: add --commit documentation to README and CONFIG

This commit is contained in:
Кокос Артем Николаевич
2026-07-07 10:48:36 +07:00
parent 9b78d66769
commit 80faccb1f9
2 changed files with 53 additions and 1 deletions

View File

@@ -19,6 +19,7 @@ CLI-инструмент для генерации отчётов по зада
- Сводка по времени (`--summary`).
- YAML-конфиг (`~/.config/redmine-reporter/config.yml`): шаблон имени файла, путь по умолчанию, период, SMTP.
- Умное разрешение `--output`: bare-формат (`xlsx`) → путь по шаблону, без расширения → автодописывание.
- `--commit`: автосохранение отчёта в файл + фиксация периода в YAML-конфиге для следующего запуска.
- Понятные сообщения об ошибках Redmine API (401/403/5xx, таймаут, сеть).
- Загрузка альтернативного `.env` через `--config`.
@@ -197,6 +198,23 @@ redmine-reporter --by-activity --summary
redmine-reporter --summary
```
Фиксация периода (`--commit`):
```bash
# Сгенерировать, сохранить в файл по шаблону, запомнить период
redmine-reporter --commit
# С явным путём
redmine-reporter --commit --output report.xlsx
# Следующий запуск (без --date) возьмёт следующий период автоматически
redmine-reporter
# При precision=datetime запоминает момент времени
# (предотвращает дублирование записей внутри дня)
redmine-reporter --commit
```
## Форматы вывода
| Формат | Особенности |