diff --git a/cli/overview.mdx b/cli/overview.mdx index 64e44118..f2a1eca0 100644 --- a/cli/overview.mdx +++ b/cli/overview.mdx @@ -7,7 +7,7 @@ sidebarTitle: 'Overview' import MainCicdCards from "/snippets/main-cicd-cards.mdx" The Checkly CLI gives you a JavaScript/TypeScript-native workflow for coding, testing and deploying synthetic -monitoring at scale, from your code base. The Checkly CLI comes with **native `@playwright/test` support.** No lock-in, +monitoring at scale, from your code base. The Checkly CLI comes with **native `@playwright/test` support.** No lock-in, just write standard `*.spec.ts` files. ## Starting your first project @@ -31,7 +31,7 @@ After this, let's dry run the Checks in your new project against the global Chec npx checkly test ``` -This should report the following output to your terminal +This should report the following output to your terminal ``` Running 4 checks in eu-west-1. @@ -53,25 +53,22 @@ Lastly, you deploy your Checks and related alert channels to Checkly, so we run npx checkly deploy ``` -You just created your entire synthetic monitoring setup with API and Playwright-based Browser Checks from your code base! +You just created your entire synthetic monitoring setup with API and Playwright-based Browser Checks from your code base! Open up [your Checkly dashboard](https://app.checklyhq.com) and you should see your check, ready to start monitoring around the clock. For a custom installation check out [our installation docs](/cli/installation/). -## Using AI IDEs and Copilots +## Using Agents, AI IDEs and Copilots -Checkly is designed to work with AI IDEs and Copilots. You can use your preferred provider to generate code for API +Checkly is designed to work with Agents, AI IDEs, and Copilots. You can use your preferred provider to generate code for API Checks, Browser Checks and all other constructs. - - - Download the Checkly instructions file and let copilot generate Checkly CLI code for you. + + + Install Checkly Skills and let AI agents generate Checkly monitoring code for you. - - Download the Checkly `.mdc` rules file and let Cursor generate Checkly CLI code for you. - - - Download the Checkly rules file and let Claude generate Checkly CLI code for you. + + Include the Checkly Rules in your conversations to generate Checkly monitoring code for you. @@ -80,4 +77,4 @@ Checks, Browser Checks and all other constructs. After kicking the tires, you should delegate the testing and deploying of your checks to your CI/CD pipeline. Check our docs on [setting up the Checkly CLI with your favourite CI/CD platform](/integrations/ci-cd/overview). - \ No newline at end of file + diff --git a/docs.json b/docs.json index bd1f56cb..4c340691 100644 --- a/docs.json +++ b/docs.json @@ -351,13 +351,11 @@ "group": "Integrations", "pages": [ { - "group": "AI coding asssistants", + "group": "AI Agents & Coding Assistants", "pages": [ "integrations/ai/overview", - "integrations/ai/claude", - "integrations/ai/cursor", - "integrations/ai/copilot", - "integrations/ai/windsurf" + "integrations/ai/skills", + "integrations/ai/rules" ] }, { diff --git a/integrations/ai/claude.mdx b/integrations/ai/claude.mdx deleted file mode 100644 index 2e56fcc9..00000000 --- a/integrations/ai/claude.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: 'Claude Code' -description: 'Learn how to use Claude Code to create checks.' -sidebarTitle: 'Claude Code' ---- - -Claude is a code editor that supports AI-powered code completion and suggestions. - -## Using Claude Code to create checks - - - - -```bash setup-claude-rules -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 -``` - - - - - -```bash setup-claude-rules-windows -New-Item -ItemType Directory -Path ".claude" -Force -Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".claude\checkly.rules.md" -echo "- examine checkly.rules.md for code generation rules" >> .claude/CLAUDE.md -``` - - - - -Exit and restart your Claude Code session to re-read the `CLAUDE.md` file into Claude Code's context. - -You can now ask Claude to install the `checkly` NPM package and generate code for API Checks, Browser checks, Multistep checks and all other constructs. Make sure to use the `checkly.rules.md` file as context for your questions. - - diff --git a/integrations/ai/copilot.mdx b/integrations/ai/copilot.mdx deleted file mode 100644 index bb32902e..00000000 --- a/integrations/ai/copilot.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: 'GitHub Copilot' -sidebarTitle: 'GitHub Copilot' ---- - - - - - - -```bash setup-copilot-rules -mkdir -p .github && curl -o .github/copilot-instructions.md "https://www.checklyhq.com/docs/ai/checkly.rules.md" -L -``` - - - - - -```bash setup-copilot-rules-windows -New-Item -ItemType Directory -Path ".github" -Force -Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".github\copilot-instructions.md" -``` - - - - - -You can ask Copilot to install the `checkly` NPM package and generate code for API Checks, Browser checks, Multistep checks -and all other constructs. diff --git a/integrations/ai/cursor.mdx b/integrations/ai/cursor.mdx deleted file mode 100644 index e1de10a3..00000000 --- a/integrations/ai/cursor.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: 'Cursor' -description: 'Learn how to use Cursor to create checks.' -sidebarTitle: 'Cursor' ---- - -Cursor is a code editor that supports AI-powered code completion and suggestions. - -## Cursor - - - - -```bash setup-cursor-rules -mkdir -p .cursor/rules && curl -o .cursor/rules/checkly.mdc "https://www.checklyhq.com/docs/ai/checkly.rules.md" -L -``` - -Now make sure to add the new `checkly.mdc` file to your context. - -You can now ask Cursor to install the `checkly` NPM package and generate code for API Checks, Browser checks, Multistep checks -and all other constructs. Make sure to use the `checkly.mdc` file as context for your questions. - - - - -```bash setup-cursor-rules-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.mdc" -``` - - - - -You can now reference the `checkly.mdc` using `@checkly.mdc` file in your Cursor chats and ask it to generate code for -API Checks, Browser checks, Multistep checks and all other constructs. \ No newline at end of file diff --git a/integrations/ai/overview.mdx b/integrations/ai/overview.mdx index 88ae6a78..07956664 100644 --- a/integrations/ai/overview.mdx +++ b/integrations/ai/overview.mdx @@ -5,9 +5,11 @@ sidebarTitle: 'Overview' keywords: ['mcp', 'ai', 'rules', 'generate checks', 'agents', 'context'] --- -import { YoutubeEmbed } from "/snippets/youtube-embed.jsx" +import AgentExamples from "/snippets/agent-example.mdx" -From the beginning, Checkly has bet on [Monitoring as Code](/concepts/monitoring-as-code) which lets you create and control your monitoring infrastructure entirely using code. [Checkly constructs](/constructs/overview) can reflect all your monitoring properties. +From the beginning, Checkly has bet on [Monitoring as Code](/concepts/monitoring-as-code) which lets you create and control your monitoring infrastructure entirely using code. + +By default, [Checkly constructs](/constructs/overview) reflect all your monitoring properties. ```ts api.check.ts import { ApiCheck, AssertionBuilder } from "checkly/constructs" @@ -36,40 +38,32 @@ npx checkly deploy **The Monitoring as Code workflow is by default AI-native** because LLMs are excellent at writing and editing Checkly constructs code and modern AI agents can execute CLI commands easily. -You only need to provide the necessary context about Checkly and your monitoring setup to your AI agent of choice. - -## Add custom Checkly rules to your AI conversation +Provide the necessary Checkly context and let your AI agent of choice do the rest. -The [`checkly.rules.md` file](https://www.checklyhq.com/docs/ai/checkly.rules.md) 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. +## Add Checkly context to your AI agent conversation -It will be able to: - - - "Can you create a new `BrowserCheck` monitoring `example.com`" - +Install [Checkly Skills](/integrations/ai/skills) or add the [Checkly Rules](/integrations/ai/rules) to your AI conversation to give your AI agent enough context to perform Checkly-related tasks. - - "What are the currently used monitoring locations?" + + +Let your agents pull in all required Checkly context on demand. - - "Can you change all checks to run every 5 minutes instead of every 10 minutes?" + +Include the entire Checkly context in commands or documentation. + -With enough application context you can even create checks for your specific use cases. +### Skills vs Rules - - "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](/guides/agentic-workflows) for more details. +**Use Skills** when your AI agent supports the [Agent Skills](https://agentskills.io) standard. Skills load context on demand, keeping your agent's context window lean until Checkly-related tasks arise. This is the recommended approach for compatible agents. - +**Use Rules** when your agent doesn't support skills or when you want the Checkly context always available. Rules files are loaded at session start and provide consistent context throughout your conversation. -## Why is there no Checkly MCP server? +## Why is there no Checkly MCP server (yet)? The MCP concept is often used to enable LLMs to interact with external systems. It acts as a bridge between the AI model and the target system, translating natural language commands into actionable API calls or code snippets. @@ -77,10 +71,6 @@ The MCP concept is often used to enable LLMs to interact with external systems. Whether you need to create new resources or update existing ones, AI can write and update the necessary construct files and execute the Checkly CLI commands autonomously. -## Additional Resources - -Follow these guides if you use one of the popular AI coding tools: - -- [Claude Code](/integrations/ai/claude) -- [Cursor](/integrations/ai/cursor) -- [GitHub Copilot](/integrations/ai/copilot) + +We are researching additional AI-native workflows. [Let us know in the public roadmap](https://feedback.checklyhq.com/p/checkly-mcp) if you are interested in more agent-friendly integrations. + diff --git a/integrations/ai/rules.mdx b/integrations/ai/rules.mdx new file mode 100644 index 00000000..18e5a67e --- /dev/null +++ b/integrations/ai/rules.mdx @@ -0,0 +1,125 @@ +--- +title: 'Checkly Rules' +description: 'Use the provided Checkly rules to control, update and deploy your monitoring.' +sidebarTitle: 'Checkly Rules' +--- + +import AgentExamples from "/snippets/agent-example.mdx" +import { YoutubeEmbed } from "/snippets/youtube-embed.jsx" + +The [`checkly.rules.md` file](https://www.checklyhq.com/docs/ai/checkly.rules.md) 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: + + + +With enough application context, you can even create checks for your specific use cases. + + +"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](/guides/agentic-workflows) 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`: + + + + +```bash +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 +``` + + + + +```powershell +New-Item -ItemType Directory -Path ".claude" -Force +Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".claude\checkly.rules.md" +Add-Content -Path ".claude\CLAUDE.md" -Value "- examine checkly.rules.md for code generation rules" +``` + + + + +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. + + + + +```bash +mkdir -p .github && curl -o .github/copilot-instructions.md "https://www.checklyhq.com/docs/ai/checkly.rules.md" -L +``` + + + + +```powershell +New-Item -ItemType Directory -Path ".github" -Force +Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".github\copilot-instructions.md" +``` + + + + +## Cursor + +Cursor uses `.mdc` (Markdown Cursor) files stored in `.cursor/rules/` for project-specific instructions. These rules are automatically included in Cursor's context. + + + + +```bash +mkdir -p .cursor/rules && curl -o .cursor/rules/checkly.mdc "https://www.checklyhq.com/docs/ai/checkly.rules.md" -L +``` + + + + +```powershell +New-Item -ItemType Directory -Path ".cursor\rules" -Force +Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".cursor\rules\checkly.mdc" +``` + + + + +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. + + + + +```bash +mkdir -p .windsurf/rules && curl -o .windsurf/rules/checkly.md "https://www.checklyhq.com/docs/ai/checkly.rules.md" -L +``` + + + + +```powershell +New-Item -ItemType Directory -Path ".windsurf\rules" -Force +Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".windsurf\rules\checkly.md" +``` + + + + +You can reference the rules file using `@checkly.md` in your Windsurf chats. diff --git a/integrations/ai/skills.mdx b/integrations/ai/skills.mdx new file mode 100644 index 00000000..747219c3 --- /dev/null +++ b/integrations/ai/skills.mdx @@ -0,0 +1,38 @@ +--- +title: 'Checkly Skills' +description: 'Use the provided Checkly skills to control, update and deploy your monitoring.' +sidebarTitle: 'Checkly Skills' +--- + +Skills are reusable and modular capabilities for AI agents. They provide procedural knowledge that helps agents accomplish Checkly tasks more effectively. Think of Checkly Skills as plugins or extensions that enhance what your AI agent can do with your monitoring infrastructure. + +[Agent Skills](https://agentskills.io) are an open standard supported by many AI agents and coding assistants including Claude Code, Cursor, OpenAI Codex, Gemini CLI, GitHub Copilot, and others. If your agent supports skills, you can use the Checkly Skills to manage your monitoring setup. + +Use [the `skills` CLI](https://www.npmjs.com/package/skills) to install [Checkly skills](https://github.com/checkly/checkly-cli/tree/main/skills/monitoring) globally or in your project: + +```bash +npx skills add checkly/checkly-cli +``` + +This will make the Checkly Skills available to your AI agent. When your agent needs to perform a Checkly-related task, it can automatically pull in the relevant context and use the provided instructions and resources to execute the task effectively. + +```txt Claude Code Example highlight={3-4} +❯ Can you create a new URLMonitor with Checkly for example.com? + +⏺ Skill(monitoring) + ⎿  Successfully loaded skill · 2 tools allowed + +⏺ Let me first check the existing Checkly setup in this project. + +⏺ Searched for 2 patterns, read 2 files (ctrl+o to expand) + +⏺ I'll create a new URLMonitor for example.com! +``` + +Using [Monitoring as Code](/concepts/monitoring-as-code), you can now control your monitoring setup with AI agents without needing a specific MCP server or API for your monitoring. Just give your agent the necessary context and let it use the Checkly Skills to manage your monitoring setup effectively. + +## Additional resources + +- [Checkly CLI Documentation](/cli/overview/) +- [Checkly Constructs Reference](/constructs/overview/) +- [Agent Skills Specification](https://agentskills.io/specification.md) diff --git a/integrations/ai/windsurf.mdx b/integrations/ai/windsurf.mdx deleted file mode 100644 index 26561826..00000000 --- a/integrations/ai/windsurf.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: 'Windsurf' -description: 'Learn how to use Windsurf to create checks.' -sidebarTitle: 'Windsurf' ---- - - - - ```bash Terminal - mkdir -p .windsurf/rules && curl -o .windsurf/rules/checkly.md "https://www.checklyhq.com/docs/ai/checkly.rules.md" -L - ``` - - - ```bash Terminal - New-Item -ItemType Directory -Path ".windsurf\rules" -Force - Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".windsurf\rules\checkly.md" - ``` - - - -You can now reference the `checkly.md` using `@checkly.md` file in your WindSurf chats and ask it to generate code for -API Checks, Browser checks, Multistep checks and all other constructs. \ No newline at end of file diff --git a/sitemap-crawl.md b/sitemap-crawl.md index dd3aa7fa..69a3816d 100644 --- a/sitemap-crawl.md +++ b/sitemap-crawl.md @@ -190,9 +190,9 @@ This file contains all valid URLs extracted from docs.json organized by director ## Integrations ### Integrations - AI -- /integrations/ai/claude -- /integrations/ai/cursor -- /integrations/ai/copilot +- /integrations/ai/overview +- /integrations/ai/skills +- /integrations/ai/rules ### Integrations - Alerts & Notifications - /integrations/alerts/discord diff --git a/snippets/agent-example.mdx b/snippets/agent-example.mdx new file mode 100644 index 00000000..01e90061 --- /dev/null +++ b/snippets/agent-example.mdx @@ -0,0 +1,11 @@ + +"Can you create a new `BrowserCheck` monitoring `example.com`" + + + +"What are the currently used monitoring locations?" + + + +"Can you change all checks to run every 5 minutes instead of every 10 minutes?" +