Commands overview¶
srekit's surface is a flat tree of cobra subcommands. Every generator command produces a single artifact (a Markdown or LICENSE file) and shares the same output flag set; the management commands (templates, config) group their own subcommands.
Generators¶
| Command | Produces | Required flags |
|---|---|---|
srekit task |
Investigation log (alias: sretask) |
--title |
srekit license |
LICENSE file (alias: lic) |
— |
srekit postmortem |
Postmortem (Google SRE-style) | --title |
srekit rfc |
RFC / ADR | --title |
srekit runbook |
Operational runbook | --title |
srekit changelog |
Keep a Changelog scaffold | — |
srekit oncall-report |
Weekly on-call report | --team |
srekit slo |
SLO / SLI document | --service |
srekit ebp |
Error budget policy | --service |
srekit capacity |
Capacity plan | --service |
srekit retro |
Sprint retro (Start / Stop / Continue) | --team |
Management¶
| Command | Purpose |
|---|---|
srekit templates |
Manage a custom templates directory: init, pull, list, validate, diff, upgrade |
srekit config |
Scaffold ~/.srekit.yaml: init |
srekit completion |
Shell autocomplete: bash, zsh, fish, powershell |
Shared output flags¶
Every generator command accepts:
| Flag | Effect |
|---|---|
--out FILE |
write to FILE (refuses to overwrite without --force) |
--stdout |
print to stdout |
--force |
overwrite an existing FILE |
--dry-run |
show what would be written, do not write |
--json |
emit the template data payload as JSON (default sink: stdout) |
--template FILE is only on srekit license (the one command whose render path doesn't go through the v1 artifact loader). Per-artifact customization for the other generators is via dropping a <name>.yaml into your templates_dir — see Custom templates workflow.
The persistent flag --templates-dir DIR (or env SREKIT_TEMPLATES_DIR, or templates_dir: in ~/.srekit.yaml) installs a custom templates directory whose files override the embedded ones. Missing files fall back transparently.
See Configuration & precedence for the full resolution rules.