# kigster/laser-cutter architecture

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

- Interactive diagram: https://gitdiagram.com/kigster/laser-cutter
- Repository: https://github.com/kigster/laser-cutter

## Overview

LaserCutter is a Ruby library and CLI for designing custom notched box panels and returning or writing PDF/SVG output. The principal workflow is to supply and validate box options, generate panel geometry, arrange it for a page, and render the document; CLI commands expose generation, saved configuration, page sizes, examples, help, version, and shell completion. The graph preserves those documented capabilities and the sampled geometry/rendering layers. Some links are dashed because the relevant implementations were indexed but not excerpted.

Main entry points: [`lib/laser/cutter/cli/command.rb`](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/command.rb) (Command framework), [`lib/laser/cutter/renderer`](https://github.com/kigster/laser-cutter/tree/master/lib/laser/cutter/renderer) (Document rendering), [`lib/laser/cutter.rb`](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter.rb) (Ruby API), [`lib/laser/cutter/box.rb`](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/box.rb) (Box panels)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry points"]
  node_api["Ruby API<br/>[cutter.rb]"]
end

subgraph group_design["Box design"]
  node_options["Typed options<br/>[options.rb]"]
  node_configuration["Configuration<br/>[configuration.rb]"]
  node_box["Box panels<br/>[box.rb]"]
end

subgraph group_geometry["Geometry engine"]
  node_notching["Notch paths<br/>[path_generator.rb]"]
  node_edge["Edge parameters<br/>[edge.rb]"]
  node_geometry_primitives["Geometry primitives"]
  node_aggregator["Line aggregation<br/>[aggregator.rb]"]
end

subgraph group_output["Page and rendering"]
  node_page_manager["Page sizes and units<br/>[page_manager.rb]"]
  node_layout["Page layout<br/>[layout_renderer.rb]"]
  node_renderer["Document rendering"]
  node_pdf["PDF output"]
  node_svg["SVG output"]
end

subgraph group_cli["CLI features"]
  node_cli_root["CLI commands<br/>[cli.rb]"]
  node_launcher["CLI launcher<br/>[launcher.rb]"]
  node_command["Command framework<br/>[command.rb]"]
  node_generate["Generate command<br/>[generate.rb]"]
  node_config_file["Config files<br/>[config_file.rb]"]
  node_page_sizes["Page-size command<br/>[page_sizes.rb]"]
  node_examples["Usage examples<br/>[examples.rb]"]
  node_help["Help command<br/>[help.rb]"]
  node_completion["Shell completion<br/>[completion.rb]"]
  node_version["Version command<br/>[version.rb]"]
end

node_user(("Ruby user / CLI user"))
node_prawn["Prawn"]
node_victor["Victor"]

node_user -->|"calls"| node_api
node_api -->|"validates options"| node_options
node_api -->|"selects renderer"| node_renderer
node_user -.->|"runs CLI"| node_launcher
node_launcher -.->|"dispatches commands"| node_cli_root
node_cli_root -.->|"registers commands"| node_command
node_command -.->|"dispatches"| node_generate
node_command -.->|"dispatches"| node_page_sizes
node_command -.->|"dispatches"| node_examples
node_command -.->|"dispatches"| node_help
node_command -.->|"dispatches"| node_completion
node_command -.->|"dispatches"| node_version
node_generate -.->|"builds options"| node_options
node_generate -.->|"reads or saves"| node_config_file
node_options -.->|"configures design"| node_box
node_box -.->|"generates notches"| node_notching
node_notching -->|"reads edge data"| node_edge
node_notching -->|"creates lines and rectangles"| node_geometry_primitives
node_box -.->|"collects geometry"| node_aggregator
node_layout -.->|"uses page dimensions"| node_page_manager
node_renderer -.->|"lays out panels"| node_layout
node_renderer -.->|"renders PDF"| node_pdf
node_renderer -.->|"renders SVG"| node_svg
node_renderer -.->|"uses PDF engine"| node_prawn
node_renderer -.->|"uses SVG engine"| node_victor
node_page_sizes -.->|"lists sizes"| node_page_manager

click node_api "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter.rb"
click node_cli_root "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli.rb"
click node_launcher "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/launcher.rb"
click node_command "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/command.rb"
click node_generate "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/generate.rb"
click node_config_file "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/config_file.rb"
click node_page_sizes "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/page_sizes.rb"
click node_examples "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/examples.rb"
click node_help "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/help.rb"
click node_completion "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/completion.rb"
click node_version "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/version.rb"
click node_options "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/options.rb"
click node_configuration "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/configuration.rb"
click node_box "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/box.rb"
click node_notching "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/notching/path_generator.rb"
click node_edge "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/notching/edge.rb"
click node_geometry_primitives "https://github.com/kigster/laser-cutter/tree/master/lib/laser/cutter/geometry"
click node_aggregator "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/aggregator.rb"
click node_page_manager "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/page_manager.rb"
click node_layout "https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/renderer/layout_renderer.rb"
click node_renderer "https://github.com/kigster/laser-cutter/tree/master/lib/laser/cutter/renderer"

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_api,node_user toneBlue
class node_options,node_configuration,node_box toneAmber
class node_notching,node_edge,node_geometry_primitives,node_aggregator toneMint
class node_page_manager,node_layout,node_renderer,node_pdf,node_svg toneRose
class node_cli_root,node_launcher,node_command,node_generate,node_config_file,node_page_sizes,node_examples,node_help,node_completion,node_version,node_prawn,node_victor toneIndigo
```

## Components

### Entry points

- [Ruby API](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter.rb): `lib/laser/cutter.rb`

### Box design

- [Typed options](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/options.rb): `lib/laser/cutter/options.rb`
- [Configuration](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/configuration.rb): `lib/laser/cutter/configuration.rb`
- [Box panels](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/box.rb): `lib/laser/cutter/box.rb`

### Geometry engine

- [Notch paths](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/notching/path_generator.rb): `lib/laser/cutter/notching/path_generator.rb`
- [Edge parameters](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/notching/edge.rb): `lib/laser/cutter/notching/edge.rb`
- [Geometry primitives](https://github.com/kigster/laser-cutter/tree/master/lib/laser/cutter/geometry): `lib/laser/cutter/geometry`
- [Line aggregation](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/aggregator.rb): `lib/laser/cutter/aggregator.rb`

### Page and rendering

- [Page sizes and units](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/page_manager.rb): `lib/laser/cutter/page_manager.rb`
- [Page layout](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/renderer/layout_renderer.rb): `lib/laser/cutter/renderer/layout_renderer.rb`
- [Document rendering](https://github.com/kigster/laser-cutter/tree/master/lib/laser/cutter/renderer): `lib/laser/cutter/renderer`
- **PDF output**
- **SVG output**

### CLI features

- [CLI commands](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli.rb): `lib/laser/cutter/cli.rb`
- [CLI launcher](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/launcher.rb): `lib/laser/cutter/launcher.rb`
- [Command framework](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/command.rb): `lib/laser/cutter/cli/command.rb`
- [Generate command](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/generate.rb): `lib/laser/cutter/cli/generate.rb`
- [Config files](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/config_file.rb): `lib/laser/cutter/cli/config_file.rb`
- [Page-size command](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/page_sizes.rb): `lib/laser/cutter/cli/page_sizes.rb`
- [Usage examples](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/examples.rb): `lib/laser/cutter/cli/examples.rb`
- [Help command](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/help.rb): `lib/laser/cutter/cli/help.rb`
- [Shell completion](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/completion.rb): `lib/laser/cutter/cli/completion.rb`
- [Version command](https://github.com/kigster/laser-cutter/blob/master/lib/laser/cutter/cli/version.rb): `lib/laser/cutter/cli/version.rb`

### Other components

- **Ruby user / CLI user**
- **Prawn**
- **Victor**

## Connections

- Ruby user / CLI user → Ruby API: calls (evidence: `lib/laser/cutter.rb`)
- Ruby API → Typed options: validates options (evidence: `lib/laser/cutter.rb`)
- Ruby API → Document rendering: selects renderer (evidence: `lib/laser/cutter.rb`)
- Ruby user / CLI user → CLI launcher: runs CLI
- CLI launcher → CLI commands: dispatches commands
- CLI commands → Command framework: registers commands
- Command framework → Generate command: dispatches
- Command framework → Page-size command: dispatches
- Command framework → Usage examples: dispatches
- Command framework → Help command: dispatches
- Command framework → Shell completion: dispatches
- Command framework → Version command: dispatches
- Generate command → Typed options: builds options
- Generate command → Config files: reads or saves
- Typed options → Box panels: configures design
- Box panels → Notch paths: generates notches
- Notch paths → Edge parameters: reads edge data (evidence: `lib/laser/cutter/notching/path_generator.rb`)
- Notch paths → Geometry primitives: creates lines and rectangles (evidence: `lib/laser/cutter/notching/path_generator.rb`)
- Box panels → Line aggregation: collects geometry
- Page layout → Page sizes and units: uses page dimensions
- Document rendering → Page layout: lays out panels
- Document rendering → PDF output: renders PDF
- Document rendering → SVG output: renders SVG
- Document rendering → Prawn: uses PDF engine
- Document rendering → Victor: uses SVG engine
- Page-size command → Page sizes and units: lists sizes
