Merge branch 'main' into feat/deploy-show-resource-details

Author: MichaelHogers

.github/workflows/release-canary.yml

@@ -18,6 +18,10 @@ jobs:
         with:
           node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
+      - name: Upgrade npm for trusted publishing support
+        run: |
+          npm install -g npm@latest
+          echo "npm version: $(npm --version)"
       # Extract the dynamic value from the canary label if present
       - name: Extract CANARY_TAG
         id: extract-canary

.github/workflows/release.yml

@@ -39,8 +39,10 @@ jobs:
         with:
           node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
-        env:
-            NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Upgrade npm for trusted publishing support
+        run: |
+          npm install -g npm@latest
+          echo "npm version: $(npm --version)"
       # Ensure that the README is published with the package
       - run: rm -f packages/cli/README.md && cp README.md packages/cli
       - run: npm ci
@@ -105,9 +107,11 @@ jobs:
         with:
           node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-              # Ensure that the README is published with the package
+      - name: Upgrade npm for trusted publishing support
+        run: |
+          npm install -g npm@latest
+          echo "npm version: $(npm --version)"
+      # Ensure that the README is published with the package
       - run: rm -f packages/cli/README.md && cp README.md packages/cli
       - run: npm ci
       - name: Set version and publish 'cli' package

CONTRIBUTING.md

