# ysskrishna/gitingest-action architecture

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

- Interactive diagram: https://gitdiagram.com/ysskrishna/gitingest-action
- Repository: https://github.com/ysskrishna/gitingest-action

## Overview

Gitingest Action runs as a GitHub Actions step: it reads and validates workflow inputs, checks source paths and remote URLs, invokes the gitingest library to produce a summary, tree, and file-content digest, then writes those files and a workflow step summary. The README also documents remote/private repository access and filtering options, handled through the ingestion call. The source excerpt is partial, so internal gitingest stages are represented only at the documented boundary.

Main entry points: [`scripts/run.py`](https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py) (Repository ingestion)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_action["Action runtime"]
  node_inputs["Input parsing<br/>[run.py]"]
  node_validation["Source validation<br/>[run.py]"]
  node_ingestion["Repository ingestion<br/>[run.py]"]
  node_gitingest["gitingest library"]
end

subgraph group_results["Digest outputs"]
  node_digest["Digest files<br/>[run.py]"]
  node_step_summary["Job step summary<br/>[run.py]"]
end

node_workflow(("Workflow step"))
node_github_actions["GitHub Actions"]
node_repository[("Source repository")]

node_workflow -->|"provides inputs"| node_inputs
node_inputs -->|"supplies source"| node_validation
node_validation -->|"validated source"| node_ingestion
node_ingestion -->|"invokes ingest"| node_gitingest
node_repository -.->|"provides files"| node_gitingest
node_ingestion -->|"writes files"| node_digest
node_ingestion -->|"writes summary"| node_step_summary
node_github_actions -.->|"sets environment"| node_inputs
node_step_summary -->|"updates run summary"| node_github_actions

click node_inputs "https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py"
click node_validation "https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py"
click node_ingestion "https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py"
click node_digest "https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py"
click node_step_summary "https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.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_inputs,node_validation,node_ingestion,node_gitingest toneBlue
class node_digest,node_step_summary,node_repository toneAmber
class node_workflow,node_github_actions toneIndigo
```

## Components

### Action runtime

- [Input parsing](https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py): `scripts/run.py`
- [Source validation](https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py): `scripts/run.py`
- [Repository ingestion](https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py): `scripts/run.py`
- **gitingest library**

### Digest outputs

- [Digest files](https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py): `scripts/run.py`
- [Job step summary](https://github.com/ysskrishna/gitingest-action/blob/main/scripts/run.py): `scripts/run.py`

### Other components

- **Workflow step**
- **GitHub Actions**
- **Source repository**

## Connections

- Workflow step → Input parsing: provides inputs (evidence: `README.md`)
- Input parsing → Source validation: supplies source (evidence: `scripts/run.py`)
- Source validation → Repository ingestion: validated source (evidence: `scripts/run.py`)
- Repository ingestion → gitingest library: invokes ingest (evidence: `scripts/run.py`)
- Source repository → gitingest library: provides files (evidence: `README.md`)
- Repository ingestion → Digest files: writes files (evidence: `scripts/run.py`)
- Repository ingestion → Job step summary: writes summary (evidence: `scripts/run.py`)
- GitHub Actions → Input parsing: sets environment (evidence: `README.md`)
- Job step summary → GitHub Actions: updates run summary (evidence: `scripts/run.py`)
