Обзор команд¶
Поверхность srekit — плоское дерево cobra-подкоманд. Каждая команда-генератор производит один артефакт (Markdown или LICENSE) и разделяет общий набор output-флагов; управляющие команды (templates, config) группируют свои подкоманды.
Генераторы¶
| Команда | Что генерирует | Обязательные флаги |
|---|---|---|
srekit task |
Investigation log (alias: sretask) |
--title |
srekit license |
LICENSE файл (alias: lic) |
— |
srekit postmortem |
Постмортем (Google SRE-style) | --title |
srekit rfc |
RFC / ADR | --title |
srekit runbook |
Operational runbook | --title |
srekit changelog |
Keep a Changelog scaffold | — |
srekit oncall-report |
Недельный отчёт дежурного | --team |
srekit slo |
SLO / SLI документ | --service |
srekit ebp |
Error budget policy | --service |
srekit capacity |
Capacity plan | --service |
srekit retro |
Спринт-ретро (Start / Stop / Continue) | --team |
Управление¶
| Команда | Назначение |
|---|---|
srekit templates |
Управление кастомной директорией шаблонов: init, pull, list, validate, diff, upgrade |
srekit config |
Скаффолд ~/.srekit.yaml: init |
srekit completion |
Shell автодополнение: bash, zsh, fish, powershell |
Общие output-флаги¶
Каждый генератор принимает:
| Флаг | Эффект |
|---|---|
--out FILE |
записать в FILE (отказ перезаписать без --force) |
--stdout |
напечатать в stdout |
--force |
перезаписать существующий FILE |
--dry-run |
показать что бы записал, не писать |
--json |
отдать данные шаблона как JSON (default sink: stdout) |
--template FILE есть только у srekit license (единственная команда, чей render-путь не идёт через v1 artifact loader). Per-artifact кастомизация для остальных — положить <name>.yaml в templates_dir, см. Custom templates workflow.
Persistent-флаг --templates-dir DIR (или env SREKIT_TEMPLATES_DIR, или templates_dir: в ~/.srekit.yaml) подключает кастомную директорию шаблонов, чьи файлы переопределяют embedded. Отсутствующие файлы прозрачно фолбэчатся.
Полный набор правил резолва — в Конфигурация.