How checkly/checkly-cli works
Main Components
a. Core CLI Components:
• Command Handler (packages/cli/src/commands)
• Configuration Manager (packages/cli/src/services)
• Check Parser (packages/cli/src/services/check-parser)
• Project Parser (packages/cli/src/services/project-parser)
• Test Runner (packages/cli/src/services/test-runner)
b. Construct System:
• API Check Constructs
• Browser Check Constructs
• Alert Channel Constructs
• Project Constructs
c. External Integrations:
• Checkly Cloud Platform
• Private Locations
• Alert Destinations (Slack, SMS, etc.)
• Playwright Test Runner
[User/Developer IDE] --> [Checkly CLI]
• v
[Check Parser] <--> [Project Parser] <--> [Configuration Manager]
• v v v
[Constructs System] --> [Test Runner] --> [Command Handler]
• v v v
[Local Testing] <--> [Checkly Cloud] <--> [Alert Channels]
• v
• [Private Locations Network]
Component Relationships
• Arrowheads to show data/control flow
Key Elements to Highlight
• The CLI's role as a bridge between local development and cloud monitoring
• The construct system's central role in defining checks
• The separation between local testing and cloud deployment
• Integration with Playwright for browser testing
• Alert channel configuration and management
Additional Details
• Version compatibility information
• Supported alert channel types
• Supported test frameworks
Implementation Notes
• Maintain consistent spacing and alignment
• Clear labels for all components
• Brief descriptions for complex interactions