Skip to content

Commit 033a6aa

Browse files
authored
docs: add AI Agents & Coding Assistants section to README (#1214)
* docs: add AI Agents & Coding Assistants section to README Highlight Monitoring as Code compatibility with AI tools and document the Checkly skill installation for AI coding assistants. * fix: typo "Assistents" → "Assistants"
1 parent 061f48a commit 033a6aa

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The Checkly CLI gives you a **JavaScript/TypeScript-native workflow** for coding, testing and deploying synthetic
1+
The Checkly CLI gives you a **JavaScript/TypeScript-native workflow** for coding, testing and deploying synthetic
22
monitoring at scale, from your code base. We call this workflow **monitoring as code** (MaC).
33

44
- **Codeable, testable, reviewable monitoring constructs.** Works with your dev pipeline. From your IDE, via PR to CI.
@@ -51,7 +51,7 @@ Running 2 checks in eu-west-1.
5151

5252
__checks__/books-api.check.ts
5353
✔ Books API 1 (52ms)
54-
__checks__/home.spec.ts
54+
__checks__/home.spec.ts
5555
✔ home.spec.ts (5s)
5656

5757
2 passed, 2 total
@@ -76,7 +76,7 @@ Then, the **easiest** way to get started is to install the CLI using the followi
7676
```bash
7777
npm create checkly@latest
7878
```
79-
This command will guide you through some simple steps and set up a fully working example project for you. Should take
79+
This command will guide you through some simple steps and set up a fully working example project for you. Should take
8080
~1 minute.
8181

8282
You can also set up the CLI **from scratch** by running:
@@ -89,7 +89,22 @@ npm install --save-dev checkly
8989

9090
Official docs are over at [checklyhq.com/docs/cli](https://checklyhq.com/docs/cli/)
9191

92-
## Need help?
92+
# AI Agents & Coding Assistants
93+
94+
The Checkly CLI is designed with AI-powered development in mind. With [**Monitoring as Code**](https://www.checklyhq.com/docs/concepts/monitoring-as-code/), your entire monitoring setup lives in TypeScript files — perfect for AI agents that can read, write, and reason about code.
95+
96+
To give your AI coding assistant full context about the Checkly CLI, install the Checkly skill:
97+
98+
```bash
99+
npx skills add checkly/checkly-cli
100+
```
101+
102+
This provides your AI with documentation, best practices, and examples so it can help you create and manage API checks, browser checks, alert channels, and more.
103+
104+
Check out our [AI Agents & Coding Assistants docs](https://www.checklyhq.com/docs/integrations/ai/overview) for more best practices and examples.
105+
106+
107+
## Need help?
93108

94109
- Check out our [Getting Started Guide](https://checklyhq.com/docs/cli/)
95110
- Join our [Slack Community](https://checklyhq.com/slack). The devs who built this hang out there.

0 commit comments

Comments
 (0)