ergogen

Ergogen Reference

Ergogen — a tool that automatically generates ergonomic keyboard designs from YAML/JSON configuration. Declaratively describe Points / Outlines / Cases / PCBs and output in SVG / DXF / JSCAD / KiCad formats. Structured all 12 pages of the official documentation (docs.ergogen.xyz).

Directory structure

skills/ergogen/
  SKILL.md
  references/
    guide/
      README.md
      getting-started.md
      next-steps.md
      usage.md
    config/
      README.md
      overview.md
      preprocessing.md
    sections/
      README.md
      metadata.md
      units.md
      points.md
      outlines.md
      cases.md
      pcbs.md
    formats/
      README.md
      file-formats.md
  samples/
    README.md
    basic-layout.md
    board-outline.md
    case-3d.md
    custom-units.md
    pcb-footprints.md
    preprocessing-inheritance.md
    split-mirror.md
    thumb-cluster.md
  scripts/
    README.md
    install.md
    cli.md

Exploration procedure

From a task, look up the category, and identify the target page in the category's README.md:

1. Find the category corresponding to the task in the mapping table below
2. of that category references/{category}/README.md Refer to and identify the target page
3. The relevant page's .md Read and check the details

Task → Category Mapping

Task	Category	Reference README
I want to know Ergogen's overview and first configuration example	guide	references/guide/README.md
I want to know how to run it in the CLI and Web app	guide	references/guide/README.md
I want to know the paths to the community and example repositories	guide	references/guide/README.md
I want to know the responsibilities of the 6 top-level sections and the configuration file structure	config	references/config/README.md
$extends / $params / $args / $skip / $unset I want to know preprocessing such as	config	references/config/README.md
meta / units / points / outlines / cases / pcbs I want to know the section	sections	references/sections/README.md
I want to know details of key placement such as Anchors / Zones / Adjustments / mirror	sections	references/sections/README.md
I want to know footprints / nets / traces / KiCad output	sections	references/sections/README.md
I want to know the output file formats (SVG / DXF / JSCAD / KiCad)	formats	references/formats/README.md
I want to know configuration examples for typical layouts, cases, and PCBs	samples	samples/README.md
I want to know installation and CLI commands	scripts	scripts/README.md