@lxgicstudios/incident
v1.0.0
Published
Generate structured incident reports and postmortems with interactive prompts. Supports Google SRE, PagerDuty, and basic templates. Output as markdown.
Maintainers
Readme
@lxgicstudios/incident
Generate structured incident reports and postmortems with interactive prompts. Supports Google SRE, PagerDuty, and basic templates. Output as markdown.
Zero external dependencies. Just Node.js builtins.
Install
npm install -g @lxgicstudios/incidentOr run directly:
npx @lxgicstudios/incident newUsage
# Create a new incident interactively
incident new
# List all incidents
incident list
# View a specific incident
incident view INC-20260208-A1B2
# Export as markdown
incident export INC-20260208-A1B2
# List incidents as JSON
incident list --jsonFeatures
- Interactive prompts for timeline, root cause, severity, and action items
- Three templates: Basic, Google SRE, PagerDuty
- Severity levels: SEV1 through SEV4
- Timeline tracking with timestamps
- Action items with priority, owner, and status
- Lessons learned section
- Markdown export for sharing and documentation
- JSON storage in
.incidents/directory - Zero dependencies - uses only Node.js builtins
Templates
| Template | Style | Best For |
|----------|-------|----------|
| basic | Simple fields, clean layout | Quick reports, small teams |
| google-sre | Detailed postmortem with detection/trigger sections | SRE teams, thorough analysis |
| pagerduty | Incident response format with communication checklist | On-call teams, response tracking |
Commands
| Command | Description |
|---------|-------------|
| new | Create a new incident report interactively |
| list | List all saved incidents |
| view <id> | Display an incident's full report |
| export <id> | Save incident as a markdown file |
Options
| Option | Description | Default |
|--------|-------------|---------|
| --template <name> | Template: basic, google-sre, pagerduty | basic |
| --severity <level> | SEV1, SEV2, SEV3, or SEV4 | |
| --output <file> | Output file for export | <ID>.md |
| --json | Output as JSON | false |
| --help | Show help message | |
| --version | Show version number | |
Storage
Incidents are stored in .incidents/ as both JSON (data) and Markdown (readable). You can commit this directory to your repo for team access.
.incidents/
INC-20260208-A1B2.json
INC-20260208-A1B2.mdLicense
MIT - LXGIC Studios
