# yannjor/krabby architecture

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

- Interactive diagram: https://gitdiagram.com/yannjor/krabby
- Repository: https://github.com/yannjor/krabby

## Overview

##### High-Level Architectural Components
a. CLI Layer
- Entry point (src/main.rs)
- Argument parsing & subcommand dispatch (e.g. list, name, random) using a CLI library (likely clap)
b. Business Logic Layer
- Command handlers (in src/main.rs or delegated to modules)
- Pokémon selection logic (src/pokemon.rs): reading filters, randomization, name lookup
c. Data Access Layer
- Static assets:
- Text-based sprites under assets/colorscripts/{regular,shiny}/…
- Metadata in assets/pokemon.json
- Configuration management (src/config.rs): load or write a TOML file in the user’s config directory
d. Output Formatting Layer
- Error handling (src/error.rs)

##### Relationships & Data Flows
- User invokes `krabby` from terminal → CLI Layer
- CLI Layer parses arguments and calls into Business Logic
- Business Logic consults:
- Config Module to load language, shiny probability
- Data Access to retrieve the appropriate sprite and JSON entry
- Errors bubble up to Error Handler → STDERR

##### Key Architectural Patterns & Principles
- Layered architecture (CLI → Logic → Data → Output)
- Separation of concerns: each Rust module focuses on one responsibility
- Static resource bundling: assets directory kept alongside the binary (or embedded) for offline use
- Configuration file per XDG spec, enabling extensibility

##### Technologies & Frameworks
- Rust toolchain & Cargo
- CLI parsing crate (e.g., clap)
- serde/serde_json for JSON
- toml crate for config

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External User
    User((User)):::external

    %% CLI Layer
    subgraph "CLI Layer"
        CLI["CLI Layer\n(src/main.rs)"]:::code
    end

    %% Business Logic Layer
    subgraph "Business Logic"
        Dispatcher["Command & Pokémon Logic\n(src/pokemon.rs)"]:::code
        Config["Config Manager\n(src/config.rs)"]:::code
        Error["Error Handler\n(src/error.rs)"]:::code
    end

    %% Data Access Layer
    subgraph "Data Access"
        Regular["Sprites (regular)\nassets/colorscripts/regular/"]:::data
        Shiny["Sprites (shiny)\nassets/colorscripts/shiny/"]:::data
        JSON["Pokémon Metadata\nassets/pokemon.json"]:::data
    end

    %% Output Layer
    subgraph "Output Layer"
        Renderer["Output Renderer\n(ANSI & Unicode)"]:::code
        STDOUT["Terminal STDOUT"]:::external
        STDERR["Terminal STDERR"]:::external
    end

    %% Data Flows
    User -->|invokes `krabby`| CLI
    CLI -->|"parse & dispatch"| Dispatcher
    Dispatcher -->|"load config"| Config
    Dispatcher -->|"retrieve sprite"| Regular
    Dispatcher -->|"retrieve sprite"| Shiny
    Dispatcher -->|"lookup metadata"| JSON
    Dispatcher -->|"render output"| Renderer
    Renderer -->|writes to| STDOUT

    %% Error Flows
    CLI -->|errors| Error
    Config -->|errors| Error
    Dispatcher -->|errors| Error
    Renderer -->|errors| Error
    Error -->|writes to| STDERR

    %% Click Events
    click CLI "https://github.com/yannjor/krabby/blob/main/src/main.rs"
    click Dispatcher "https://github.com/yannjor/krabby/blob/main/src/pokemon.rs"
    click Config "https://github.com/yannjor/krabby/blob/main/src/config.rs"
    click Error "https://github.com/yannjor/krabby/blob/main/src/error.rs"
    click Regular "https://github.com/yannjor/krabby/tree/main/assets/colorscripts/regular/"
    click Shiny "https://github.com/yannjor/krabby/tree/main/assets/colorscripts/shiny/"
    click JSON "https://github.com/yannjor/krabby/blob/main/assets/pokemon.json"

    %% Styles
    classDef code fill:#cce5ff,stroke:#004085,color:#004085;
    classDef data fill:#fff3cd,stroke:#856404,color:#856404;
    classDef external fill:#d4edda,stroke:#155724,color:#155724;
```
