feat(cli): add incidents command suite (TIM-26/27/28/29) by thebiglabasky · Pull Request #1236 · checkly/checkly-cli

thebiglabasky · 2026-02-25T18:03:12Z

Summary

This PR implements the incidents command set requested in TIM-26, TIM-27, TIM-28, and TIM-29.

It adds end-to-end CLI support to:

create incidents
list incidents
post incident progress updates
resolve incidents

Linked issues

TIM-26: incidents create
TIM-27: incidents update <id>
TIM-28: incidents resolve <id>
TIM-29: incidents list

What changed

Added incidents REST client and API wiring:
- GET /v1/status-pages/incidents
- GET /v1/status-pages/incidents/{id}
- POST /v1/status-pages/incidents
- POST /v1/status-pages/incidents/{id}/incident-updates
Added incidents helper utilities for:
- severity/status option mapping
- status-page service flattening/resolution
- list status filtering (open|resolved|all)
Added formatter support for incidents:
- list table rendering (terminal and markdown)
- incident detail rendering
- incident update detail rendering
Added command implementations:
- checkly incidents create
- checkly incidents list
- checkly incidents update <id>
- checkly incidents resolve <id>
Added incidents topic metadata in oclif config.
Updated help rendering/e2e expectations so topic-level commands are included in help output reliably.

Behavior notes

incidents create defaults to:
- status: INVESTIGATING
- message: "We are investigating this incident."
incidents resolve defaults to message:
- "Incident resolved."
incidents list defaults to:
- --status open

Validation

Executed locally:

npm run lint
npx vitest --run packages/cli/src/formatters/__tests__/incidents.spec.ts packages/cli/src/formatters/__tests__/status-pages.spec.ts
cd packages/cli && NODE_CONFIG_DIR=./e2e/config npx vitest --run -c ./vitest.config.e2e.mts e2e/__tests__/help.spec.ts

Commit breakdown

feat(cli): add incidents REST client and helpers
feat(cli): add incident formatter output
feat(cli): add incidents create list update and resolve commands
test(cli): cover incidents help topic in e2e

MichaelHogers

@thebiglabasky nice stuff, my main concern is that these commands are different from checkly checks, given the side effects when alerting

do we have sufficiently explicit warnings to an agent or user? e.g. a user using these commands in the CLI with their agent -> the CLI should print "ARE YOU SURE" kind of output to validate that one really wants to create an incident/send notifications/...

i don't think we should overcomplicate at this stage, but this category of CLI commands probably deserve some special treatment

MichaelHogers · 2026-02-26T10:40:48Z

one note @thebiglabasky i haven't tested this CLI version in my Claude Code/Codex to get a feel for all the output formatting, partially because it feels more dangerous to do so 👁️

thebiglabasky · 2026-02-26T10:43:56Z

@thebiglabasky nice stuff, my main concern is that these commands are different from checkly checks, given the side effects when alerting

Agreed. I think we should already think about that mechanism. I'm not quite clear about how we can distinguish "write" actions from read ones for an agent to ask for permissions. At the very least, asking for confirmation to a user seems necessary though, so I'd be inclined to already have an interactive mode or so.

The problem with incident management is that the point is to communicate to subscribers, so if we're too cautious, we add burden to users who want to proceed (the typical case of someone paged at 3am...).
Let me research that a bit to see if there are ways to distinguish commands for agents in categories. Otherwise, we probably should have a sort of "mode"?
The same applies to other pre-existing commands like "destroy".

thebiglabasky · 2026-02-26T10:45:19Z

one note @thebiglabasky i haven't tested this CLI version in my Claude Code/Codex to get a feel for all the output formatting, partially because it feels more dangerous to do so 👁️

I did test them manually on staging, but not through CC/Codex yet. I'll do a pass here too

The base branch was changed.

thebiglabasky · 2026-02-27T09:35:59Z

Latest changes:

Standardized metadata about commands (following what the MCP standard proposes for MCPs, but adapted to the CLi) to have a sense of what's readonly / destructive / idempotent and standardize a confirmOrAbort method allowing to provide feedback depending on the execution mode (interactive, agent, ci)
Added option to change the incident severity along with an update (e.g minor to major, etc.)
Tested with Claude Code on an incident response flow successfully

Move detectOperator from rest/api.ts to helpers/cli-mode.ts as a shared helper. Add detectCliMode that maps operators to interactive/ci/agent modes with CHECKLY_CLI_MODE env var override. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add structured preview output for agent/CI consumption and terminal display. Includes buildConfirmCommand to reconstruct CLI invocations with --force appended. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add readOnly, destructive, idempotent classification to BaseCommand. Add forceFlag() and dryRunFlag() helpers matching the outputFlag() pattern. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Allow updating the overall incident severity alongside posting a progress update, via PATCH /v1/status-pages/incidents/:id. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

github-actions · 2026-02-27T09:51:13Z

⚠️ AI context is out of date

The skills/ directory doesn't match the generated output from packages/cli.

