From 5ae3579a9fed6d6429ab6e6fc5aa0ffea1116815 Mon Sep 17 00:00:00 2001 From: Simo Kinnunen Date: Tue, 27 Oct 2026 03:21:57 +0900 Subject: [PATCH] docs(cli): describe timed-out checks in reporter output [RED-1276] MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A check the CLI stops waiting for under --timeout is now reported as timed out rather than failed, with a ⏱ marker, a "timed out" summary count, and "result": "Timed out" in the json reporter. Co-Authored-By: Claude Opus 5.5 --- cli/checkly-pw-test.mdx | 2 ++ cli/checkly-test.mdx | 2 ++ cli/checkly-trigger.mdx | 2 ++ 3 files changed, 6 insertions(+) diff --git a/cli/checkly-pw-test.mdx b/cli/checkly-pw-test.mdx index 0a7f82db..ac7317ba 100644 --- a/cli/checkly-pw-test.mdx +++ b/cli/checkly-pw-test.mdx @@ -302,6 +302,8 @@ The timer restarts whenever a check starts running and whenever it reports a fai Checkly can stagger the start of checks in large test sessions by up to 900 seconds. If a check still has not started within this value plus that allowance, the CLI reports that the check did not start. That usually means a problem on Checkly's side: check [the status page](https://is.checkly.online) or contact support. +When the CLI stops waiting for a check, whether it stopped making progress or never started, it reports the check as timed out rather than failed: the CLI did not receive a result, and the check may still run and pass in Checkly. Reporters mark it with ⏱ (`T` in the `dot` reporter) and count it as timed out in the summary, and the `json` reporter gives it `"result": "Timed out"`. The run still exits with code 1. + **Usage:** ```bash Terminal diff --git a/cli/checkly-test.mdx b/cli/checkly-test.mdx index f83bb243..d47d678b 100644 --- a/cli/checkly-test.mdx +++ b/cli/checkly-test.mdx @@ -375,6 +375,8 @@ The timer restarts whenever a check starts running and whenever it reports a fai Checkly can stagger the start of checks in large test sessions by up to 900 seconds. If a check still has not started within this value plus that allowance, the CLI reports that the check did not start. That usually means a problem on Checkly's side: check [the status page](https://is.checkly.online) or contact support. +When the CLI stops waiting for a check, whether it stopped making progress or never started, it reports the check as timed out rather than failed: the CLI did not receive a result, and the check may still run and pass in Checkly. Reporters mark it with ⏱ (`T` in the `dot` reporter) and count it as timed out in the summary, and the `json` reporter gives it `"result": "Timed out"`. The run still exits with code 1. + **Usage:** ```bash Terminal diff --git a/cli/checkly-trigger.mdx b/cli/checkly-trigger.mdx index 21bd1139..0e113e69 100644 --- a/cli/checkly-trigger.mdx +++ b/cli/checkly-trigger.mdx @@ -397,6 +397,8 @@ The timer restarts whenever a check starts running and whenever it reports a fai Checkly can stagger the start of checks in large test sessions by up to 900 seconds. If a check still has not started within this value plus that allowance, the CLI reports that the check did not start. That usually means a problem on Checkly's side: check [the status page](https://is.checkly.online) or contact support. +When the CLI stops waiting for a check, whether it stopped making progress or never started, it reports the check as timed out rather than failed: the CLI did not receive a result, and the check may still run and pass in Checkly. Reporters mark it with ⏱ (`T` in the `dot` reporter) and count it as timed out in the summary, and the `json` reporter gives it `"result": "Timed out"`. The run still exits with code 1. + **Usage:** ```bash Terminal