feat(cli): add checks list/get commands with typed formatters

.github/workflows/test.yml

@@ -46,6 +46,8 @@ jobs:
           CHECKLY_ACCOUNT_NAME: ${{ secrets.E2E_CHECKLY_ACCOUNT_NAME }}
           CHECKLY_ACCOUNT_ID: ${{ secrets.E2E_CHECKLY_ACCOUNT_ID }}
           CHECKLY_API_KEY: ${{ secrets.E2E_CHECKLY_API_KEY }}
+          CHECKLY_EMPTY_ACCOUNT_ID: ${{ secrets.E2E_EMPTY_CHECKLY_ACCOUNT_ID }}
+          CHECKLY_EMPTY_API_KEY: ${{ secrets.E2E_EMPTY_CHECKLY_API_KEY }}
       - name: Save LLM rules as an artifact
         uses: actions/upload-artifact@v4
         with:

packages/cli/e2e/README.md

@@ -6,3 +6,9 @@ Since the E2E tests rely on test accounts in Checkly, some configuration is need
 
 To run the E2E tests locally, create a file `local.js` in [./config](./config). This configuration file should override all of the options from [./config/default.js](./config/default.js).
 
+### Empty account tests (optional)
+
+Some tests verify edge-case behavior against an account with no checks. These are skipped automatically when credentials aren't configured.
+
+To run them locally, add `emptyApiKey` and `emptyAccountId` to your `config/local.js`, or set `CHECKLY_EMPTY_API_KEY` and `CHECKLY_EMPTY_ACCOUNT_ID` in your environment. In CI, these are provided via GitHub secrets.
+

packages/cli/e2e/__tests__/checks-empty-account.spec.ts

@@ -0,0 +1,61 @@
+import config from 'config'
+import { describe, it, expect } from 'vitest'
+
+import { runChecklyCli } from '../run-checkly'
+
+const apiKey: string | undefined = config.get('emptyApiKey')
+const accountId: string | undefined = config.get('emptyAccountId')
+
+describe.skipIf(!apiKey || !accountId)('checks commands on empty account', () => {
+  it('should show "No checks found." for checks list', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'list'],
+      apiKey,
+      accountId,
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('No checks found.')
+  })
+
+  it('should return empty JSON array for checks list --output json', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'list', '--output', 'json'],
+      apiKey,
+      accountId,
+    })
+    expect(result.status).toBe(0)
+    const parsed = JSON.parse(result.stdout)
+    expect(parsed.data).toEqual([])
+    expect(parsed.pagination.total).toBe(0)
+  })
+
+  it('should show "No checks found." for checks list --output md', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'list', '--output', 'md'],
+      apiKey,
+      accountId,
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('No checks found.')
+  })
+
+  it('should handle --search filter gracefully on empty account', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'list', '--search', 'anything'],
+      apiKey,
+      accountId,
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('No checks matching')
+  })
+
+  it('should fail gracefully for checks get on empty account', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'get', '00000000-0000-0000-0000-000000000000'],
+      apiKey,
+      accountId,
+    })
+    expect(result.status).toBe(1)
+    expect(result.stdout).toContain('Failed to get check details')
+  })
+})

packages/cli/e2e/__tests__/checks-get.spec.ts

@@ -0,0 +1,60 @@
+import config from 'config'
+import { describe, it, expect, beforeAll } from 'vitest'
+
+import { runChecklyCli } from '../run-checkly'
+
+describe('checkly checks get', () => {
+  let checkId: string
+
+  beforeAll(async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'list', '--output', 'json', '--limit', '1'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    const parsed = JSON.parse(result.stdout)
+    expect(parsed.data.length).toBeGreaterThan(0)
+    checkId = parsed.data[0].id
+  })
+
+  it('should get check detail with default output', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'get', checkId],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toBeTruthy()
+  })
+
+  it('should output valid JSON with --output json', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'get', checkId, '--output', 'json'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    const parsed = JSON.parse(result.stdout)
+    expect(parsed.check.id).toBe(checkId)
+  })
+
+  it('should output markdown with --output md', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'get', checkId, '--output', 'md'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('| Field | Value |')
+  })
+
+  it('should fail for nonexistent check ID', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'get', 'nonexistent-check-id-00000'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).not.toBe(0)
+  })
+})

packages/cli/e2e/__tests__/checks-list.spec.ts

@@ -0,0 +1,58 @@
+import config from 'config'
+import { describe, it, expect } from 'vitest'
+
+import { runChecklyCli } from '../run-checkly'
+
+describe('checkly checks list', () => {
+  it('should list checks with default output', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'list'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toBeTruthy()
+  })
+
+  it('should output valid JSON with --output json', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'list', '--output', 'json'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    const parsed = JSON.parse(result.stdout)
+    expect(parsed).toHaveProperty('data')
+    expect(Array.isArray(parsed.data)).toBe(true)
+  })
+
+  it('should output markdown with --output md', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'list', '--output', 'md'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('| Name | Type | Status |')
+  })
+
+  it('should respect --limit flag', async () => {
+    const allResult = await runChecklyCli({
+      args: ['checks', 'list', '--output', 'json'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(allResult.status).toBe(0)
+    const allParsed = JSON.parse(allResult.stdout)
+    expect(allParsed.data.length).toBeGreaterThan(1)
+
+    const limitedResult = await runChecklyCli({
+      args: ['checks', 'list', '--output', 'json', '--limit', '1'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(limitedResult.status).toBe(0)
+    const limitedParsed = JSON.parse(limitedResult.stdout)
+    expect(limitedParsed.data).toHaveLength(1)
+  })
+})

packages/cli/e2e/__tests__/help.spec.ts

@@ -49,6 +49,7 @@ describe('help', () => {
   trigger  Trigger your existing checks on Checkly.`)
 
     expect(stdout).toContain(`ADDITIONAL COMMANDS
+  checks           List and inspect checks in your Checkly account.
   destroy          Destroy your project with all its related resources.
   env              Manage Checkly environment variables.
   help             Display help for checkly.

packages/cli/e2e/config/default.js

@@ -7,4 +7,8 @@ config.apiKey = process.env.CHECKLY_API_KEY
 config.accountId = process.env.CHECKLY_ACCOUNT_ID
 config.baseURL = process.env.CHECKLY_BASE_URL || 'https://api.checklyhq.com'
 
+// Optional: empty account for edge-case testing (no checks, no groups, etc.)
+config.emptyApiKey = process.env.CHECKLY_EMPTY_API_KEY
+config.emptyAccountId = process.env.CHECKLY_EMPTY_ACCOUNT_ID
+
 module.exports = config

packages/cli/package.json

@@ -64,6 +64,9 @@
       "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>. To update, run `npm install -D checkly@latest`"
     },
     "topics": {
+      "checks": {
+        "description": "List and inspect checks in your Checkly account."
+      },
       "env": {
         "description": "Manage Checkly environment variables."
       },