Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions cli/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ 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.

## Prerequisites

- Node.js `v16.x` or higher.
- Node.js `20.19+` or `22.12+`.
- A text editor like [Visual Studio Code](https://code.visualstudio.com/).

## Installation
Expand All @@ -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
```
<TsLoaderNote />

Create a minimal `checkly.config.ts` (or `checkly.config.js`) at the root of your project. We recommend using TypeScript.

Expand Down
2 changes: 1 addition & 1 deletion detect/testing/creating-your-first-test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Checkly enables you to transform your existing Playwright tests into powerful sy

<AccordionGroup>
<Accordion title="Prerequisites">
- Node.js 18+ 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
</Accordion>
Expand Down
2 changes: 1 addition & 1 deletion detect/uptime-monitoring/cli-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 2 additions & 5 deletions guides/monitoring-ecommerce-apps-using-playwright.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```
<TsLoaderNote />

Next up, we want to create our `checkly.config.ts` file and include the basic Checkly configuration as follows:

Expand Down
2 changes: 1 addition & 1 deletion integrations/ci-cd/jenkins/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
3 changes: 3 additions & 0 deletions snippets/ts-loader-note.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<Note>
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`.
</Note>
Loading