Please run the following locally and commit the changes:

npm run prepare

The import was dropped during the rebase onto main. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

MichaelHogers

Would suggest at minimum adding e2e tests for incidents list (read-only, follows the same pattern as checks-list.spec.ts — default/json/md output).

Could also go for a lifecycle e2e test (create → update → resolve → verify via list) in the empty e2e account i set up earlier <- but up to you

I think e2e tests are our lowest hanging fruit here, will leave it to your judgment, otherwise looks good

thebiglabasky · 2026-02-27T11:59:54Z

Would suggest at minimum adding e2e tests for incidents list (read-only, follows the same pattern as checks-list.spec.ts — default/json/md output).

Could also go for a lifecycle e2e test (create → update → resolve → verify via list) in the empty e2e account i set up earlier <- but up to you

I think e2e tests are our lowest hanging fruit here, will leave it to your judgment, otherwise looks good

Let's do that, thanks!

Add incidents-list e2e tests (default/json/md output, status filtering) and incidents-lifecycle e2e test (create → update → resolve → delete) with afterAll cleanup via API. Wire CHECKLY_STATUS_PAGE_ID in CI workflow. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…setup Merge incidents-list and incidents-lifecycle into one file to avoid parallel rate limiting. Create status page + service in beforeAll and clean up in afterAll, removing the need for CHECKLY_STATUS_PAGE_ID config. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

thebiglabasky changed the base branch from main to herve/TIM-24/status-pages-list February 25, 2026 18:20

thebiglabasky marked this pull request as draft February 25, 2026 18:30

thebiglabasky force-pushed the herve/TIM-26-27-28-29-incidents branch from b031d11 to 82474cb Compare February 25, 2026 18:32

thebiglabasky requested a review from MichaelHogers February 25, 2026 19:03

MichaelHogers previously approved these changes Feb 26, 2026

View reviewed changes

Base automatically changed from herve/TIM-24/status-pages-list to main February 26, 2026 15:24

thebiglabasky marked this pull request as ready for review February 27, 2026 09:33

thebiglabasky and others added 10 commits February 27, 2026 10:38

feat(cli): add incidents REST client and helpers

66589b0

feat(cli): add incident formatter output

cea95ab

feat(cli): add incidents create list update and resolve commands

130a820

test(cli): cover incidents help topic in e2e

197d88a

feat(cli): add notify-subscribers toggle for incident posts

2bd40e1

test(cli): cover notify-subscribers behavior for incidents commands

7756b51

feat(cli): add CommandPreview types and formatting utilities

abb0e0c

Add structured preview output for agent/CI consumption and terminal display. Includes buildConfirmCommand to reconstruct CLI invocations with --force appended. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

feat(cli): add command metadata statics and flag helpers

53c27b1

Add readOnly, destructive, idempotent classification to BaseCommand. Add forceFlag() and dryRunFlag() helpers matching the outputFlag() pattern. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

feat(cli): add --severity flag to incidents update command

66f9d66

Allow updating the overall incident severity alongside posting a progress update, via PATCH /v1/status-pages/incidents/:id. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

thebiglabasky force-pushed the herve/TIM-26-27-28-29-incidents branch from d7d3011 to 66f9d66 Compare February 27, 2026 09:50

fix(cli): restore detectOperator import in api.ts

25b6df1

The import was dropped during the rebase onto main. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

MichaelHogers previously approved these changes Feb 27, 2026

View reviewed changes

fix: add e2e tests

aee4884

thebiglabasky dismissed MichaelHogers’s stale review via aee4884 February 27, 2026 12:34

thebiglabasky and others added 2 commits February 27, 2026 16:06

test(cli): include stdout in e2e assertion messages for CI debugging

dba9684

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): add incidents command suite (TIM-26/27/28/29)#1236

feat(cli): add incidents command suite (TIM-26/27/28/29)#1236
thebiglabasky wants to merge 15 commits intomainfrom
herve/TIM-26-27-28-29-incidents

thebiglabasky commented Feb 25, 2026

Uh oh!

MichaelHogers left a comment

Uh oh!

MichaelHogers commented Feb 26, 2026

Uh oh!

thebiglabasky commented Feb 26, 2026

Uh oh!

thebiglabasky commented Feb 26, 2026

Uh oh!

thebiglabasky commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

MichaelHogers left a comment

Uh oh!

thebiglabasky commented Feb 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

thebiglabasky commented Feb 25, 2026

Summary

Linked issues

What changed

Behavior notes

Validation

Commit breakdown

Uh oh!

MichaelHogers left a comment

Choose a reason for hiding this comment

Uh oh!

MichaelHogers commented Feb 26, 2026

Uh oh!

thebiglabasky commented Feb 26, 2026

Uh oh!

thebiglabasky commented Feb 26, 2026

Uh oh!

thebiglabasky commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

⚠️ AI context is out of date

Uh oh!

MichaelHogers left a comment

Choose a reason for hiding this comment

Uh oh!

thebiglabasky commented Feb 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants