# cliutils/cli11 architecture

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

- Interactive diagram: https://gitdiagram.com/cliutils/cli11
- Repository: https://github.com/cliutils/cli11

## Overview

##### Project type and purpose
- CLI11 is an open-source, header-only C++11 library that provides a rich, extensible command-line parsing framework.
- It includes:
- Core code (public headers, minimal .cpp)
- Single-header generator
- Unit tests (Catch2), fuzz tests
- Examples / demo apps
- Documentation (Doxygen + GitBook)
- Multiple build systems (CMake, Bazel, Meson)
- CI/CD pipelines (GitHub Actions, Azure Pipelines)

A. Core Library
– include/CLI (App.hpp, Option.hpp, Validator.hpp, Formatter.hpp, Config.hpp, ... )
– src/Precompile.cpp
– single-include/CLI11.hpp (generated artifact)
B. Build & Packaging
– CMakeLists.txt, BUILD.bazel, meson.build
– CMakePresets.json, scripts/ (ExtractVersion.py, MakeSingleHeader.py, style checks)
C. Testing & Fuzzing
– tests/ (Catch2 tests, mesonTest/)
– fuzz/ (fuzz targets, dictionaries)
– subprojects/catch2.wrap
D. Examples & Samples
– examples/ (dozens of small demos)
– book/code/ (runnable code snippets for docs)
E. Documentation
– docs/ (Doxygen: Doxyfile, markup)
– book/ (GitBook sources, SUMMARY.md, chapters)
F. CI/CD & External Services
– .github/workflows/ (build/test/docs pipelines)
– .ci/ (Azure build/test YAML)
– azure-pipelines.yml, codecov.yml, codacy.yml, dependabot.yml
– External: GitHub Actions, Azure Pipelines, CodeCov, Codacy, Dependabot

##### Relationships & Data Flows
- Build tools (CMake, Bazel, Meson) ──► compile Core Library into tests, examples, fuzz targets
- scripts/ ──► generate single-include header
- Core Library ──► used by Examples & Tests
- Tests & Fuzz ──► report coverage to CodeCov; report status to CI
- Documentation sources ──► Doxygen & GitBook pipelines produce HTML/PDF; published via CI
- CI/CD pipelines ──► orchestrate builds, tests, docs, status badges; integrate with external services

##### Architectural patterns & principles
- Layered Modules
- Core parsing engine (App, Option, Validator, Formatter, Config)
- Utilities (Timer, AutoTimer)
- Interface‐generation (single header)
- Platform abstraction (Unicode handling)
- Header-only design for zero dependencies
- Plug-in validators & formatters via virtual / template interfaces
- Multiple build backends for portability

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Core Library (blue)
    subgraph "Core Library"
        direction TB
        includeCLI["include/CLI/"]:::code
        srcPrecompile["src/Precompile.cpp"]:::code
        singleIncludeIn["single-include/CLI11.hpp.in"]:::code
        singleIncludeOut(("single-include/CLI11.hpp")):::artifact
    end

    %% Build & Packaging (green)
    subgraph "Build & Packaging"
        direction TB
        CMakeLists["CMakeLists.txt"]:::build
        Bazel["BUILD.bazel"]:::build
        Meson["meson.build"]:::build
        CMakePresets["CMakePresets.json"]:::build
        Scripts["scripts/"]:::build
    end

    %% Testing & Fuzzing (blue)
    subgraph "Testing & Fuzzing"
        direction TB
        Tests["tests/"]:::code
        Fuzz["fuzz/"]:::code
        CatchWrap["subprojects/catch2.wrap"]:::code
    end

    %% Examples & Samples (blue)
    subgraph "Examples & Samples"
        direction TB
        Examples["examples/"]:::code
        BookCode["book/code/"]:::code
    end

    %% Documentation (purple)
    subgraph "Documentation"
        direction TB
        DocsSrc["docs/"]:::docs
        BookSrc["book/"]:::docs
        DoxygenOut(("HTML/PDF (Doxygen)")):::artifact
        GitBookOut(("GitBook Site")):::artifact
    end

    %% CI/CD & External Services (orange)
    subgraph "CI/CD & External Services"
        direction TB
        GitHubWF[".github/workflows/"]:::ci
        AzureCI[".ci/"]:::ci
        AzurePipYml["azure-pipelines.yml"]:::ci
        CodecovYml[".github/codecov.yml"]:::ci
        CodacyYml[".codacy.yml"]:::ci
        DependabotYml[".github/dependabot.yml"]:::ci
        %% External Clouds
        GitHubActions(("GitHub Actions")):::external
        AzureServices(("Azure Pipelines")):::external
        CodeCov(("CodeCov")):::external
        Codacy(("Codacy")):::external
        Dependabot(("Dependabot")):::external
    end

    %% Relationships
    CMakeLists -->|compile| includeCLI
    Bazel -->|compile| includeCLI
    Meson -->|compile| includeCLI

    includeCLI -->|used by| Tests
    includeCLI -->|used by| Examples
    includeCLI -->|used by| Fuzz

    Scripts -->|generate| singleIncludeOut
    singleIncludeIn -->|input| Scripts

    Tests -->|coverage report| CodeCov
    Fuzz -->|coverage report| CodeCov

    Tests -->|status| GitHubActions
    Tests -->|status| AzureServices
    Fuzz -->|status| GitHubActions

    DocsSrc -->|build docs| DoxygenOut
    BookSrc -->|build site| GitBookOut

    DoxygenOut -->|publish| GitHubActions
    GitBookOut -->|publish| GitHubActions

    GitHubWF -->|orchestrates| CMakeLists
    GitHubWF -->|orchestrates| Tests
    GitHubWF -->|orchestrates| DoxygenOut
    AzureCI -->|orchestrates| CMakeLists

    GitHubActions -->|integrates| CodeCov
    GitHubActions -->|integrates| Codacy
    GitHubActions -->|integrates| Dependabot
    AzureServices -->|integrates| CodeCov

    %% Click Events
    click includeCLI "https://github.com/cliutils/cli11/tree/main/include/CLI/"
    click srcPrecompile "https://github.com/cliutils/cli11/blob/main/src/Precompile.cpp"
    click singleIncludeIn "https://github.com/cliutils/cli11/blob/main/single-include/CLI11.hpp.in"
    click CMakeLists "https://github.com/cliutils/cli11/blob/main/CMakeLists.txt"
    click Bazel "https://github.com/cliutils/cli11/blob/main/BUILD.bazel"
    click Meson "https://github.com/cliutils/cli11/blob/main/meson.build"
    click CMakePresets "https://github.com/cliutils/cli11/blob/main/CMakePresets.json"
    click Scripts "https://github.com/cliutils/cli11/tree/main/scripts/"
    click Tests "https://github.com/cliutils/cli11/tree/main/tests/"
    click Fuzz "https://github.com/cliutils/cli11/tree/main/fuzz/"
    click CatchWrap "https://github.com/cliutils/cli11/blob/main/subprojects/catch2.wrap"
    click Examples "https://github.com/cliutils/cli11/tree/main/examples/"
    click BookCode "https://github.com/cliutils/cli11/tree/main/book/code/"
    click DocsSrc "https://github.com/cliutils/cli11/tree/main/docs/"
    click BookSrc "https://github.com/cliutils/cli11/tree/main/book/"
    click GitHubWF "https://github.com/cliutils/cli11/tree/main/.github/workflows/"
    click AzureCI "https://github.com/cliutils/cli11/tree/main/.ci/"
    click AzurePipYml "https://github.com/cliutils/cli11/blob/main/azure-pipelines.yml"
    click CodecovYml "https://github.com/cliutils/cli11/blob/main/.github/codecov.yml"
    click CodacyYml "https://github.com/cliutils/cli11/blob/main/.codacy.yml"
    click DependabotYml "https://github.com/cliutils/cli11/blob/main/.github/dependabot.yml"

    %% Styles
    classDef code fill:#cce5ff,stroke:#004085,color:#004085
    classDef build fill:#d4edda,stroke:#155724,color:#155724
    classDef docs fill:#f5c6cb,stroke:#721c24,color:#721c24
    classDef ci fill:#fff3cd,stroke:#856404,color:#856404
    classDef artifact fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef external fill:#d1ecf1,stroke:#0c5460,color:#0c5460
```
