# coderamp-labs/gitingest architecture

> Architecture diagram of the GitHub repository coderamp-labs/gitingest, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/coderamp-labs/gitingest
- Repository: https://github.com/coderamp-labs/gitingest
- Video tour (about a minute): https://gitdiagram.com/coderamp-labs/gitingest/video

## Overview

Gitingest turns a repository URL, slug, or local directory into an LLM-ready text digest, with file-tree, size, and token statistics. The main workflow parses the source and filtering options, resolves and clones remote repositories when needed, traverses files, and formats the result. A FastAPI service exposes ingestion and digest retrieval, with optional S3 caching and storage. The graph reflects README-described capabilities and indexed references; some server and CLI internals were not sampled, so uncertain links are omitted.

Main entry points: [`src/server/query_processor.py`](https://github.com/coderamp-labs/gitingest/blob/main/src/server/query_processor.py) (Server query orchestration), [`src/gitingest/ingestion.py`](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/ingestion.py) (Filesystem ingestion), [`src/gitingest/entrypoint.py`](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/entrypoint.py) (CLI and package API), [`src/gitingest/query_parser.py`](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/query_parser.py) (Source and option parsing)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interfaces["User interfaces"]
  node_cli["CLI and package API<br/>[entrypoint.py]"]
  node_web["Web interface"]
end

subgraph group_ingestion["Ingestion pipeline"]
  node_parse["Source and option parsing<br/>[query_parser.py]"]
  node_parse_utils["URL and ref utilities"]
  node_clone["Repository cloning<br/>[clone.py]"]
  node_git["Git operations<br/>[git_utils.py]"]
end

subgraph group_processing["Digest processing"]
  node_walk["Filesystem ingestion<br/>[ingestion.py]"]
  node_patterns["File filtering<br/>[pattern_utils.py]"]
  node_ignore["Ignore patterns<br/>[ignore_patterns.py]"]
  node_format["Digest formatting"]
  node_config["Ingestion configuration<br/>[config.py]"]
  node_schemas["Ingestion data schemas<br/>[ingestion.py]"]
end

subgraph group_service["Web service"]
  node_server["FastAPI application<br/>[main.py]"]
  node_routes["Ingest routes<br/>[ingest.py]"]
  node_query["Server query orchestration<br/>[query_processor.py]"]
  node_models["Request and response models<br/>[models.py]"]
  node_s3[("S3 digest storage<br/>[s3_utils.py]")]
end

node_source(("Repository or directory"))

node_source -->|"provides input"| node_cli
node_cli -->|"parses source"| node_parse
node_parse -->|"normalizes input"| node_parse_utils
node_parse -->|"resolves commit"| node_git
node_cli -->|"clones repository"| node_clone
node_clone -->|"uses Git"| node_git
node_cli -->|"ingests files"| node_walk
node_walk -->|"formats digest"| node_format
node_walk -->|"uses limits"| node_config
node_walk -.->|"applies filters"| node_patterns
node_patterns -->|"uses patterns"| node_ignore
node_walk -->|"builds file data"| node_schemas
node_web -.->|"submits request"| node_server
node_server -->|"registers routes"| node_routes
node_routes -->|"validates request"| node_models
node_routes -->|"starts ingestion"| node_query
node_query -->|"parses repository"| node_parse
node_query -->|"clones repository"| node_clone
node_query -->|"ingests files"| node_walk
node_query -->|"checks and stores"| node_s3
node_query -->|"returns response"| node_models

click node_cli "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/entrypoint.py"
click node_web "https://github.com/coderamp-labs/gitingest/tree/main/src/static/js"
click node_server "https://github.com/coderamp-labs/gitingest/blob/main/src/server/main.py"
click node_routes "https://github.com/coderamp-labs/gitingest/blob/main/src/server/routers/ingest.py"
click node_query "https://github.com/coderamp-labs/gitingest/blob/main/src/server/query_processor.py"
click node_models "https://github.com/coderamp-labs/gitingest/blob/main/src/server/models.py"
click node_s3 "https://github.com/coderamp-labs/gitingest/blob/main/src/server/s3_utils.py"
click node_parse "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/query_parser.py"
click node_parse_utils "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/utils/query_parser_utils.py"
click node_clone "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/clone.py"
click node_git "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/utils/git_utils.py"
click node_walk "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/ingestion.py"
click node_patterns "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/utils/pattern_utils.py"
click node_ignore "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/utils/ignore_patterns.py"
click node_format "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/output_formatter.py"
click node_config "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/config.py"
click node_schemas "https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/schemas/ingestion.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_web toneBlue
class node_parse,node_parse_utils,node_clone,node_git toneAmber
class node_walk,node_patterns,node_ignore,node_format,node_config,node_schemas toneMint
class node_server,node_routes,node_query,node_models,node_s3 toneRose
class node_source toneIndigo
```

## Components

### User interfaces

- [CLI and package API](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/entrypoint.py): `src/gitingest/entrypoint.py`
- [Web interface](https://github.com/coderamp-labs/gitingest/tree/main/src/static/js): `src/static/js`

### Ingestion pipeline

- [Source and option parsing](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/query_parser.py): `src/gitingest/query_parser.py`
- [URL and ref utilities](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/utils/query_parser_utils.py): `src/gitingest/utils/query_parser_utils.py`
- [Repository cloning](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/clone.py): `src/gitingest/clone.py`
- [Git operations](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/utils/git_utils.py): `src/gitingest/utils/git_utils.py`

### Digest processing

- [Filesystem ingestion](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/ingestion.py): `src/gitingest/ingestion.py`
- [File filtering](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/utils/pattern_utils.py): `src/gitingest/utils/pattern_utils.py`
- [Ignore patterns](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/utils/ignore_patterns.py): `src/gitingest/utils/ignore_patterns.py`
- [Digest formatting](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/output_formatter.py): `src/gitingest/output_formatter.py`
- [Ingestion configuration](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/config.py): `src/gitingest/config.py`
- [Ingestion data schemas](https://github.com/coderamp-labs/gitingest/blob/main/src/gitingest/schemas/ingestion.py): `src/gitingest/schemas/ingestion.py`

### Web service

- [FastAPI application](https://github.com/coderamp-labs/gitingest/blob/main/src/server/main.py): `src/server/main.py`
- [Ingest routes](https://github.com/coderamp-labs/gitingest/blob/main/src/server/routers/ingest.py): `src/server/routers/ingest.py`
- [Server query orchestration](https://github.com/coderamp-labs/gitingest/blob/main/src/server/query_processor.py): `src/server/query_processor.py`
- [Request and response models](https://github.com/coderamp-labs/gitingest/blob/main/src/server/models.py): `src/server/models.py`
- [S3 digest storage](https://github.com/coderamp-labs/gitingest/blob/main/src/server/s3_utils.py): `src/server/s3_utils.py`

### Other components

- **Repository or directory**

## Connections

- Repository or directory → CLI and package API: provides input (evidence: `README.md`)
- CLI and package API → Source and option parsing: parses source (evidence: `src/gitingest/entrypoint.py`)
- Source and option parsing → URL and ref utilities: normalizes input (evidence: `src/gitingest/query_parser.py`)
- Source and option parsing → Git operations: resolves commit (evidence: `src/gitingest/query_parser.py`)
- CLI and package API → Repository cloning: clones repository (evidence: `src/gitingest/entrypoint.py`)
- Repository cloning → Git operations: uses Git (evidence: `src/gitingest/clone.py`)
- CLI and package API → Filesystem ingestion: ingests files (evidence: `src/gitingest/entrypoint.py`)
- Filesystem ingestion → Digest formatting: formats digest (evidence: `src/gitingest/ingestion.py`)
- Filesystem ingestion → Ingestion configuration: uses limits (evidence: `src/gitingest/ingestion.py`)
- Filesystem ingestion → File filtering: applies filters
- File filtering → Ignore patterns: uses patterns (evidence: `src/gitingest/utils/pattern_utils.py`)
- Filesystem ingestion → Ingestion data schemas: builds file data (evidence: `src/gitingest/ingestion.py`)
- Web interface → FastAPI application: submits request
- FastAPI application → Ingest routes: registers routes (evidence: `src/server/main.py`)
- Ingest routes → Request and response models: validates request (evidence: `src/server/routers/ingest.py`)
- Ingest routes → Server query orchestration: starts ingestion (evidence: `src/server/routers/ingest.py`)
- Server query orchestration → Source and option parsing: parses repository (evidence: `src/server/query_processor.py`)
- Server query orchestration → Repository cloning: clones repository (evidence: `src/server/query_processor.py`)
- Server query orchestration → Filesystem ingestion: ingests files (evidence: `src/server/query_processor.py`)
- Server query orchestration → S3 digest storage: checks and stores (evidence: `src/server/query_processor.py`)
- Server query orchestration → Request and response models: returns response (evidence: `src/server/query_processor.py`)
