docs: add --commit documentation to README and CONFIG
This commit is contained in:
18
README.md
18
README.md
@@ -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
|
||||
```
|
||||
|
||||
## Форматы вывода
|
||||
|
||||
| Формат | Особенности |
|
||||
|
||||
Reference in New Issue
Block a user