# bankkroll/repo2pdf architecture

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

- Interactive diagram: https://gitdiagram.com/bankkroll/repo2pdf
- Repository: https://github.com/bankkroll/repo2pdf

## Overview

repo2pdf is a Node.js CLI that turns a GitHub or local repository into one PDF or a PDF per file. The user selects the source, output mode, and optional formatting features; the CLI acquires the repository, applies ignore rules, processes text files, and writes PDFs. The README also advertises the web app, but no web-app implementation appears in this tree. The sampled entry point shows the main workflow; feature stages share its implementation file rather than separate modules.

Main entry points: [`src/clone.ts`](https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts) (CLI workflow), [`src/configHandler.ts`](https://github.com/bankkroll/repo2pdf/blob/main/src/configHandler.ts) (Source and options), [`src/loadIgnoreConfig.ts`](https://github.com/bankkroll/repo2pdf/blob/main/src/loadIgnoreConfig.ts) (Ignore configuration), [`src/universalExcludes.ts`](https://github.com/bankkroll/repo2pdf/blob/main/src/universalExcludes.ts) (Default exclusions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interaction["CLI interaction"]
  node_entry["CLI workflow<br/>[clone.ts]"]
  node_questions["Source and options<br/>[configHandler.ts]"]
end

subgraph group_repository["Repository processing"]
  node_repo_source["GitHub or local repo"]
  node_git_clone["Repository clone<br/>[clone.ts]"]
  node_ignore_load["Ignore configuration"]
  node_file_scan["File traversal<br/>[clone.ts]"]
  node_exclude_rules["Default exclusions"]
end

subgraph group_documents["PDF generation"]
  node_text_prep["Text preparation<br/>[clone.ts]"]
  node_syntax_colors["Syntax conversion<br/>[syntax.ts]"]
  node_pdf_render["PDF rendering<br/>[clone.ts]"]
  node_pdf_output["PDF file&#40;s&#41;"]
end

node_user(("CLI user"))

node_user -->|"starts"| node_entry
node_entry -->|"prompts"| node_questions
node_questions -->|"configures"| node_entry
node_questions -->|"selects"| node_repo_source
node_entry -->|"clones when remote"| node_git_clone
node_repo_source -->|"provides URL"| node_git_clone
node_entry -->|"loads rules"| node_ignore_load
node_entry -->|"traverses"| node_file_scan
node_file_scan -->|"checks defaults"| node_exclude_rules
node_file_scan -->|"applies configured rules"| node_ignore_load
node_file_scan -->|"reads text files"| node_text_prep
node_text_prep -->|"converts highlighting"| node_syntax_colors
node_text_prep -->|"supplies formatted content"| node_pdf_render
node_pdf_render -->|"writes PDF&#40;s&#41;"| node_pdf_output

click node_entry "https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts"
click node_questions "https://github.com/bankkroll/repo2pdf/blob/main/src/configHandler.ts"
click node_git_clone "https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts"
click node_ignore_load "https://github.com/bankkroll/repo2pdf/blob/main/src/loadIgnoreConfig.ts"
click node_file_scan "https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts"
click node_exclude_rules "https://github.com/bankkroll/repo2pdf/blob/main/src/universalExcludes.ts"
click node_text_prep "https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts"
click node_syntax_colors "https://github.com/bankkroll/repo2pdf/blob/main/src/syntax.ts"
click node_pdf_render "https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts"

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_entry,node_questions,node_user toneBlue
class node_repo_source,node_git_clone,node_ignore_load,node_file_scan,node_exclude_rules toneAmber
class node_text_prep,node_syntax_colors,node_pdf_render,node_pdf_output toneMint
```

## Components

### CLI interaction

- [CLI workflow](https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts): `src/clone.ts`
- [Source and options](https://github.com/bankkroll/repo2pdf/blob/main/src/configHandler.ts): `src/configHandler.ts`

### Repository processing

- **GitHub or local repo**
- [Repository clone](https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts): `src/clone.ts`
- [Ignore configuration](https://github.com/bankkroll/repo2pdf/blob/main/src/loadIgnoreConfig.ts): `src/loadIgnoreConfig.ts`
- [File traversal](https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts): `src/clone.ts`
- [Default exclusions](https://github.com/bankkroll/repo2pdf/blob/main/src/universalExcludes.ts): `src/universalExcludes.ts`

### PDF generation

- [Text preparation](https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts): `src/clone.ts`
- [Syntax conversion](https://github.com/bankkroll/repo2pdf/blob/main/src/syntax.ts): `src/syntax.ts`
- [PDF rendering](https://github.com/bankkroll/repo2pdf/blob/main/src/clone.ts): `src/clone.ts`
- **PDF file(s)**

### Other components

- **CLI user**

## Connections

- CLI user → CLI workflow: starts (evidence: `README.md`)
- CLI workflow → Source and options: prompts (evidence: `src/clone.ts`)
- Source and options → CLI workflow: configures (evidence: `src/configHandler.ts`)
- Source and options → GitHub or local repo: selects (evidence: `src/configHandler.ts`)
- CLI workflow → Repository clone: clones when remote (evidence: `src/clone.ts`)
- GitHub or local repo → Repository clone: provides URL (evidence: `README.md`)
- CLI workflow → Ignore configuration: loads rules (evidence: `src/clone.ts`)
- CLI workflow → File traversal: traverses (evidence: `src/clone.ts`)
- File traversal → Default exclusions: checks defaults (evidence: `src/clone.ts`)
- File traversal → Ignore configuration: applies configured rules (evidence: `src/clone.ts`)
- File traversal → Text preparation: reads text files (evidence: `src/clone.ts`)
- Text preparation → Syntax conversion: converts highlighting (evidence: `src/clone.ts`)
- Text preparation → PDF rendering: supplies formatted content (evidence: `src/clone.ts`)
- PDF rendering → PDF file(s): writes PDF(s) (evidence: `src/clone.ts`)
