Перейти к содержанию

Старт

Эта страница ведёт от нуля до сгенерированного постмортема за три минуты.

1. Установка

brew tap jtprogru/tap
brew install srekit

go install github.com/jtprogru/srekit@latest

Требует Go 1.25+.

Скачай со страницы релизов на GitHub для darwin, linux или freebsd × arm64 / x86_64.

Проверить установку:

srekit --version
# srekit version: 0.10.1
# from commit: ...
# built date: ...

2. Разовая настройка

Генераторы, которые пишут автора (license, rfc, oncall-report), резолвят личность в таком порядке:

  1. флаги --author / --email
  2. env-переменные SREKIT_AUTHOR / SREKIT_EMAIL
  3. author: / email: в ~/.srekit.yaml
  4. git config user.name / git config user.email

Если у тебя уже выставлен глобальный git config, можно не настраивать ничего вообще. Если хочешь yaml-файл:

srekit config init
# Author name [Mikhail Savin]: ⏎
# Email [jtprogru@gmail.com]: ⏎
# Templates dir (leave empty to use embedded templates only): ⏎
# Wrote /Users/jtprogru/.srekit.yaml

srekit config init --yes идёт без промптов, использует значения из флагов и git config. Полная картина — в Конфигурация.

3. Первый артефакт

Постмортем — хороший старт: он задействует резолв автора, имя файла из title и флаги --out / --stdout:

srekit postmortem --title "API outage" --severity SEV-1 --stdout

Это печатает в stdout. Записать в файл:

srekit postmortem --title "API outage" --severity SEV-1 \
  --start 2026-05-06T08:00Z --end 2026-05-06T09:30Z \
  --owner "@oncall" \
  --out postmortem-2026-05-06.md

Посмотри что внутри — каждая секция предзаполнена с билингвальными заголовками (Постмортем (Postmortem)) и SRE-каноническими полями (severity, timeline, impact, root cause, action items).

4. Единый набор флагов

Каждая команда-генератор поддерживает один набор output-флагов:

Флаг Эффект
--out FILE записать в FILE (отказ перезаписать без --force)
--stdout напечатать в stdout
--force перезаписать существующий FILE
--dry-run показать что бы записал, не писать
--json отдать данные шаблона как JSON вместо рендеринга

--template FILE поддерживается только командой srekit license (единственная, чей render-путь не идёт через v1 artifact loader). Для остальных генераторов кастомизация per-artifact — положить <name>.yaml в templates_dir, см. Custom templates workflow.

Если не передал ни --out, ни --stdout, у каждой команды есть разумный default-путь (например Tasker - <title>.md для srekit task, oncall-<team>-<start>.md для отчёта дежурного).

5. Дальше

Этого хватит для повседневного использования. Если хочется глубже:

  • Кастомные шаблоны — форк embedded шаблонов в свой git-репо и подтягивание upstream-изменений через clean merge.
  • jtprogru/sre-templates — готовый репозиторий шаблонов ровно в той раскладке, которую ждёт srekit. Склонируй его и нацель на него templates_dir, чтобы не скаффолдить с нуля.
  • JSON-вывод — пайплайны генераторов в jq для CI-скриптов и интеграций.
  • Обзор команд — полный reference по каждой подкоманде и флагу.
  • Рецепты — конкретные сценарии, где srekit совмещается с твоим тулчейном.