Docs / Ai / Use checkly with ai ide
BETA
Copy as Markdown View as Markdown

Use Checkly with AI IDEs & Copilots

On this page

Docs

You can index our docs pages in your IDE to leverage better code generation results. Todo so follow the guides for your IDE of choice:

Make sure to index the following url:

https://checklyhq.com/docs/

At the time of writing this unfortunately no other IDE supports this kind of context enrichment.

Custom Rules

We prepared a first set of ai rules which you can use to teach your AI IDE of choice on how to generate code for Checkly.

Go into the root of your IDEs workspace and download the rules according to your IDEs config parameters.

When asking questions about Checkly manually add the download rules files to your prompt.

GitHub Copilot

Windows

New-Item -ItemType Directory -Path ".github\instructions" -Force
Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/docs/ai/checkly.rules.md" -OutFile ".github\instructions\checkly-api-check.md"

Mac and Linux

Terminal
mkdir -p .github/instructions && curl -o .github/instructions/checkly-api-check.md "https://www.checklyhq.com/docs/ai/checkly.rules.md"

Cursor

Windows

New-Item -ItemType Directory -Path ".cursor\rules" -Force
Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".cursor\rules\checkly-api-check.mdc"

Mac and Linux

Terminal
mkdir -p .cursor/rules && curl -o .cursor/rules/checkly-api-check.md  "https://www.checklyhq.com/docs/ai/checkly.rules.md"

Windsurf

Windows

New-Item -ItemType Directory -Path ".windsurf\rules" -Force
Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly-api-check.md" -OutFile ".windsurf\rules\checkly-api-check.md"

Mac and Linux

Terminal
mkdir -p .windsurf/rules && curl -o .windsurf/rules/checkly-api-check.md "https://www.checklyhq.com/docs/ai/checkly.rules.md"
next AI assisted Checkly features

Last updated on June 13, 2025. You can contribute to this documentation by editing this page on Github