# seek-oss/skuba architecture

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

- Interactive diagram: https://gitdiagram.com/seek-oss/skuba
- Repository: https://github.com/seek-oss/skuba

## Overview

##### Project type and purpose
- This is an open-source toolkit and CLI (“skuba”) for bootstrapping, configuring, building, testing, linting, and deploying TypeScript backend applications and packages.
- It provides:
- A CLI front-end
- A library of development and runtime APIs (under src/api and src/wrapper)
- A set of reusable templates (under template/)
- Configuration presets (in packages/)
- Support scripts (in scripts/)
- Documentation site (in site/)
- CI/CD workflows (in .github/workflows/)

##### File structure
- Monorepo managed via pnpm-workspace.yaml
- Top-level components:
- config/ — ESLint, Jest, Prettier, TS configs
- docs/ — user guides, CLI docs, deep-dives
- integration/ & jest/ — integration and unit test fixtures
- packages/ — two published npm packages (eslint-config-skuba, skuba-dive)
- scripts/ — build, deploy, test-template shell and TypeScript scripts
- site/ — static site configuration for documentation
- src/ — core implementation of CLI, APIs, wrappers, and utilities
- template/ — project starter templates for Express, Koa, Lambda, OSS packages, etc.
- .github/ — CI workflows driving test, validate, release pipelines

##### README for additional insights
- Confirms TypeScript, ESLint, Prettier, Jest, Gantry, Serverless, AWS CDK as key technologies
- Emphasizes CLI commands, Templates, Development and Runtime APIs

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "CLI Front-end"
        entry["Entrypoints"]:::repo
        commands["Commands"]:::repo
    end

    subgraph "Core Libraries"
        devapi["Development API"]:::repo
        runtime["Runtime API & Wrappers"]:::repo
        utils["Utilities"]:::repo
    end

    subgraph "Templates"
        templates["Starter Templates"]:::repo
    end

    subgraph "Published Packages"
        eslintpkg["ESLint Config Package"]:::repo
        divepkg["skuba-dive Package"]:::repo
    end

    subgraph "Scripts & Config Presets"
        scripts["Scripts"]:::scripts
        configpresets["Config Presets"]:::config
    end

    subgraph "Test Fixtures"
        integration["Integration Fixtures"]:::repo
        jestfixtures["Unit Test Fixtures"]:::repo
    end

    subgraph "Documentation & Site"
        docs["Docs"]:::docs
        site["Site"]:::docs
    end

    subgraph "CI/CD & Registry"
        workflows["GitHub Workflows"]:::ci
        workspace["pnpm-workspace.yaml"]:::config
        npm["npm Registry"]:::external
        github["GitHub"]:::external
    end

    entry --> commands
    commands -->|"init reads"| templates
    commands -->|"configure analyzes"| devapi
    commands -->|"invoke runtime"| runtime
    commands -->|"use utilities"| utils
    commands -->|"exec tools"| externaltools["Build & Test Tools"]:::external
    commands --> scripts
    commands --> configpresets

    devapi --> jestfixtures
    runtime --> integration

    scripts --> workflows
    configpresets --> commands
    workspace --> eslintpkg
    workspace --> divepkg
    workspace --> templates

    docs --> site
    workflows --> npm
    workflows --> github

    entry --> rootts["tsconfig.json & tsconfig.build.json"]:::config

    classDef repo fill:#bbdefb,stroke:#333,stroke-width:1px
    classDef scripts fill:#fff9c4,stroke:#333,stroke-width:1px
    classDef config fill:#fff59d,stroke:#333,stroke-width:1px
    classDef docs fill:#c8e6c9,stroke:#333,stroke-width:1px
    classDef ci fill:#d7ccc8,stroke:#333,stroke-width:1px
    classDef external fill:#cfd8dc,stroke:#333,stroke-width:1px

    click entry "https://github.com/seek-oss/skuba/blob/main/src/index.ts"
    click entry "https://github.com/seek-oss/skuba/blob/main/src/skuba.ts"
    click commands "https://github.com/seek-oss/skuba/tree/main/src/cli/"
    click devapi "https://github.com/seek-oss/skuba/tree/main/src/api/"
    click runtime "https://github.com/seek-oss/skuba/tree/main/src/wrapper/"
    click utils "https://github.com/seek-oss/skuba/tree/main/src/utils/"
    click templates "https://github.com/seek-oss/skuba/tree/main/template/"
    click eslintpkg "https://github.com/seek-oss/skuba/tree/main/packages/eslint-config-skuba/"
    click divepkg "https://github.com/seek-oss/skuba/tree/main/packages/skuba-dive/"
    click scripts "https://github.com/seek-oss/skuba/tree/main/scripts/"
    click configpresets "https://github.com/seek-oss/skuba/tree/main/config/"
    click docs "https://github.com/seek-oss/skuba/tree/main/docs/"
    click site "https://github.com/seek-oss/skuba/tree/main/site/"
    click workflows "https://github.com/seek-oss/skuba/tree/main/.github/workflows/"
    click workspace "https://github.com/seek-oss/skuba/blob/main/pnpm-workspace.yaml"
```
