Skip to main content
Use the Checkly Skills instead if your coding agents supports Agent Skills.
The checkly.rules.md file includes best practices, example code and required CLI commands to give your AI workflow enough context to perform Checkly-related tasks. Once the Checkly rules are included in your AI context window, your agent can effectively assist you in managing your monitoring setup. It will be able to:

Create new checks, alert channels or other constructs

“Can you set up a new BrowserCheck for example.com?”

Bulk-update your monitoring resources

“Can you change all checks to run every 5 minutes instead of every 10 minutes?”

Gather information about alerts and your monitoring setup

“I just received an alert. Can you tell me details about the failing checks?”

Handle and communicate incidents

“Can you please open an incident and investigate a fix?”
With enough application context, you can even create checks for your specific use cases.

Analyze application code and create the monitoring setup

“Can you create new API Checks for the application API endpoints?”
Find a live session explaining how to automate Checkly monitoring with AI below and read the “Agentic Workflows” guide for more details.

Claude Code

Claude Code reads instructions from CLAUDE.md files. You can place these files globally (in your home directory) or locally (in your project root). Claude Code automatically includes these files in its context. To use Checkly rules with Claude Code, download the rules file and reference it in your CLAUDE.md:
mkdir -p .claude &&
curl -o .claude/checkly.rules.md https://www.checklyhq.com/docs/ai/checkly.rules.md -L
echo "- examine checkly.rules.md for code generation rules" >> .claude/CLAUDE.md
Restart your Claude Code session to load the instructions.

GitHub Copilot

GitHub Copilot reads project-level instructions from .github/copilot-instructions.md. This file is automatically included in Copilot’s context for all chat interactions.
mkdir -p .github && curl -o .github/copilot-instructions.md "https://www.checklyhq.com/docs/ai/checkly.rules.md" -L

Cursor

Cursor uses .mdc (Markdown Cursor) files stored in .cursor/rules/ for project-specific instructions. These rules are automatically included in Cursor’s context.
mkdir -p .cursor/rules && curl -o .cursor/rules/checkly.mdc "https://www.checklyhq.com/docs/ai/checkly.rules.md" -L
You can reference the rules file explicitly using @checkly.mdc in your Cursor chats.

Windsurf

Windsurf stores rules in .windsurf/rules/ as Markdown files. These are included in the AI context when you interact with Windsurf’s assistant.
mkdir -p .windsurf/rules && curl -o .windsurf/rules/checkly.md "https://www.checklyhq.com/docs/ai/checkly.rules.md" -L
You can reference the rules file using @checkly.md in your Windsurf chats.