You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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"
Copy file name to clipboardExpand all lines: README.md
+19-4Lines changed: 19 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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
2
2
monitoring at scale, from your code base. We call this workflow **monitoring as code** (MaC).
3
3
4
4
-**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.
51
51
52
52
__checks__/books-api.check.ts
53
53
✔ Books API 1 (52ms)
54
-
__checks__/home.spec.ts
54
+
__checks__/home.spec.ts
55
55
✔ home.spec.ts (5s)
56
56
57
57
2 passed, 2 total
@@ -76,7 +76,7 @@ Then, the **easiest** way to get started is to install the CLI using the followi
76
76
```bash
77
77
npm create checkly@latest
78
78
```
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
80
80
~1 minute.
81
81
82
82
You can also set up the CLI **from scratch** by running:
@@ -89,7 +89,22 @@ npm install --save-dev checkly
89
89
90
90
Official docs are over at [checklyhq.com/docs/cli](https://checklyhq.com/docs/cli/)
91
91
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?
93
108
94
109
- Check out our [Getting Started Guide](https://checklyhq.com/docs/cli/)
95
110
- Join our [Slack Community](https://checklyhq.com/slack). The devs who built this hang out there.
0 commit comments