# checkly/checkly-cli architecture

> Architecture diagram of the GitHub repository checkly/checkly-cli, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/checkly/checkly-cli
- Repository: https://github.com/checkly/checkly-cli

## Overview

##### 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

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph IDE["Developer IDE"]
        Dev[Developer]
    end

    subgraph CLI["Checkly CLI Core"]
        CmdHandler["Command Handler"]
        ConfigMgr["Configuration Manager"]
        ChkParser["Check Parser"]
        ProjParser["Project Parser"]
        TestRunner["Test Runner"]
    end

    subgraph Constructs["Construct System"]
        APICheck["API Check Constructs"]
        BrowserCheck["Browser Check Constructs"]
        AlertConstruct["Alert Channel Constructs"]
        ProjectConstruct["Project Constructs"]
        PrivateLocConstruct["Private Location Constructs"]
    end

    subgraph External["External Systems"]
        Cloud["Checkly Cloud Platform"]
        PrivateLoc["Private Locations Network"]
        PlaywrightRunner["Playwright Test Runner"]
    end

    subgraph Alerts["Alert Destinations"]
        Slack["Slack Alerts"]
        Email["Email Alerts"]
        SMS["SMS Alerts"]
    end

    Dev --> CmdHandler
    
    CmdHandler <--> ConfigMgr
    CmdHandler <--> ChkParser
    CmdHandler <--> ProjParser
    CmdHandler <--> TestRunner
    
    ChkParser <--> APICheck
    ChkParser <--> BrowserCheck
    ProjParser <--> ProjectConstruct
    ConfigMgr <--> AlertConstruct
    ConfigMgr <--> PrivateLocConstruct
    
    TestRunner --> Cloud
    TestRunner <--> PlaywrightRunner
    
    Cloud <--> PrivateLoc
    Cloud <--> Alerts
    
    AlertConstruct --> Alerts
    PrivateLocConstruct --> PrivateLoc

    %% Click Events
    click CmdHandler "https://github.com/checkly/checkly-cli/tree/main/packages/cli/src/commands/"
    click ConfigMgr "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/services/config.ts"
    click ChkParser "https://github.com/checkly/checkly-cli/tree/main/packages/cli/src/services/check-parser/"
    click ProjParser "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/services/project-parser.ts"
    click TestRunner "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/services/test-runner.ts"
    click APICheck "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/constructs/api-check.ts"
    click BrowserCheck "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/constructs/browser-check.ts"
    click AlertConstruct "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/constructs/alert-channel.ts"
    click ProjectConstruct "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/constructs/project.ts"
    click Cloud "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/rest/api.ts"
    click PrivateLocConstruct "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/constructs/private-location.ts"
    click Slack "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/constructs/slack-alert-channel.ts"
    click Email "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/constructs/email-alert-channel.ts"
    click SMS "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/constructs/sms-alert-channel.ts"
    click PlaywrightRunner "https://github.com/checkly/checkly-cli/blob/main/packages/cli/src/playwright/playwright-config-loader.ts"

    %% Styling
    classDef core fill:#2374ab
    classDef construct fill:#7952b3
    classDef external fill:#28a745
    classDef alert fill:#fd7e14
    classDef ide fill:#6c757d

    class CmdHandler,ConfigMgr,ChkParser,ProjParser,TestRunner core
    class APICheck,BrowserCheck,AlertConstruct,ProjectConstruct,PrivateLocConstruct construct
    class Cloud,PrivateLoc,PlaywrightRunner external
    class Slack,Email,SMS alert
    class Dev,IDE ide
```
