Skip to content

Commit 56a7aa3

Browse files
authored
feat: add clearer instructions on install. (#1309)
1 parent 196ab91 commit 56a7aa3

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

site/static/docs/ai/checkly.rules.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Checkly
22

33
- Refer to docs for Checkly CLI v6.0.0 and above.
4-
- To generate the initial setup for Checkly use the command `npm create checkly@latest`
54
- Check the Checkly CLI output to figure out into which folder the setup was generated
65
- Use the [Checkly CLI reference documentation](https://www.checklyhq.com/docs/cli/command-line-reference)
76
- Use the [Checkly construct reference documentation](https://www.checklyhq.com/docs/cli/constructs-reference)
@@ -14,6 +13,11 @@
1413
- If endpoints require authentication ask the user which authentication method to use and then generate a setupScript to authenticate the given requests
1514
- Referenced setupScript for ApiChecks must be plain ts files and not export anything
1615

16+
## Installing the Checkly CLI
17+
18+
- Always use `npm create checkly@latest`.
19+
- Do not make up commands that do not exist.
20+
1721
## Project Structure
1822

1923
- `checkly.config.ts` - Mandatory global project and CLI configuration. We recommend using TypeScript.

0 commit comments

Comments
 (0)