From 97fde15ef378989f0c83d5c289dfc0f60babf9c3 Mon Sep 17 00:00:00 2001 From: stefan judis Date: Tue, 9 Jun 2026 14:05:42 +0200 Subject: [PATCH 1/4] docs: drop ts-node/typescript install step for CLI v8 Checkly CLI v8 bundles jiti and supports TypeScript out of the box, so the separate `ts-node`/`typescript` install is no longer required. Replace the install instructions in the installation page and the ecommerce guide with a shared `ts-loader-note` snippet that flags the v8 requirement for users still on earlier versions. --- cli/installation.mdx | 8 +++----- guides/monitoring-ecommerce-apps-using-playwright.mdx | 7 ++----- snippets/ts-loader-note.mdx | 3 +++ 3 files changed, 8 insertions(+), 10 deletions(-) create mode 100644 snippets/ts-loader-note.mdx diff --git a/cli/installation.mdx b/cli/installation.mdx index dc283fd8..b333a983 100644 --- a/cli/installation.mdx +++ b/cli/installation.mdx @@ -4,6 +4,8 @@ description: 'Creating a CLI project from scratch' sidebarTitle: 'Installation' --- +import TsLoaderNote from '/snippets/ts-loader-note.mdx'; + To kickstart a new project with the CLI, we recommend running `npx checkly init`. But you can also add the CLI from scratch with the following steps. @@ -20,11 +22,7 @@ First, install the CLI. npm i --save-dev checkly ``` -To use TypeScript, also install `ts-node` and `typescript`: - -```bash Terminal -npm i --save-dev ts-node typescript -``` + Create a minimal `checkly.config.ts` (or `checkly.config.js`) at the root of your project. We recommend using TypeScript. diff --git a/guides/monitoring-ecommerce-apps-using-playwright.mdx b/guides/monitoring-ecommerce-apps-using-playwright.mdx index f6a043a0..80482969 100644 --- a/guides/monitoring-ecommerce-apps-using-playwright.mdx +++ b/guides/monitoring-ecommerce-apps-using-playwright.mdx @@ -7,6 +7,7 @@ tags: Playwright import CliAuth from '/snippets/cli-auth.mdx'; import CliProjectInit from '/snippets/cli-project-init.mdx'; +import TsLoaderNote from '/snippets/ts-loader-note.mdx'; import { YoutubeEmbed } from "/snippets/youtube-embed.jsx" ## Inspired by Infrastructure-as-Code and E2E-Testing @@ -187,11 +188,7 @@ First, install the CLI. npm install --save-dev checkly ``` -Since we are using TypeScript, also install ts-node and typescript: - -```bash install-typescript-dependencies -npm install --save-dev ts-node typescript -``` + Next up, we want to create our `checkly.config.ts` file and include the basic Checkly configuration as follows: diff --git a/snippets/ts-loader-note.mdx b/snippets/ts-loader-note.mdx new file mode 100644 index 00000000..67def70b --- /dev/null +++ b/snippets/ts-loader-note.mdx @@ -0,0 +1,3 @@ + +Built-in TypeScript support requires Checkly CLI `v8` or later. On earlier versions, also install a TypeScript loader with `npm install --save-dev ts-node typescript`. + From e0144898dc3648e6b0920b1f1593274f60f3f365 Mon Sep 17 00:00:00 2001 From: stefan judis Date: Tue, 9 Jun 2026 14:09:12 +0200 Subject: [PATCH 2/4] docs: bump CLI Node.js requirement to ^20.19.0 || >=22.12.0 --- cli/installation.mdx | 2 +- detect/testing/creating-your-first-test.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cli/installation.mdx b/cli/installation.mdx index b333a983..40eeb7f1 100644 --- a/cli/installation.mdx +++ b/cli/installation.mdx @@ -11,7 +11,7 @@ from scratch with the following steps. ## Prerequisites -- Node.js `v16.x` or higher. +- Node.js `^20.19.0 || >=22.12.0`. - A text editor like [Visual Studio Code](https://code.visualstudio.com/). ## Installation diff --git a/detect/testing/creating-your-first-test.mdx b/detect/testing/creating-your-first-test.mdx index 23d12458..36fd7c8c 100644 --- a/detect/testing/creating-your-first-test.mdx +++ b/detect/testing/creating-your-first-test.mdx @@ -8,7 +8,7 @@ Checkly enables you to transform your existing Playwright tests into powerful sy -- Node.js 18+ installed +- Node.js `^20.19.0 || >=22.12.0` installed - A Checkly account (sign up at [checklyhq.com](https://www.checklyhq.com)) - Basic familiarity with JavaScript/TypeScript From f93107b496cd3552a642a9d37b186357a1235e4b Mon Sep 17 00:00:00 2001 From: stefan judis Date: Tue, 9 Jun 2026 14:11:45 +0200 Subject: [PATCH 3/4] docs: phrase Node.js requirement as 20.19+ or 22.12+ --- cli/installation.mdx | 2 +- detect/testing/creating-your-first-test.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cli/installation.mdx b/cli/installation.mdx index 40eeb7f1..090b3f2f 100644 --- a/cli/installation.mdx +++ b/cli/installation.mdx @@ -11,7 +11,7 @@ from scratch with the following steps. ## Prerequisites -- Node.js `^20.19.0 || >=22.12.0`. +- Node.js `20.19+` or `22.12+`. - A text editor like [Visual Studio Code](https://code.visualstudio.com/). ## Installation diff --git a/detect/testing/creating-your-first-test.mdx b/detect/testing/creating-your-first-test.mdx index 36fd7c8c..1a0a2749 100644 --- a/detect/testing/creating-your-first-test.mdx +++ b/detect/testing/creating-your-first-test.mdx @@ -8,7 +8,7 @@ Checkly enables you to transform your existing Playwright tests into powerful sy -- Node.js `^20.19.0 || >=22.12.0` installed +- Node.js `20.19+` or `22.12+` installed - A Checkly account (sign up at [checklyhq.com](https://www.checklyhq.com)) - Basic familiarity with JavaScript/TypeScript From 79c6568e677d625fe3cf2ad6a21f100f32ceeda4 Mon Sep 17 00:00:00 2001 From: stefan judis Date: Tue, 9 Jun 2026 14:14:11 +0200 Subject: [PATCH 4/4] docs: bump Node.js to 20 in CLI CI/CD examples --- detect/uptime-monitoring/cli-configuration.mdx | 2 +- integrations/ci-cd/jenkins/overview.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/detect/uptime-monitoring/cli-configuration.mdx b/detect/uptime-monitoring/cli-configuration.mdx index 101c1a2e..9805e1e4 100644 --- a/detect/uptime-monitoring/cli-configuration.mdx +++ b/detect/uptime-monitoring/cli-configuration.mdx @@ -477,7 +477,7 @@ jobs: - name: Setup Node.js uses: actions/setup-node@v3 with: - node-version: '18' + node-version: '20' cache: 'npm' - name: Install dependencies diff --git a/integrations/ci-cd/jenkins/overview.mdx b/integrations/ci-cd/jenkins/overview.mdx index 05ab16bf..8b5aa217 100644 --- a/integrations/ci-cd/jenkins/overview.mdx +++ b/integrations/ci-cd/jenkins/overview.mdx @@ -63,7 +63,7 @@ should look as follows: pipeline { agent any - tools {nodejs "Node 18"} + tools {nodejs "Node 20"} environment { CHECKLY_API_KEY = credentials('checkly-api-key') CHECKLY_ACCOUNT_ID = credentials('checkly-account-id')