@@ -87,8 +87,18 @@ triggered and a new experimental version can be installed by executing:
 npm install checkly@0.0.0-pr.<PR-NUMBER>.<COMMIT_SHORT_SHA>
 ```
 
+> **Note:** Canary builds authenticate to npm using the `NPM_TOKEN` secret (a long-lived token). This is because the canary workflow (`release-canary.yml`) is a separate workflow file from the one configured as a trusted publisher on npmjs.com.
+
 ## Releasing
 
+### NPM authentication
+
+The release workflow (`release.yml`) uses [npm trusted publishing](https://docs.npmjs.com/generating-provenance-statements) with GitHub OIDC — no long-lived npm token is needed. GitHub Actions mints a short-lived OIDC token that npm validates against the trusted publisher configuration on npmjs.com.
+
+Both `checkly` and `create-checkly` packages have trusted publishing configured for `checkly/checkly-cli` / `release.yml`. There is no secret to rotate for releases.
+
+The canary workflow (`release-canary.yml`) still uses the `NPM_TOKEN` secret because npm only allows one trusted publisher entry per package, and it is bound to `release.yml`.
+
 ### Releasing `checkly` packages
 
 Both packages [checkly](https://www.npmjs.com/package/checkly) and [create-cli](https://www.npmjs.com/package/create-checkly) are built and published by the corresponding GitHub action [here](https://github.com/checkly/checkly-cli/actions/workflows/release.yml).

packages/cli/e2e/__tests__/account-plan.spec.ts

@@ -0,0 +1,123 @@
+import config from 'config'
+import { describe, it, expect } from 'vitest'
+
+import { runChecklyCli } from '../run-checkly'
+
+describe('checkly account plan', () => {
+  it('should show plan summary with default output', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('Plan:')
+    expect(result.stdout).toContain('Metered entitlements')
+    expect(result.stdout).toContain('additional features enabled')
+  })
+
+  it('should output valid JSON with --output json', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan', '--output', 'json'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    const parsed = JSON.parse(result.stdout)
+    expect(parsed).toHaveProperty('plan')
+    expect(parsed).toHaveProperty('planDisplayName')
+    expect(parsed).toHaveProperty('addons')
+    expect(parsed).toHaveProperty('entitlements')
+    expect(Array.isArray(parsed.entitlements)).toBe(true)
+    expect(parsed.entitlements.length).toBeGreaterThan(0)
+    expect(parsed.entitlements[0]).toHaveProperty('key')
+    expect(parsed.entitlements[0]).toHaveProperty('type')
+    expect(parsed.entitlements[0]).toHaveProperty('enabled')
+  })
+
+  it('should output markdown with --output md', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan', '--output', 'md'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('# Plan:')
+    expect(result.stdout).toContain('| Name | Limit |')
+  })
+
+  it('should show detail view for a specific entitlement key', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan', 'BROWSER_CHECKS'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('BROWSER_CHECKS')
+    expect(result.stdout).toContain('Browser checks')
+  })
+
+  it('should output single entitlement as JSON', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan', 'BROWSER_CHECKS', '--output', 'json'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    const parsed = JSON.parse(result.stdout)
+    expect(parsed.key).toBe('BROWSER_CHECKS')
+    expect(parsed.type).toBe('metered')
+  })
+
+  it('should filter by --type metered', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan', '--type', 'metered'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('LIMIT')
+    expect(result.stdout).toContain('entitlement')
+  })
+
+  it('should filter by --type flag', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan', '--type', 'flag'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('ENABLED')
+    expect(result.stdout).toContain('entitlement')
+  })
+
+  it('should filter by --search', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan', '--search', 'browser'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('Browser')
+    expect(result.stdout).toContain('entitlement')
+  })
+
+  it('should fail for unknown entitlement key', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan', 'NONEXISTENT_KEY'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(2)
+    expect(result.stderr).toContain('not found')
+  })
+
+  it('should fail when combining key with --type', async () => {
+    const result = await runChecklyCli({
+      args: ['account', 'plan', 'BROWSER_CHECKS', '--type', 'metered'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).not.toBe(0)
+  })
+})

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

@@ -49,6 +49,29 @@ describe.skipIf(!apiKey || !accountId)('checks commands on empty account', () =>
     expect(result.stdout).toContain('No checks matching')
   })
 
+  it('should show "No checks found." for checks stats', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'stats'],
+      apiKey,
+      accountId,
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('No checks found.')
+  })
+
+  it('should return empty JSON for checks stats --output json', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'stats', '--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)
+    expect(parsed.range).toBe('last24Hours')
+  })
+
   it('should fail gracefully for checks get on empty account', async () => {
     const result = await runChecklyCli({
       args: ['checks', 'get', '00000000-0000-0000-0000-000000000000'],

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

@@ -0,0 +1,89 @@
+import config from 'config'
+import { describe, it, expect } from 'vitest'
+
+import { runChecklyCli } from '../run-checkly'
+
+describe('checkly checks stats', () => {
+  it('should show stats with default output', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'stats'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toBeTruthy()
+    expect(result.stdout).toContain('STATS')
+  })
+
+  it('should output valid JSON with --output json', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'stats', '--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)
+    expect(parsed).toHaveProperty('range')
+    expect(parsed).toHaveProperty('pagination')
+    expect(parsed.data.length).toBeGreaterThan(0)
+    expect(parsed.data[0]).toHaveProperty('checkId')
+    expect(parsed.data[0]).toHaveProperty('availability')
+  })
+
+  it('should output markdown with --output md', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'stats', '--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 result = await runChecklyCli({
+      args: ['checks', 'stats', '--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).toHaveLength(1)
+    expect(parsed.pagination.limit).toBe(1)
+  })
+
+  it('should respect --range flag', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'stats', '--output', 'json', '--range', 'last7Days'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    const parsed = JSON.parse(result.stdout)
+    expect(parsed.range).toBe('last7Days')
+  })
+
+  it('should return no results for impossible search filter', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'stats', '--search', 'zzz-nonexistent-check-name-zzz'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    expect(result.stdout).toContain('No checks found.')
+  })
+
+  it('should return empty JSON for impossible search filter with --output json', async () => {
+    const result = await runChecklyCli({
+      args: ['checks', 'stats', '--search', 'zzz-nonexistent-check-name-zzz', '--output', 'json'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+    })
+    expect(result.status).toBe(0)
+    const parsed = JSON.parse(result.stdout)
+    expect(parsed.data).toEqual([])
+    expect(parsed.pagination.total).toBe(0)
+  })
+})

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
+  account          View and manage your Checkly account.
   checks           List and inspect checks in your Checkly account.
   destroy          Destroy your project with all its related resources.
   env              Manage Checkly environment variables.

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

@@ -11,5 +11,6 @@ describe('whomai', () => {
       accountId: config.get('accountId'),
     })
     expect(stdout).toContain(config.get('accountName'))
+    expect(stdout).toContain('Plan:')
   })
 })

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": {
+      "account": {
+        "description": "View and manage your Checkly account."
+      },
       "checks": {
         "description": "List and inspect checks in your Checkly account."
       },
@@ -76,9 +79,6 @@
       "import": {
         "description": "Import existing resources from your Checkly account to your project."
       },
-      "skills": {
-        "description": "Explore Checkly AI agent skills, actions and reference documentation."
-      },
       "status-pages": {
         "description": "List and manage status pages in your Checkly account."
       }

packages/cli/src/ai-context/README.md

@@ -26,6 +26,10 @@ Agent Skills are a standardized format for giving AI agents specialized knowledg
 - Build dashboards and status pages
 - Follow monitoring-as-code best practices with the Checkly CLI
 
+## Installing This Skill
+
+Run `npx checkly skills install` to install the skill into your project. The command supports Claude Code, Cursor, Codex and more out of the box, or you can specify a custom path.
+
 ## Using This Skill
 
 AI agents can load this skill to gain expertise in Checkly monitoring. The skill follows the [Agent Skills specification](https://agentskills.io) with: